aws-solutions / aws-qnabot
Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope
Files includes and excluded from analyses
txt
pug
styl
babelrc
ejs
jsonc
hbs
  • 20 extensions are included in analyses: js, json, md, txt, vue, py, sh, gitignore, css, pug, scss, svg, html, styl, babelrc, ejs, jsonc, MD, hbs, yaml
  • 8 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (9 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (22 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 ".*/bin/.*" (Binaries for distribution) (14 files).
    • exclude files with path like ".*[.]txt" (Text files) (28 files).
    • exclude files with path like ".*/(vuejs|js/lib)/.*" (40 files).
    • exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
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.

main24569 LOC (14%) 272 files
test3145 LOC (1%) 37 files
generated66249 LOC (37%) 19 files
build and deployment78 LOC (<1%) 2 files
other80621 LOC (46%) 145 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
pug
ejs
styl
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 272 files match defined criteria (24,569 lines of code, 100.0% vs. main code):
    • 226 *.js files (18,455 lines of code)
    • 28 *.vue files (3,945 lines of code)
    • 7 *.py files (1,222 lines of code)
    • 1 *.yaml files (296 lines of code)
    • 2 *.css files (250 lines of code)
    • 2 *.scss files (183 lines of code)
    • 2 *.html files (176 lines of code)
    • 2 *.pug files (21 lines of code)
    • 1 *.ejs files (11 lines of code)
    • 1 *.styl files (10 lines of code)
  • " *.js" is biggest, containing 75.11% of code.
  • " *.styl" is smallest, containing 0.04% of code.


*.js18455 LOC (75%) 226 files
*.vue3945 LOC (16%) 28 files
*.py1222 LOC (4%) 7 files
*.yaml296 LOC (1%) 1 files
*.css250 LOC (1%) 2 files
*.scss183 LOC (<1%) 2 files
*.html176 LOC (<1%) 2 files
*.pug21 LOC (<1%) 2 files
*.ejs11 LOC (<1%) 1 files
*.styl10 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with any line of content like ".*/simpletest/.*".
  • 37 files match defined criteria (3,145 lines of code, 12.8% vs. main code):
    • 36 *.js files (3,144 lines of code)
    • 1 *.sh files (1 lines of code)
  • " *.js" is biggest, containing 99.97% of code.
  • " *.sh" is smallest, containing 0.03% of code.


*.js3144 LOC (99%) 36 files
*.sh1 LOC (<1%) 1 files
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[-]lock[.]json".
  • 19 files match defined criteria (66,249 lines of code, 269.6% vs. main code). All matches are in *.json files.


*.json66249 LOC (100%) 19 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[.]json".
    • files with paths like ".*/package[-]lock[.]json".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
    • files with paths like ".*([.]|/)webpack([.]|/).*".
  • 2 files match defined criteria (78 lines of code, 0.3% vs. main code):
    • 1 *.sh files (65 lines of code)
    • 1 *.js files (13 lines of code)
  • " *.sh" is biggest, containing 83.33% of code.
  • " *.js" is smallest, containing 16.67% of code.


*.sh65 LOC (83%) 1 files
*.js13 LOC (16%) 1 files
Other Code
hbs
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]svg".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
  • 145 files match defined criteria (80,621 lines of code, 328.1% vs. main code):
    • 70 *.json files (70,739 lines of code)
    • 15 *.js files (5,387 lines of code)
    • 2 *.svg files (2,860 lines of code)
    • 50 *.md files (1,151 lines of code)
    • 7 *.py files (460 lines of code)
    • 1 *.hbs files (24 lines of code)
  • " *.json" is biggest, containing 87.74% of code.
  • " *.hbs" is smallest, containing 0.03% of code.


*.json70739 LOC (87%) 70 files
*.js5387 LOC (6%) 15 files
*.svg2860 LOC (3%) 2 files
*.md1151 LOC (1%) 50 files
*.py460 LOC (<1%) 7 files
*.hbs24 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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
  • *.vue 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
  • *.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
  • *.yaml files are analyzed with YamlAnalyzer:
    • 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
  • *.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
  • *.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
  • *.pug files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.ejs files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.styl files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis


2022-02-01 01:15