guardian/pluto-core
Code Volume Analysis scope, overview of main, test, generated, deployment, build, and other code. |
Source Code Analysis Scope
Files includes and excluded from analyses
scoping details...
- 24 extensions are included in analyses: scala, jsx, tsx, sql, ts, scss, less, json, sh, css, py, md, txt, js, properties, yml, sbt, xml, html, svg, gitignore, go, mod, npmrc
- 9 criteria are used to exclude files from analysis:
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (1 file).
- exclude files with path like ".*/normalize[.](css|less|scss|styl)" (Normalize css) (1 file).
- exclude files with path like ".*/testdata/.*" (Test data) (7 files).
- exclude files with path like ".*font-?awesome\.(css|less|scss|styl)" (Font Awesome) (3 files).
- exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
- exclude files with path like ".*/_sokrates/.*" (Sokrates files) (0 files).
- exclude files with path like ".*/_sokrates_landscape/.*" (Sokrates landscape files) (0 files).
- 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_.*?[.]json" (Sokrates conventions and configurations) (0 files).
- The source code folder contains 656 files:
- 606 files are included in analyses.
- 50 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.
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
scope details...
- The following criteria are used to filter files:
- files with paths like ".*".
- 445 files match defined criteria (38,431 LOC, 100.0% vs. main code):
- 204 scala files (14,042 LOC)
- 70 tsx files (11,313 LOC)
- 74 jsx files (5,331 LOC)
- 22 ts files (1,974 LOC)
- 13 scss files (1,745 LOC)
- 13 less files (1,745 LOC)
- 4 css files (700 LOC)
- 34 sql files (675 LOC)
- 4 py files (575 LOC)
- 2 go files (163 LOC)
- 2 xml files (112 LOC)
- 2 html files (38 LOC)
- 1 js files (18 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
scope details...
- The following criteria are used to filter files:
- files with paths like ".*/__mock[^/]*/.*".
- files with paths like ".*/test_.*".
- files with paths like ".*__tests__.*".
- files with paths like ".*/[Tt]est/.*".
- 124 files match defined criteria (7,947 LOC, 20.7% vs. main code):
- 57 scala files (4,303 LOC)
- 19 jsx files (2,089 LOC)
- 35 sql files (756 LOC)
- 5 ts files (511 LOC)
- 5 tsx files (199 LOC)
- 1 py files (51 LOC)
- 1 yaml files (27 LOC)
- 1 js files (11 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
scope details...
- The following criteria are used to filter files:
- files with paths like ".*/requirements[a-zA-Z0-9._-]*[.]txt".
- files with paths like ".*[.]npmrc".
- files with paths like "(.*/)?[.]npmrc".
- files with paths like ".*([.]|/)webpack([.]|/).*".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/package[.]json".
- files with paths like ".*[.]sh".
- files with paths like ".*[.]sbt".
- files with paths like ".*/docker[-]compose[.]yml".
- files with paths like ".*/go[.]mod".
- files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
- 19 files match defined criteria (534 LOC, 1.4% vs. main code):
- 10 sh files (168 LOC)
- 2 yaml files (149 LOC)
- 2 sbt files (114 LOC)
- 1 js files (70 LOC)
- 2 gitignore files (30 LOC)
- 1 mod files (2 LOC)
- 1 npmrc files (1 LOC)
Other Code
scope details...
- The following criteria are used to filter files:
- files with paths like ".*[.]txt".
- files with paths like ".*[.]properties".
- files with paths like ".*[.]json".
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]svg".
- 18 files match defined criteria (3,324 LOC, 8.6% vs. main code):
- 2 svg files (2,672 LOC)
- 5 md files (322 LOC)
- 5 json files (317 LOC)
- 4 properties files (7 LOC)
- 2 txt files (6 LOC)
About This Analysis
learn more about scopes (main, test, generated, build, 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.
learn more about used code analyzers...
- *.scala files are analyzed with ScalaAnalyzer:
- 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
- *.tsx 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
- *.jsx files are analyzed with HtmlAnalyzer:
- 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
- Advanced 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
- *.scss files are analyzed with ScssAnalyzer:
- 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)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.less files are analyzed with LessAnalyzer:
- 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)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.css files are analyzed with CssAnalyzer:
- 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)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.sql files are analyzed with SqlAnalyzer:
- 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)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.py files are analyzed with PythonAnalyzer:
- 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
- *.go files are analyzed with GoLangAnalyzer:
- 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
- *.xml files are analyzed with XmlAnalyzer:
- 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)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.html files are analyzed with HtmlAnalyzer:
- 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
- Advanced heuristic 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