dart-lang / dartdoc
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
gitattributes
txt
  • 13 extensions are included in analyses: dart, html, md, yaml, gitignore, css, js, sh, svg, gitattributes, txt, bat, json
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/bin/.*" (Binaries for distribution) (7 files).
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (5 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) (0 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.

main50066 LOC (73%) 168 files
test15085 LOC (22%) 158 files
generated109 LOC (<1%) 2 files
build and deployment29 LOC (<1%) 3 files
other3062 LOC (4%) 60 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 ".*".
  • 168 files match defined criteria (50,066 lines of code, 100.0% vs. main code):
    • 117 *.dart files (47,260 lines of code)
    • 40 *.html files (1,329 lines of code)
    • 2 *.css files (893 lines of code)
    • 1 *.js files (393 lines of code)
    • 8 *.yaml files (191 lines of code)
  • " *.dart" is biggest, containing 94.4% of code.
  • " *.yaml" is smallest, containing 0.38% of code.


*.dart47260 LOC (94%) 117 files
*.html1329 LOC (2%) 40 files
*.css893 LOC (1%) 2 files
*.js393 LOC (<1%) 1 files
*.yaml191 LOC (<1%) 8 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 ".*_test[.].*".
    • files with any line of content like ".*/simpletest/.*".
  • 158 files match defined criteria (15,085 lines of code, 30.1% vs. main code):
    • 99 *.dart files (13,421 lines of code)
    • 45 *.html files (1,560 lines of code)
    • 14 *.yaml files (104 lines of code)
  • " *.dart" is biggest, containing 88.97% of code.
  • " *.yaml" is smallest, containing 0.69% of code.


*.dart13421 LOC (88%) 99 files
*.html1560 LOC (10%) 45 files
*.yaml104 LOC (<1%) 14 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 ".*[.](html|html|xhtml)" AND any line of content like "[ ]*[<]meta name[=]"generator" .*".
  • 2 files match defined criteria (109 lines of code, 0.2% vs. main code). All matches are in *.html files.


*.html109 LOC (100%) 2 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 ".*[.]sh".
    • files with paths like ".*[.]bat".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]gitattributes".
  • 3 files match defined criteria (29 lines of code, 0.1% vs. main code):
    • 2 *.sh files (28 lines of code)
    • 1 *.bat files (1 lines of code)
  • " *.sh" is biggest, containing 96.55% of code.
  • " *.bat" is smallest, containing 3.45% of code.


*.sh28 LOC (96%) 2 files
*.bat1 LOC (3%) 1 files
Other Code
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 ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]svg".
    • files with paths like ".*[.]txt".
  • 60 files match defined criteria (3,062 lines of code, 6.1% vs. main code):
    • 59 *.md files (3,061 lines of code)
    • 1 *.svg files (1 lines of code)
  • " *.md" is biggest, containing 99.97% of code.
  • " *.svg" is smallest, containing 0.03% of code.


*.md3061 LOC (99%) 59 files
*.svg1 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.dart files are analyzed with CppAnalyzer:
    • 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
  • *.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
  • *.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
  • *.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


2022-02-03 02:07