apple / swift-docc-render
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
plist
editorconfig
  • 12 extensions are included in analyses: js, vue, scss, md, json, svg, txt, html, gitignore, py, plist, editorconfig
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (4 files).
    • exclude files with path like ".*/bin/.*" (Binaries for distribution) (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) (2 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.

main20040 LOC (26%) 299 files
test20276 LOC (27%) 209 files
generated16072 LOC (21%) 1 files
build and deployment0 LOC (0%) 0 files
other18546 LOC (24%) 13 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 ".*".
  • 299 files match defined criteria (20,040 lines of code, 100.0% vs. main code):
    • 199 *.vue files (16,078 lines of code)
    • 69 *.js files (2,251 lines of code)
    • 28 *.scss files (1,540 lines of code)
    • 1 *.py files (101 lines of code)
    • 2 *.html files (70 lines of code)
  • " *.vue" is biggest, containing 80.23% of code.
  • " *.html" is smallest, containing 0.35% of code.


*.vue16078 LOC (80%) 199 files
*.js2251 LOC (11%) 69 files
*.scss1540 LOC (7%) 28 files
*.py101 LOC (<1%) 1 files
*.html70 LOC (<1%) 2 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 ".*/__mocks?__/.*".
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*[.]spec[.]js".
    • files with any line of content like ".*/simpletest/.*".
  • 209 files match defined criteria (20,276 lines of code, 101.2% vs. main code). All matches are in *.js files.


*.js20276 LOC (100%) 209 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".
  • 1 file matches defined criteria (16,072 lines of code, 80.2% vs. main code). All matches are in *.json files.


*.json16072 LOC (100%) 1 files
Other Code
plist
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 ".*[.]txt".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]plist".
    • files with paths like ".*[.]svg".
  • 13 files match defined criteria (18,546 lines of code, 92.5% vs. main code):
    • 4 *.json files (18,190 lines of code)
    • 5 *.md files (318 lines of code)
    • 3 *.svg files (24 lines of code)
    • 1 *.plist files (14 lines of code)
  • " *.json" is biggest, containing 98.08% of code.
  • " *.plist" is smallest, containing 0.08% of code.


*.json18190 LOC (98%) 4 files
*.md318 LOC (1%) 5 files
*.svg24 LOC (<1%) 3 files
*.plist14 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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
  • *.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
  • *.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
  • *.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
  • *.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


2022-01-30 22:05