mapillary / mapillary-js
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
mdx
txt
editorconfig
eslintignore
prettierignore
  • 16 extensions are included in analyses: ts, js, html, md, css, svg, json, gitignore, mdx, cjs, txt, sh, editorconfig, yml, eslintignore, prettierignore
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*\.d\.ts" (Typescript definition files) (1 file).
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (12 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (23 files).
    • exclude files with path like ".*/docs?/_?(build|themes?|templates?|static)/.*" (Sphinx) (2 files).
    • exclude files with path like ".*/cache/.*" (Caches) (1 file).
    • exclude files with path like ".*/extern(al)?/.*" (Dependencies) (3 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.

main31536 LOC (48%) 365 files
test26571 LOC (40%) 122 files
generated0 LOC (0%) 0 files
build and deployment6 LOC (<1%) 1 files
other7442 LOC (11%) 110 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 ".*".
  • 365 files match defined criteria (31,536 lines of code, 100.0% vs. main code):
    • 325 *.ts files (29,755 lines of code)
    • 25 *.js files (913 lines of code)
    • 14 *.css files (858 lines of code)
    • 1 *.cjs files (10 lines of code)
  • " *.ts" is biggest, containing 94.35% of code.
  • " *.cjs" is smallest, containing 0.03% of code.


*.ts29755 LOC (94%) 325 files
*.js913 LOC (2%) 25 files
*.css858 LOC (2%) 14 files
*.cjs10 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[.].*".
  • 122 files match defined criteria (26,571 lines of code, 84.3% vs. main code). All matches are in *.ts files.


*.ts26571 LOC (100%) 122 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 ".*[.]sh".
  • 1 file matches defined criteria (6 lines of code, 0.0% vs. main code). All matches are in *.sh files.


*.sh6 LOC (100%) 1 files
Other Code
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]editorconfig".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]svg".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]mdx".
    • files with paths like ".*/[.]prettierignore".
    • files with paths like ".*/[.]eslintignore".
  • 110 files match defined criteria (7,442 lines of code, 23.6% vs. main code):
    • 56 *.js files (4,500 lines of code)
    • 35 *.html files (2,210 lines of code)
    • 7 *.json files (400 lines of code)
    • 4 *.md files (296 lines of code)
    • 8 *.svg files (36 lines of code)
  • " *.js" is biggest, containing 60.47% of code.
  • " *.svg" is smallest, containing 0.48% of code.


*.js4500 LOC (60%) 56 files
*.html2210 LOC (29%) 35 files
*.json400 LOC (5%) 7 files
*.md296 LOC (3%) 4 files
*.svg36 LOC (<1%) 8 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
  • *.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
  • *.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
  • *.cjs 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


2022-04-16 07:03