big-code-analysis-cli 2.3.1__py3-none-win_amd64.whl → 2.5.0__py3-none-win_amd64.whl

big_code_analysis_cli-2.5.0.data/scripts/bca.exe

@@ -0,0 +1,4 @@
+[diffend] Oversized file quarantined before diffing.
+name: big_code_analysis_cli-2.5.0.data/scripts/bca.exe
+size: 52457472 bytes
+sha256: 23aa7b425d541b2d652488cae8b4af29aae026ddcb3914cdf31e22dad231e03a

big_code_analysis_cli-2.5.0.dist-info/METADATA

@@ -0,0 +1,208 @@
+Metadata-Version: 2.4
+Name: big-code-analysis-cli
+Version: 2.5.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Quality Assurance
+License-File: LICENSE
+License-File: THIRD-PARTY-LICENSES-bca.md
+Summary: The bca command-line tool: compute and export code metrics for many languages
+Keywords: metrics,tree-sitter,static-analysis,cli
+Author-email: Calixte Denizet <cdenizet@mozilla.com>, Elijah Zupancic <elijah@zupancic.name>
+License-Expression: MPL-2.0
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Documentation, https://dekobon.github.io/big-code-analysis/
+Project-URL: Repository, https://github.com/dekobon/big-code-analysis
+
+# big-code-analysis-cli
+
+`bca` is the command-line front end for the
+[big-code-analysis](https://crates.io/crates/big-code-analysis) library.
+It analyzes source code and emits per-file structured metrics,
+aggregated reports, threshold checks, AST dumps, and node lookups. The
+full reference is the
+[user guide](https://dekobon.github.io/big-code-analysis/commands/index.html).
+
+> **Migrating from the flag-style CLI?** The CLI is now subcommand-driven.
+> See the [migration guide](../big-code-analysis-book/src/migration.md)
+> for old-form -> new-form mappings of every flag.
+
+## Installation
+
+### From [PyPI](https://pypi.org/) (pip)
+
+Install a prebuilt wheel on Linux, macOS, or Windows without a Rust
+toolchain:
+
+```sh
+pip install big-code-analysis-cli   # installs the `bca` command on PATH
+bca --version
+```
+
+The [distribution name](https://pypi.org/project/big-code-analysis-cli/)
+and the command name differ on purpose: you
+`pip install big-code-analysis-cli`, but the installed executable is
+`bca`. The `bca` name on PyPI belongs to an unrelated project, and
+`big-code-analysis` is this project's importable *library* bindings
+(`pip install big-code-analysis`), a different deliverable.
+
+The wheel ships the full `all-languages` grammar set. A single
+`py3-none-<platform>` wheel covers every CPython 3.x (and PyPy) on that
+platform. Prebuilt wheels are published for Linux (`manylinux_2_28`
+`x86_64` / `aarch64`), macOS (`x86_64` / `arm64`), and Windows
+(`x86_64`); other platforms fall back to a source build.
+
+### From crates.io ([Cargo](https://doc.rust-lang.org/cargo/))
+
+```sh
+cargo install big-code-analysis-cli
+```
+
+### From source
+
+```sh
+cd big-code-analysis-cli/
+cargo build --release
+```
+
+## Usage
+
+```sh
+bca [OPTIONS] <COMMAND> [COMMAND OPTIONS]
+```
+
+The command picks *what to do*; its options describe *what to walk*
+(paths, includes and excludes, parallelism, language overrides) and how
+to format the result. Input-selection and walker-tuning flags are
+**scoped to the subcommand that consumes them** and must be written
+**after** the subcommand token. Only `-w` / `--warnings` and
+`--report-skipped` are universal and accepted in any position.
+
+## Commands
+
+| Command | Purpose |
+| --- | --- |
+| `metrics` | Per-file metric output (`-O cbor/csv/json/toml/yaml`, `--output-dir DIR`). |
+| `ops` | Per-file operand/operator output (same formats as `metrics`). |
+| `report <FORMAT>` | Aggregated report (`markdown` or `html`). |
+| `check` | Check per-function metrics against thresholds; exits 2 on threshold violations. |
+| `dump` | AST dump to stdout (`--line-start`/`--line-end` to scope a range). |
+| `find -t <NODE>...` | Find nodes of one or more types, one `-t`/`--type` per type (`--line-start`/`--line-end` to scope a range). |
+| `count -t <NODE>...` | Count nodes of one or more types, one `-t`/`--type` per type. |
+| `functions` | List functions/methods and their spans. |
+| `strip-comments` | Remove comments from source files (`--in-place` or `--output FILE`). |
+| `preproc` | Build preprocessor-data JSON for C/C++ analysis. |
+| `list-metrics [names\|descriptions]` | List computable metrics. |
+| `vcs [commit\|trend]` | Rank files by change-history risk; score one commit; sample a trend. |
+| `init` | Scaffold `bca.toml`, `.bcaignore`, and `.bca-baseline.toml`. |
+| `diff` | Compare two metric-output runs (or `--since <ref>` against the working tree). |
+| `diff-baseline` | Diff two `.bca-baseline.toml` files. |
+| `exemptions` | List everything the `check` gate skips: markers, `[check.exclude]` globs, baseline entries. |
+
+Run `bca <COMMAND> --help` for command-specific options.
+
+## Walking options
+
+The walking subcommands (`metrics`, `ops`, `report`, `check`, `dump`,
+`find`, `count`, `functions`, `strip-comments`, `preproc`, `exemptions`,
+`init`, `diff`, and the bare `vcs` ranking) accept these input-selection
+and walker-tuning flags, written **after** the subcommand. A flag passed
+to a subcommand that never consumes it is a hard usage error (exit 1),
+not a silent no-op.
+
+- `-p, --paths <FILE>...`: input files or directories. Most walking
+  subcommands also accept paths positionally (`bca metrics src/`); the
+  exceptions are `report`, `vcs`, and `init` (`--paths` only; `init`
+  scaffolds into `--dir`) and `diff` (its positionals are the two
+  result sets).
+- `-I, --include <GLOB>`: include files matching pattern (repeatable).
+- `-X, --exclude <GLOB>`: exclude files matching pattern (repeatable).
+- `-j, --jobs <N|auto>`: worker threads; the default `auto` uses the
+  effective CPU count (`--num-jobs` is a deprecated alias).
+- `-l, --language <LANG>`: force a language instead of inferring. Accepts
+  a language name (`rust`) or extension (`rs`); unknown values error out.
+- `-w, --warnings`: print warnings (skipped files, unrecognized
+  languages). `--warning` is a deprecated alias.
+- `--no-skip-generated`: disable auto-skip of files marked as generated
+  (see [Skipping generated code](#skipping-generated-code)).
+- `--report-skipped`: log a `skipped (generated): <path>` line to stderr
+  for every file the generated-code detector excludes.
+- `--preproc-data <FILE>`: consume an existing preproc JSON during C/C++
+  analysis. Build one with `bca preproc`.
+
+`-w` / `--warnings` and `--report-skipped` are the only universal options;
+they are accepted in any position, before or after the subcommand.
+
+## Building with a subset of languages
+
+The shipped `bca` binary compiles in every supported
+[tree-sitter](https://tree-sitter.github.io/tree-sitter/) grammar. The
+`big-code-analysis-cli` crate pins the library's `all-languages` feature
+set explicitly, so passing `--no-default-features` or a custom
+`--features` list to `cargo build -p big-code-analysis-cli` does **not**
+drop grammars from the resulting binary. Feature selection on the CLI
+crate is not honoured: dropping a grammar silently from a user-facing
+binary would surface as "language X stopped working" rather than as a
+build error ([#252][issue-252]).
+
+To ship a reduced grammar set, embed the `big-code-analysis` library in
+your own Rust code and select features in your own `Cargo.toml`. The
+library's [per-language Cargo features][cargo-features] chapter lists
+the features and gives a worked example.
+
+[cargo-features]: https://dekobon.github.io/big-code-analysis/library/cargo-features.html
+[issue-252]: https://github.com/dekobon/big-code-analysis/issues/252
+
+## Examples
+
+Per-file JSON metrics:
+
+```sh
+bca metrics --paths ./src -O json --output-dir ./out/
+```
+
+Aggregated markdown quality report:
+
+```sh
+bca report --format markdown --paths "$PWD" --jobs $(nproc) \
+    --top 20 --strip-prefix "$PWD/"
+```
+
+AST dump for one file:
+
+```sh
+bca dump ./file.rs
+```
+
+List all metrics with one-line descriptions:
+
+```sh
+bca list-metrics descriptions
+```
+
+## Skipping generated code
+
+Generated files inflate metrics for code no human will refactor. By
+default, `bca` scans the first ~50 lines / 5 KiB of each file for a
+generated-code marker and skips matches before parsing.
+
+Recognized markers (case-insensitive):
+
+- `@generated`: a marker emitted by code generators.
+- `DO NOT EDIT`: a marker used by
+  [Go's generated-code convention](https://go.dev/s/generatedcode) and
+  other generators.
+- `GENERATED CODE`: [Lizard](https://github.com/terryyin/lizard)'s
+  marker, recognized for compatibility.
+
+A marker phrase that appears only deep in the file body (past the scan
+window) does not trigger the skip.
+
+To analyze everything, pass `--no-skip-generated`. To audit which files
+were excluded, pass `--report-skipped`; the CLI logs
+`skipped (generated): <path>` to stderr for each file.
+

big_code_analysis_cli-2.5.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+big_code_analysis_cli-2.5.0.data/scripts/bca.exe,sha256=I6p7Ql1UGy1lJIjK6LSvKargJt3LORTN8x4i2tIx4Do,52457472
+big_code_analysis_cli-2.5.0.dist-info/METADATA,sha256=eDoRuGq7z7VjHWaaCT_534aT4Gry_eRF_1J4aI1r7Rw,8720
+big_code_analysis_cli-2.5.0.dist-info/WHEEL,sha256=Uvw7WSmy7Kj2FBk8Va4L_dq4MDW8X5Ynby-pOX3ZNS0,94
+big_code_analysis_cli-2.5.0.dist-info/licenses/LICENSE,sha256=gjTyRor408X6Rv63kxZP8iZMcQsu9-U3r0PiBY2SCg0,15934
+big_code_analysis_cli-2.5.0.dist-info/licenses/THIRD-PARTY-LICENSES-bca.md,sha256=0nhCpc58hGjVfH2LKEweUBpBp5tPu9QaqQMl-q2ngWQ,282738
+big_code_analysis_cli-2.5.0.dist-info/sboms/big-code-analysis-cli.cyclonedx.json,sha256=Fw38x-AcTRP0iLDDgLExHYMdPnt3nBO35XgUMlvRD5k,297145
+man/bca-check.1,sha256=35G3AW2cdo9Pt_xrhPWuJ9bgdpLOw8XVJcU4ozoOm_o,26302
+man/bca-count.1,sha256=QyBozu982ZwPd3tQsXTtwrpeEVAI03fdHVZz2RGKGb4,8897
+man/bca-diff-baseline.1,sha256=4C3nKQoK5CM3WGvrxkir-aMb-QD67129aMbEqtR5HHg,3184
+man/bca-diff.1,sha256=qiaN1MVW-aJbq7TQNCaEVImFxILEyqH3f7tYVgyihbs,12948
+man/bca-dump.1,sha256=iVcpAz8mJP1-OJVyjaQVukj8d4gGsB34ATYw9SZjpYU,10036
+man/bca-exemptions.1,sha256=UfgNlDTW0NKtBHOGtu_HpRlkFc6CWkhhFuzW9kkKQe0,10881
+man/bca-find.1,sha256=qj0rwIgB9gcKocrSx05_SqO5b0Jdy-f3SUme19yZbo0,9928
+man/bca-functions.1,sha256=ddE3Iy85TYWNOG47LMl2DiHm0nvC1cK-TzCjaOhCiWg,9260
+man/bca-init.1,sha256=TB9icbQ7QTdo7xWtJrFjcwrlGSbUFQbJG1XNejpVaaM,9392
+man/bca-list-metrics.1,sha256=KZutNHGIMqZa_mK2VCZQ7rLIUrbaFqO9-j2lDKFcDXE,1192
+man/bca-metrics.1,sha256=TgcZZuo5E_2cSp398v0C6mTICwBJD4AEcR6Kp08YCqQ,12896
+man/bca-ops.1,sha256=7CJuSFOY_D94i1Az_QB5jivfwt1L71AIq7dRUpffOg0,11223
+man/bca-preproc.1,sha256=gbb1grer3Neuq88Zv6uMF2E6CPjtQHf4dAE10ITtFgo,8414
+man/bca-report.1,sha256=KSLKQxAZSpPCfiFRdHjQ7CHTC5MRTIjffC1TOFPVfEA,10079
+man/bca-strip-comments.1,sha256=lD92OFnk83WlgUD9kGheZUmW_RFIn8G-w8vKPFY9iMI,9006
+man/bca-vcs-commit.1,sha256=ln3EBivoZfM40sRD8j360jViFgcdB10hdkORhh9VQcU,5250
+man/bca-vcs-trend.1,sha256=8kQ8SG1kqw7pGLYuLGQuAaAO116hwUQ-_v3yI5vuCbY,4642
+man/bca-vcs.1,sha256=X6tP68VrnHVyqyTHluIOAV9QWi8gdZZFqNpy6Z8dqpI,14692
+man/bca.1,sha256=tT3Yalv9VWiSdjMCh0RHyPhybKJj-mH88GN1IFOf6kY,5052
+big_code_analysis_cli-2.5.0.dist-info/RECORD,,

{big_code_analysis_cli-2.3.1.dist-info → big_code_analysis_cli-2.5.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.15.0)
+Generator: maturin (1.16.0)
 Root-Is-Purelib: false
 Tag: py3-none-win_amd64