Skip to content

dev.md

Latest commit

 

History

History
20 lines (14 loc) · 787 Bytes

dev.md

File metadata and controls

20 lines (14 loc) · 787 Bytes

Development instructions

Requirements

  • Go 1.14+

Development CLI options

  • -debug_lexer: enables debug output for the lexer
  • -debug_parser: enables debug output for the parser

Execution path

  • main reads the config file and parses CLI options
  • With the correct options runner is called, which executes the following steps
  • The config file is passed through lexer, then through parser (with importrules as output)
  • filefinder finds all files related to the language detected by parser
  • If language is Go, langs/golistimports takes the file list and outputs the a map of imports per module
  • rulechecker takes the imports map and ruleset from parser and checks whether all imports are valid
  • logging takes the program results and prints them