openai/openai-cookbook
Code Volume Analysis scope, overview of main, test, generated, deployment, build, and other code. |
Source Code Analysis Scope
Files includes and excluded from analyses
scoping details...
- 28 extensions are included in analyses: py, ipynb, json, md, txt, mjs, ts, js, svg, pkl, tsx, gitignore, html, cjs, yaml, jsonl, toml, css, yml, mdx, scss, jsx, dockerignore, sh, gitattributes, tex, jsonc, prettierignore
- 9 criteria are used to exclude files from analysis:
- exclude files with path like ".*/docs/.*" (Documentation) (16 files).
- exclude files with path like ".*/(3rd|[Tt]hird)[-_]?[Pp]arty/.*" (Dependencies) (8 files).
- exclude files with path like ".*\.d\.ts" (Typescript definition files) (9 files).
- exclude files with path like ".*/dist/.*" (Distributions) (0 files).
- exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (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).
- The source code folder contains 3,727 files:
- 1,386 files are included in analyses.
- 2,341 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.
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Generated Code
Automatically generated files, not manually changed after generation.
Build and Deployment Code
Source code used to configure or support build and deployment process.
scope details...
- The following criteria are used to filter files:
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/requirements[a-zA-Z0-9._-]*[.]txt".
- files with paths like ".*/pyproject[.]toml".
- files with paths like ".*/docker[-]compose[.]yml".
- files with paths like ".*/docker[-]compose[.]yaml".
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*/package[.]json".
- files with paths like ".*/[.]dockerignore".
- files with paths like "(.*/)?[.]dockerignore".
- files with paths like ".*[.]sh".
- files with paths like ".*/[.]gitattributes".
- files with paths like "(.*/)?[.](idea|vscode|vs|gradle|mvn|settings|metadata|circleci)/.*".
- files with paths like ".*/pnpm.*[.]ya?ml".
- files with paths like ".*/[.]prettierignore".
- files with paths like "(.*/)?[.]prettierignore".
- files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
- 4 files match defined criteria (242 LOC, 3.0% vs. main code):
- 1 gitignore files (129 LOC)
- 3 yaml files (113 LOC)
Other Code
scope details...
- The following criteria are used to filter files:
- files with paths like ".*[.]svg".
- files with paths like ".*[.]md".
- files with paths like ".*[.]mdx".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]txt".
- files with paths like ".*[.]json".
- 1374 files match defined criteria (329,606 LOC, 4080.8% vs. main code):
- 162 ipynb files (129,321 LOC)
- 476 py files (75,924 LOC)
- 193 json files (30,972 LOC)
- 147 md files (18,036 LOC)
- 93 txt files (10,606 LOC)
- 6 jsonl files (10,547 LOC)
- 9 pkl files (8,811 LOC)
- 48 mjs files (7,762 LOC)
- 9 css files (6,165 LOC)
- 16 yaml files (4,815 LOC)
- 44 js files (4,726 LOC)
- 26 svg files (3,865 LOC)
- 15 html files (3,742 LOC)
- 36 ts files (3,610 LOC)
- 22 tsx files (3,355 LOC)
- 4 jsx files (2,695 LOC)
- 16 cjs files (2,304 LOC)
- 5 mdx files (1,223 LOC)
- 11 toml files (344 LOC)
- 4 scss files (302 LOC)
- 21 gitignore files (270 LOC)
- 3 sh files (154 LOC)
- 2 jsonc files (36 LOC)
- 3 dockerignore files (10 LOC)
- 1 prettierignore files (7 LOC)
- 2 gitattributes files (4 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...
- *.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
- *.ipynb 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
- *.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