apache / pulsar-client-nodeSource 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

clang-format

eslintignore

gyp

16 extensions are included in analyses: js, h, sh, cc, json, txt, md, py, yml, yaml, ts, gitignore, clang-format, bat, eslintignore, gyp
6 criteria are used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (8 files).
exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (1 file).
exclude files with path like ".*/docs/.*" (Documentation) (1 file).
exclude files with path like ".*\.d\.ts" (Typescript definition files) (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) (0 files).

The source code folder contains 108 files:

84 files are included in analyses.
24 files are excluded from analyses:

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.

44 files

13 files

9 files

18 files

Main Code

All manually created or maintained source code that defines logic of the product that is run in a production environment.

gyp

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

44 files match defined criteria (3,093 LOC, 100.0% vs. main code):

13 *.cc files (2,010 LOC)
15 *.h files (343 LOC)
1 *.ts files (317 LOC)
11 *.js files (253 LOC)
1 *.gyp files (118 LOC)
2 *.py files (44 LOC)
1 *.yaml files (8 LOC)

" *.cc" is biggest, containing 64.99% of LOC.
" *.yaml" is smallest, containing 0.26% 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]ests/.*".
files with paths like ".*[.][Tt]est[.].*".
files with paths like ".*[.]test[.].*".
files with paths like ".*[-]test[-].*".
files with paths like ".*_test[.].*".

13 files match defined criteria (1,743 LOC, 56.4% vs. main code):

7 *.js files (1,674 LOC)
6 *.sh files (69 LOC)

" *.js" is biggest, containing 96.04% of LOC.
" *.sh" is smallest, containing 3.96% of LOC.

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 ".*/package[.]json".
files with paths like ".*[.]bat".

9 files match defined criteria (258 LOC, 8.3% vs. main code):

8 *.sh files (248 LOC)
1 *.bat files (10 LOC)

" *.sh" is biggest, containing 96.12% of LOC.
" *.bat" is smallest, containing 3.88% of LOC.

Other Code

txt

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*[.]txt".
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 ".*/[Ee]xamples/.*".
files with paths like ".*/[.]eslintignore".

18 files match defined criteria (542 LOC, 17.5% vs. main code):

11 *.js files (233 LOC)
4 *.json files (166 LOC)
1 *.md files (127 LOC)
2 *.txt files (16 LOC)

" *.js" is biggest, containing 42.99% of LOC.
" *.txt" is smallest, containing 2.95% of LOC.

Analyzers

Info about analyzers used for source code examinations.

*.cc files are analyzed with CppAnalyzer:

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

*.h files are analyzed with CppAnalyzer:

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

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

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

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

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

2023-08-10 22:08