Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 10 extensions are included in analyses: hack, in, json, md, php, txt, hh, gitignore, gitattributes, yml
- 3 criteria are used to exclude files from analysis:
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (4 files).
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (7 files).
- exclude files with path like ".*/docs/.*" (Documentation) (4 files).
- The source code folder contains 1,337 files:
- 1,044 files are included in analyses.
- 293 files are excluded from analyses:
Overview of Analyzed Files
Basic stats on analyzed files
Intro
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.
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
- The following criteria are used to filter files:
- files with paths like ".*/test[-]data/.*".
- files with paths like ".*/[Tt]ests/.*".
- 84 files match defined criteria (3,064 lines of code, 5.4% vs. main code):
- 83 *.hack files (3,061 lines of code)
- 1 *.php files (3 lines of code)
- " *.hack" is biggest, containing 99.9% of code.
- " *.php" is smallest, containing 0.1% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*[.]json".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]txt".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*/[.]gitignore".
- 194 files match defined criteria (5,399 lines of code, 9.5% vs. main code):
- 178 *.in files (2,649 lines of code)
- 9 *.json files (2,588 lines of code)
- 3 *.md files (101 lines of code)
- 3 *.php files (55 lines of code)
- 1 *.hh files (6 lines of code)
- " *.in" is biggest, containing 49.06% of code.
- " *.hh" is smallest, containing 0.11% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.hack files are analyzed with HackAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
- Unit size analysis
- Conditional complexity analysis
- No dependency analysis
2022-04-16 07:01