microsoft / BotBuilder-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
csproj
txt
properties
cmd
cshtml
asax
vstemplate
editorconfig
props
nuspec
npmrc
eslintignore
gitattributes
targets
vsixmanifest
resx
vscodeignore
  • 35 extensions are included in analyses: json, cs, js, py, md, java, csproj, ts, html, xml, htm, gitignore, txt, properties, ps1, sh, cmd, css, cshtml, yml, sql, asax, vstemplate, editorconfig, props, nuspec, npmrc, eslintignore, gitattributes, targets, bat, MD, vsixmanifest, resx, vscodeignore
  • 9 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (170 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (4 files).
    • exclude files with path like ".*/bin/.*" (Binaries for distribution) (1 file).
    • exclude files with path like ".*[.]resx" (The resx resource files) (1 file).
    • exclude files with path like ".*/target/.*" (Compiled 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) (53 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.

main52322 LOC (13%) 647 files
test4137 LOC (1%) 63 files
generated199 LOC (<1%) 6 files
build and deployment3676 LOC (<1%) 91 files
other326806 LOC (84%) 3645 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
vstemplate
cmd
props
vsixmanifest
asax
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 647 files match defined criteria (52,322 lines of code, 100.0% vs. main code):
    • 149 *.js files (25,503 lines of code)
    • 319 *.cs files (13,772 lines of code)
    • 70 *.ts files (7,328 lines of code)
    • 8 *.yml files (2,133 lines of code)
    • 34 *.ps1 files (1,471 lines of code)
    • 14 *.java files (717 lines of code)
    • 25 *.py files (706 lines of code)
    • 5 *.vstemplate files (290 lines of code)
    • 7 *.cmd files (199 lines of code)
    • 6 *.htm files (68 lines of code)
    • 1 *.md files (57 lines of code)
    • 1 *.props files (33 lines of code)
    • 1 *.vsixmanifest files (30 lines of code)
    • 1 *.html files (9 lines of code)
    • 6 *.asax files (6 lines of code)
  • " *.js" is biggest, containing 48.74% of code.
  • " *.asax" is smallest, containing 0.01% of code.


*.js25503 LOC (48%) 149 files
*.cs13772 LOC (26%) 319 files
*.ts7328 LOC (14%) 70 files
*.yml2133 LOC (4%) 8 files
*.ps11471 LOC (2%) 34 files
*.java717 LOC (1%) 14 files
*.py706 LOC (1%) 25 files
*.vstemplate290 LOC (<1%) 5 files
*.cmd199 LOC (<1%) 7 files
*.htm68 LOC (<1%) 6 files
*.md57 LOC (<1%) 1 files
*.props33 LOC (<1%) 1 files
*.vsixmanifest30 LOC (<1%) 1 files
*.html9 LOC (<1%) 1 files
*.asax6 LOC (<1%) 6 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
csproj
vstemplate
cmd
Explore:   circles  |  sunburst
  • 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 ".*[.][Tt]est/.*".
    • files with paths like ".*[.][Tt]ests/.*".
    • files with paths like ".*[.][Tt]ests[.].*".
    • files with paths like ".*/TestData/.*".
    • files with paths like ".*[.]tests[.].*".
    • files with any line of content like ".*/simpletest/.*".
  • 63 files match defined criteria (4,137 lines of code, 7.9% vs. main code):
    • 32 *.cs files (1,849 lines of code)
    • 11 *.ts files (1,562 lines of code)
    • 9 *.js files (481 lines of code)
    • 5 *.csproj files (123 lines of code)
    • 1 *.vstemplate files (62 lines of code)
    • 3 *.java files (36 lines of code)
    • 2 *.cmd files (24 lines of code)
  • " *.cs" is biggest, containing 44.69% of code.
  • " *.cmd" is smallest, containing 0.58% of code.


*.cs1849 LOC (44%) 32 files
*.ts1562 LOC (37%) 11 files
*.js481 LOC (11%) 9 files
*.csproj123 LOC (2%) 5 files
*.vstemplate62 LOC (1%) 1 files
*.java36 LOC (<1%) 3 files
*.cmd24 LOC (<1%) 2 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 ".*/generated/.*".
    • files with paths like ".*[.]cs" AND any line of content like "[/][/][ ]*".
  • 6 files match defined criteria (199 lines of code, 0.4% vs. main code):
    • 3 *.cs files (175 lines of code)
    • 3 *.json files (24 lines of code)
  • " *.cs" is biggest, containing 87.94% of code.
  • " *.json" is smallest, containing 12.06% of code.


*.cs175 LOC (87%) 3 files
*.json24 LOC (12%) 3 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
csproj
nuspec
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitattributes".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]csproj".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]bat".
    • files with paths like ".*([.]|/)webpack([.]|/).*".
    • files with paths like ".*[.]nuspec".
    • files with paths like ".*/pom[.]xml".
  • 91 files match defined criteria (3,676 lines of code, 7.0% vs. main code):
    • 53 *.csproj files (2,762 lines of code)
    • 29 *.sh files (755 lines of code)
    • 5 *.js files (92 lines of code)
    • 3 *.nuspec files (61 lines of code)
    • 1 *.bat files (6 lines of code)
  • " *.csproj" is biggest, containing 75.14% of code.
  • " *.bat" is smallest, containing 0.16% of code.


*.csproj2762 LOC (75%) 53 files
*.sh755 LOC (20%) 29 files
*.js92 LOC (2%) 5 files
*.nuspec61 LOC (1%) 3 files
*.bat6 LOC (<1%) 1 files
Other Code
csproj
cmd
cshtml
properties
targets
props
asax
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]editorconfig".
    • files with paths like ".*[.]md".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]vscodeignore".
    • files with paths like ".*/[.]eslintignore".
    • files with paths like ".*[.]npmrc".
    • files with paths like ".*/[Ss]amples/.*".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 3645 files match defined criteria (326,806 lines of code, 624.6% vs. main code):
    • 1,566 *.json files (220,014 lines of code)
    • 567 *.cs files (27,377 lines of code)
    • 360 *.md files (20,934 lines of code)
    • 272 *.java files (11,656 lines of code)
    • 358 *.py files (11,646 lines of code)
    • 84 *.xml files (11,013 lines of code)
    • 194 *.js files (10,254 lines of code)
    • 16 *.css files (5,607 lines of code)
    • 45 *.ts files (2,552 lines of code)
    • 72 *.csproj files (2,030 lines of code)
    • 6 *.ps1 files (1,269 lines of code)
    • 14 *.cmd files (768 lines of code)
    • 16 *.html files (599 lines of code)
    • 6 *.sh files (382 lines of code)
    • 13 *.cshtml files (282 lines of code)
    • 42 *.properties files (182 lines of code)
    • 8 *.sql files (145 lines of code)
    • 1 *.yml files (55 lines of code)
    • 2 *.targets files (30 lines of code)
    • 2 *.props files (10 lines of code)
    • 1 *.asax files (1 lines of code)
  • " *.json" is biggest, containing 67.32% of code.
  • " *.asax" is smallest, containing 0% of code.


