CodingStyle-SourceFileNaming

Name a source_file for a type defined in it

Required inputs: IR

The name of a source file should be related to a type name provided by this file.

Possible Messages

Key	Text	Severity	Disabled
source_file_name_not_type	The file should be named as a type it declares.	None	False

Options

• This rule shares the following common options: exclude_in_macros, exclude_messages_in_system_headers, excludes, extend_exclude_to_macro_invocations, includes, justification_checker, languages, post_processing, provider, report_at, severity

• The following places define options that affect this rule: Stylechecks, Analysis-GlobalOptions

file_type

file_type : bauhaus.rules.axivion.lexical.comments.FileToCheckSet = {'Primary_File', 'System_Include_File', 'User_Include_File'}

Type of source_file file to examine.

 

junk_characters

junk_characters : str = ' _-.:'

Characters that should not be considered in the filename to type similarity.

 

named_node_types

named_node_types : set[bauhaus.ir.PIR_Class_Name] = {'Named_Type_Interface'}

Physical IR node types to inspect for logical names to compare against the file name

 

similarity_threshold

similarity_threshold : float = 0.9

Ratio of how similar the names need to be.