guardian/interactive-atom-best-of-list-2017
Code Volume
Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
npmignore
ls
babelrc
tpl
jshintrc

scoping details...
  • 15 extensions are included in analyses: js, json, md, css, html, yml, scss, txt, npmignore, gitignore, ls, babelrc, tpl, markdown, jshintrc
  • 10 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/react(-[^.]*)?\.js" (React) (4 files).
    • exclude files with path like ".*[.]min[.]js" (Minimized JS library) (3 files).
    • exclude files with path like ".*/bin/.*" (Binaries for distribution) (2 files).
    • exclude files with path like "(?i).*/require.*[.]js" (RequireJS files) (2 files).
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
    • 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) (1 file).
    • exclude files with path like ".*/_sokrates/.*" (Sokrates files) (0 files).
    • exclude files with path like ".*/_sokrates_landscape/.*" (Sokrates landscape files) (0 files).
    • exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (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.
main62663 LOC (89%) 1,479 files
test5018 LOC (7%) 43 files
generated0 LOC (0%) 0 files
build and deployment126 LOC (<1%) 15 files
other2122 LOC (3%) 69 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
ls
tpl
Explore:   circles  |  sunburst

js60922 LOC (97%) 1,455 files
css786 LOC (1%) 4 files
scss520 LOC (<1%) 7 files
ls293 LOC (<1%) 2 files
yaml62 LOC (<1%) 4 files
html52 LOC (<1%) 6 files
tpl28 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 1479 files match defined criteria (62,663 LOC, 100.0% vs. main code):
    • 1,455 js files (60,922 LOC)
    • 4 css files (786 LOC)
    • 7 scss files (520 LOC)
    • 2 ls files (293 LOC)
    • 4 yaml files (62 LOC)
    • 6 html files (52 LOC)
    • 1 tpl files (28 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

js4395 LOC (87%) 34 files
html454 LOC (9%) 8 files
css169 LOC (3%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/test[.].*".
    • files with paths like ".*/[Tt]est/.*".
  • 43 files match defined criteria (5,018 LOC, 8.0% vs. main code):
    • 34 js files (4,395 LOC)
    • 8 html files (454 LOC)
    • 1 css files (169 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
babelrc
jshintrc
npmignore
Explore:   circles  |  sunburst

yaml63 LOC (50%) 6 files
babelrc26 LOC (20%) 1 file
jshintrc24 LOC (19%) 1 file
gitignore7 LOC (5%) 2 files
npmignore6 LOC (4%) 5 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like "(.*/)?[.]babelrc([.].*)?".
    • files with paths like ".*/package[.]json".
    • files with paths like "(.*/)?[.]jshintrc".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]npmignore".
    • files with paths like "(.*/)?[.]npmignore".
    • files with paths like ".*/[.]travis[.]yml".
  • 15 files match defined criteria (126 LOC, 0.2% vs. main code):
    • 6 yaml files (63 LOC)
    • 1 babelrc files (26 LOC)
    • 1 jshintrc files (24 LOC)
    • 2 gitignore files (7 LOC)
    • 5 npmignore files (6 LOC)
Other Code
Explore:   circles  |  sunburst

md1112 LOC (52%) 32 files
json1003 LOC (47%) 33 files
txt5 LOC (<1%) 3 files
markdown2 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]markdown".
  • 69 files match defined criteria (2,122 LOC, 3.4% vs. main code):
    • 32 md files (1,112 LOC)
    • 33 json files (1,003 LOC)
    • 3 txt files (5 LOC)
    • 1 markdown files (2 LOC)
About This Analysis
learn more about scopes (main, test, generated, build, 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.

learn more about used code analyzers...
  • *.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
  • *.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
  • *.ls 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
  • *.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
  • *.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
  • *.tpl 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