*.json220014 LOC (67%) 1566 files
*.cs27377 LOC (8%) 567 files
*.md20934 LOC (6%) 360 files
*.java11656 LOC (3%) 272 files
*.py11646 LOC (3%) 358 files
*.xml11013 LOC (3%) 84 files
*.js10254 LOC (3%) 194 files
*.css5607 LOC (1%) 16 files
*.ts2552 LOC (<1%) 45 files
*.csproj2030 LOC (<1%) 72 files
*.ps11269 LOC (<1%) 6 files
*.cmd768 LOC (<1%) 14 files
*.html599 LOC (<1%) 16 files
*.sh382 LOC (<1%) 6 files
*.cshtml282 LOC (<1%) 13 files
*.properties182 LOC (<1%) 42 files
*.sql145 LOC (<1%) 8 files
*.yml55 LOC (<1%) 1 files
*.targets30 LOC (<1%) 2 files
*.props10 LOC (<1%) 2 files
*.asax1 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
  • *.cs files are analyzed with CSharpAnalyzer:
    • 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 (based on namespace heuristics)
  • *.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
  • *.yml 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
  • *.ps1 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
  • *.java files are analyzed with JavaAnalyzer:
    • 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 (based on package names)
  • *.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
  • *.vstemplate 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
  • *.cmd 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
  • *.htm 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
  • *.md 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
  • *.props 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
  • *.vsixmanifest 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
  • *.asax 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

2022-01-30 13:59