microsoft / vscode-extension-samples
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
vscodeignore
eslintignore
txt
  • 15 extensions are included in analyses: json, ts, md, js, svg, gitignore, vscodeignore, css, eslintignore, txt, sh, tsx, yml, rs, html
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (354 files).
    • exclude files with path like ".*\.d\.ts" (Typescript definition files) (8 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) (7 files).
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.

main10296 LOC (2%) 126 files
test331 LOC (<1%) 15 files
generated174811 LOC (47%) 67 files
build and deployment383 LOC (<1%) 11 files
other181480 LOC (49%) 324 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 126 files match defined criteria (10,296 lines of code, 100.0% vs. main code):
    • 103 *.ts files (9,180 lines of code)
    • 12 *.css files (525 lines of code)
    • 7 *.js files (467 lines of code)
    • 2 *.tsx files (61 lines of code)
    • 1 *.html files (57 lines of code)
    • 1 *.rs files (6 lines of code)
  • " *.ts" is biggest, containing 89.16% of code.
  • " *.rs" is smallest, containing 0.06% of code.


*.ts9180 LOC (89%) 103 files
*.css525 LOC (5%) 12 files
*.js467 LOC (4%) 7 files
*.tsx61 LOC (<1%) 2 files
*.html57 LOC (<1%) 1 files
*.rs6 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 ".*[-]test[-].*".
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*/test[-]data/.*".
    • files with any line of content like ".*/simpletest/.*".
  • 15 files match defined criteria (331 lines of code, 3.2% vs. main code). All matches are in *.ts files.


*.ts331 LOC (100%) 15 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".
  • 67 files match defined criteria (174,811 lines of code, 1697.9% vs. main code). All matches are in *.json files.


*.json174811 LOC (100%) 67 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 ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*/package[-]lock[.]json".
    • files with paths like ".*([.]|/)webpack([.]|/).*".
    • files with paths like ".*[.]sh".
  • 11 files match defined criteria (383 lines of code, 3.7% vs. main code):
    • 9 *.js files (377 lines of code)
    • 2 *.sh files (6 lines of code)
  • " *.js" is biggest, containing 98.43% of code.
  • " *.sh" is smallest, containing 1.57% of code.


*.js377 LOC (98%) 9 files
*.sh6 LOC (1%) 2 files
Other Code
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]vscodeignore".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]svg".
    • files with paths like ".*/[.]eslintignore".
  • 324 files match defined criteria (181,480 lines of code, 1762.6% vs. main code):
    • 219 *.json files (179,953 lines of code)
    • 70 *.md files (1,431 lines of code)
    • 35 *.svg files (96 lines of code)
  • " *.json" is biggest, containing 99.16% of code.
  • " *.svg" is smallest, containing 0.05% of code.


*.json179953 LOC (99%) 219 files
*.md1431 LOC (<1%) 70 files
*.svg96 LOC (<1%) 35 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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
  • *.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
  • *.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
  • *.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
  • *.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
  • *.rs files are analyzed with RustAnalyzer:
    • 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 11:14