azure / azure-api-style-guide - 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

6 extensions are included in analyses: js, md, json, yaml, txt, gitignore
4 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 ".*/docs/.*" (Documentation) (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).

The source code folder contains 84 files:

74 files are included in analyses.
10 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.

24 files

41 files

1 file

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

24 files match defined criteria (2,112 LOC, 100.0% vs. main code):

23 *.js files (1,454 LOC)
1 *.yaml files (658 LOC)

" *.js" is biggest, containing 68.84% of LOC.
" *.yaml" is smallest, containing 31.16% 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[.].*".

41 files match defined criteria (6,553 LOC, 310.3% vs. main code). All matches are in *.js 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 (8,692 LOC, 411.6% vs. main code). All matches are in *.json 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 ".*/README[.][a-z0-9]+".
files with paths like ".*/[.]gitignore".
files with paths like ".*[.]txt".

9 files match defined criteria (9,083 LOC, 430.1% vs. main code):

3 *.json files (8,747 LOC)
6 *.md files (336 LOC)

" *.json" is biggest, containing 96.3% of LOC.
" *.md" is smallest, containing 3.7% of LOC.

Analyzers

Info about analyzers used for source code examinations.

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

2025-05-06 22:17