Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
txt
proto
in
ini
cfg
properties
21 extensions are included in analyses: html, scala, py, js, md, txt, css, yaml, rst, sbt, java, proto, json, ipynb, in, ini, cfg, gitignore, sh, xml, properties
7 criteria are used to exclude files from analysis:
exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (3 files).
exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (1 file).
exclude files with path like ".*/docs/.*" (Documentation) (84 files).
exclude files with path like "(?i).*/jquery.*[.]js" (jQuery files) (0 files).
exclude files with path like ".*jquery[.].*[.]js" (jQuery library) (0 files).
exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (0 files).
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.
The main category contains all manually created source code files that are being used in the production.
Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
Test source code files are used only for testing of the product. These files are normally not deployed to production.
Build and deployment source code files are used to configure or support build and deployment process.
Generated source code files are automatically generated files that have not been manually changed after generation.
While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
files with any line of content like "//[ ]*Generated by .*".
files with paths like ".*[.](py|java|h|cc|cpp|m|rb|php)" AND any line of content like ".*Generated by the protocol buffer compiler[.][ ]+DO NOT EDIT[!].*".
1 file matches defined criteria (5,040 LOC, 68.6% vs. main code). All matches are in *.java files.
