Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 15 extensions are included in analyses: php, phpt, md, inc, json, txt, gitignore, ts, ini, js, gitattributes, vscodeignore, xml, yml, gitmodules
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (19 files).
- exclude files with path like ".*/docs/.*" (Documentation) (6 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (2 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).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- exclude files with path like ".*[.]txt" (Text files) (13 files).
- The source code folder contains 3,307 files:
- 1,560 files are included in analyses.
- 1,747 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.
- The following criteria are used to filter files:
- files with paths like ".*".
- 177 files match defined criteria (8,176 lines of code, 100.0% vs. main code):
- 174 *.php files (8,056 lines of code)
- 2 *.ts files (98 lines of code)
- 1 *.js files (22 lines of code)
- " *.php" is biggest, containing 98.53% of code.
- " *.js" is smallest, containing 0.27% of code.
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 ".*/[Tt]ests/.*".
- files with paths like ".*/[Tt]est/.*".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with paths like ".*_tests[.].*".
- files with any line of content like ".*/simpletest/.*".
- 1340 files match defined criteria (31,920 lines of code, 390.4% vs. main code):
- 203 *.phpt files (23,855 lines of code)
- 1,107 *.php files (7,627 lines of code)
- 28 *.inc files (423 lines of code)
- 2 *.ts files (15 lines of code)
- " *.phpt" is biggest, containing 74.73% of code.
- " *.ts" is smallest, containing 0.05% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]md".
- files with paths like ".*[.]txt".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]ini".
- files with paths like ".*/[.]vscodeignore".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 43 files match defined criteria (10,993 lines of code, 134.5% vs. main code):
- 34 *.md files (10,759 lines of code)
- 7 *.json files (192 lines of code)
- 1 *.xml files (37 lines of code)
- 1 *.ini files (5 lines of code)
- " *.md" is biggest, containing 97.87% of code.
- " *.ini" is smallest, containing 0.05% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.php files are analyzed with PhpAnalyzer:
- 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
- Basic heuristic dependency analysis
- *.ts files are analyzed with TypeScriptAnalyzer:
- 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
- *.js files are analyzed with JavaScriptAnalyzer:
- 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-01-30 14:32