guardian / mobile-apps-article-templates

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope

Files includes and excluded from analyses

npmignore

txt

editorconfig

12 extensions are included in analyses: scss, html, js, svg, md, json, yaml, npmignore, gitignore, txt, sh, editorconfig
3 criteria are used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (5 files).
exclude files with path like ".*/(3rd|[Tt]hird)[-_]?[Pp]arty/.*" (Dependencies) (2 files).
exclude files with path like ".*/extern(al)?/.*" (Dependencies) (2 files).

The source code folder contains 357 files:

307 files are included in analyses.
50 files are excluded from analyses:

Explore all 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.

272 files

14 files

2 files

19 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 ".*".

272 files match defined criteria (18,564 LOC, 100.0% vs. main code):

128 *.scss files (11,793 LOC)
45 *.js files (4,366 LOC)
99 *.html files (2,405 LOC)

" *.scss" is biggest, containing 63.53% of LOC.
" *.html" is smallest, containing 12.96% of LOC.

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[.].*".

14 files match defined criteria (2,305 LOC, 12.4% vs. main code). All matches are in *.js 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 ".*[.]git[a-z]+".
files with paths like ".*/[.]gitignore".
files with paths like ".*([.]|/)webpack([.]|/).*".
files with paths like ".*/package[.]json".

2 files match defined criteria (118 LOC, 0.6% vs. main code):

1 *.js files (112 LOC)
1 *.sh files (6 LOC)

" *.js" is biggest, containing 94.92% of LOC.
" *.sh" is smallest, containing 5.08% of LOC.

Other Code

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*[.]editorconfig".
files with paths like ".*/[.]npmignore".
files with paths like ".*[.]md".
files with paths like ".*/[.]gitignore".
files with paths like ".*[.]svg".
files with paths like ".*/README[.][a-z0-9]+".
files with paths like ".*[.]json".

19 files match defined criteria (365 LOC, 2.0% vs. main code):

14 *.svg files (146 LOC)
3 *.md files (117 LOC)
2 *.json files (102 LOC)

" *.svg" is biggest, containing 40% of LOC.
" *.json" is smallest, containing 27.95% of LOC.

Analyzers

Info about analyzers used for source code examinations.

*.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

*.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

*.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

2025-05-09 20:42