testing-conventions 0.0.4__tar.gz → 0.0.6__tar.gz

{testing_conventions-0.0.4 → testing_conventions-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testing-conventions
-Version: 0.0.4
+Version: 0.0.6
 Summary: Enforce testing conventions in libraries (Python, TypeScript, and Rust).
 Author-email: Kevin Scott <me@thekevinscott.com>
 License: MIT

{testing_conventions-0.0.4 → testing_conventions-0.0.6}/rust/CHANGELOG.md

@@ -23,6 +23,14 @@ Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ### Changed
 
+- **BREAKING** — the unit-test location check moved from the flat `unit-location`
+  subcommand to `unit location`: rules now nest under their test kind (`unit` is a
+  command group, `location` its first rule). The `--lang` flag is renamed to
+  `--language` and is now **required** — the `python` default is gone, so omitting
+  the language is a usage error instead of a silently-empty `python` scan. Migrate
+  `unit-location --lang typescript src/` → `unit location --language typescript src/`;
+  see [MIGRATIONS](./MIGRATIONS.md#unreleased). (#22)
+
 ### Deprecated
 
 ### Removed

{testing_conventions-0.0.4 → testing_conventions-0.0.6}/rust/Cargo.lock

@@ -226,7 +226,7 @@ dependencies = [
 
 [[package]]
 name = "testing-conventions"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = [
  "anyhow",
  "clap",

{testing_conventions-0.0.4 → testing_conventions-0.0.6}/rust/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "testing-conventions"
-version = "0.0.4"
+version = "0.0.6"
 edition = "2021"
 license = "MIT"
 authors = ["Kevin Scott <me@thekevinscott.com>"]

testing_conventions-0.0.6/rust/MIGRATIONS.md

@@ -0,0 +1,83 @@
+# Migrations
+
+Upgrade notes for breaking changes. New entries go under `## Unreleased`.
+On release, the section is renamed to `## v<OLD> → v<NEW>`.
+
+Each entry has five sections, in order:
+
+1. **Summary** — one paragraph: what changed and why.
+2. **Required changes** — before/after for public API. "None" if purely additive.
+3. **Deprecations removed** — anything previously warned about that's now gone.
+4. **Behavior changes without code changes** — same API, different runtime behavior.
+5. **Verification** — commands that confirm the upgrade worked, with expected output.
+
+## Unreleased
+
+### Summary
+
+Adds the `config` module: a `Config` schema holding the per-language `coverage`
+thresholds (`[python]` / `[typescript]` / `[rust]`), plus `load_config()`, which
+reads one TOML file into it and validates the config itself (the self-guard) —
+unknown keys and malformed TOML are rejected rather than silently accepted.
+Purely additive; nothing consumes the parsed config yet.
+
+Also reshapes the unit-test location/naming rule's CLI (#22). The rule itself
+ships for two languages — `missing_unit_tests(root, language)` walks a directory
+and returns every source file with no colocated test, and the CLI runs it and
+exits non-zero on any orphan (Python #15: `foo.py` → `foo_test.py`, `__init__.py`
+exempt; TypeScript #18: `foo-bar.ts` → `foo-bar.test.ts` across
+`.ts`/`.tsx`/`.mts`/`.cts`, `*.d.ts`/`*.d.mts`/`*.d.cts` ignored). The
+**command surface changes**, though: the previously released `unit-location
+[--lang …]` (v0.0.3 / v0.0.4) becomes `unit location --language
+<python|typescript> <PATH>` — rules now nest under their test kind (`unit` is a
+command group, `location` its first rule) and `--language` is required (the
+`python` default is gone). This is a breaking change for anyone on v0.0.4 or
+earlier; the library API (`missing_unit_tests`, `Language`, `Config`,
+`load_config`) is unchanged.
+
+### Required changes
+
+The unit-location CLI was renamed and its language flag made required. Update any
+invocation (CI steps, scripts, `npx`/`pip`/`cargo` wrappers):
+
+| Before (≤ v0.0.4)                      | After                                      |
+| -------------------------------------- | ------------------------------------------ |
+| `unit-location src/`                   | `unit location --language python src/`     |
+| `unit-location --lang typescript src/` | `unit location --language typescript src/` |
+
+- `unit-location` → `unit location` (a `location` subcommand under the new `unit` group).
+- `--lang` → `--language`.
+- `--language` is required: there is no longer a `python` default to fall back on.
+
+The library API is unchanged — `testing_conventions::config::{Config, load_config}`
+and `testing_conventions::location::{missing_unit_tests, Language}` keep their
+signatures.
+
+### Deprecations removed
+
+The `--lang` flag and its implicit `python` default are gone — a clean break, not
+a deprecation cycle (pre-1.0, so no prior warning was shipped).
+
+### Behavior changes without code changes
+
+Omitting the language is now a usage error (exit code `2`) instead of defaulting to
+`python`. Before, running the check on a TypeScript project without a flag scanned
+for `*.py`, found none, and exited `0` — a silent false green; now the language
+must be stated explicitly.
+
+### Verification
+
+```
+cd packages/rust && cargo test --test config_loader
+```
+
+Expected: the loader's integration tests pass — the canonical config loads into
+memory, and unknown-key, malformed, and missing-file configs are rejected.
+
+```
+cd packages/rust && cargo test --test unit_location
+```
+
+Expected: the location check's integration tests pass for both languages — each
+clean fixture reports no orphans, each red fixture reports its missing twins, and
+`unit location` exits non-zero on the red fixtures.

{testing_conventions-0.0.4 → testing_conventions-0.0.6}/rust/src/lib.rs

@@ -21,13 +21,23 @@ pub struct Cli {
 enum Command {
     /// Check the repository against its testing-conventions config.
     Check,
+    /// Unit-test conventions.
+    Unit {
+        #[command(subcommand)]
+        rule: UnitRule,
+    },
+}
+
+/// Rules enforced on the unit-test suite (the README's "Unit" taxonomy).
+#[derive(Subcommand, Debug)]
+enum UnitRule {
     /// Check that every source file has a colocated unit test.
-    UnitLocation {
+    Location {
         /// Directory to scan recursively.
         path: PathBuf,
-        /// Language convention to enforce.
-        #[arg(long, value_enum, default_value = "python")]
-        lang: location::Language,
+        /// Language convention to enforce (required).
+        #[arg(long, value_enum)]
+        language: location::Language,
     },
 }
 
@@ -39,9 +49,12 @@ where
     let cli = Cli::try_parse_from(args)?;
     match cli.command {
         // The config-driven `check` umbrella isn't wired yet; the scaffold
-        // proves the wiring while individual rules land as their own subcommand.
+        // proves the wiring while individual rules land under their test-kind
+        // group (e.g. `unit location`).
         Some(Command::Check) | None => Ok(0),
-        Some(Command::UnitLocation { path, lang }) => run_unit_location(&path, lang),
+        Some(Command::Unit {
+            rule: UnitRule::Location { path, language },
+        }) => run_unit_location(&path, language),
     }
 }
 

{testing_conventions-0.0.4 → testing_conventions-0.0.6}/rust/tests/unit_location.rs

@@ -3,8 +3,9 @@
 //!
 //! A source file must have a *colocated* test named after it: `foo.py` →
 //! `foo_test.py`, `foo-bar.ts` → `foo-bar.test.ts`. `missing_unit_tests`
-//! returns the source files missing their twin; the `unit-location`
-//! subcommand turns a non-empty result into a non-zero exit.
+//! returns the source files missing their twin; the `unit location`
+//! subcommand (a `location` rule nested under the `unit` kind, #22) turns a
+//! non-empty result into a non-zero exit.
 //!
 //! Per the #3 guardrail, each language ships a clean fixture (every source
 //! paired — must pass) and a red fixture (orphans present — must fail).
@@ -36,14 +37,16 @@ fn relative_orphans(root: &Path, language: Language) -> Vec<String> {
         .collect()
 }
 
-/// Exit code of `unit-location [--lang <lang>] <fixture>`.
-fn unit_location_exit(fixture_name: &str, lang: Option<&str>) -> i32 {
-    let mut argv: Vec<OsString> = vec!["testing-conventions".into(), "unit-location".into()];
-    if let Some(lang) = lang {
-        argv.push("--lang".into());
-        argv.push(lang.into());
-    }
-    argv.push(fixture(fixture_name).into_os_string());
+/// Exit code of `unit location --language <language> <fixture>`.
+fn unit_location_exit(fixture_name: &str, language: &str) -> i32 {
+    let argv: Vec<OsString> = vec![
+        "testing-conventions".into(),
+        "unit".into(),
+        "location".into(),
+        "--language".into(),
+        language.into(),
+        fixture(fixture_name).into_os_string(),
+    ];
     run(argv).expect("a readable tree should not error")
 }
 
@@ -83,12 +86,12 @@ fn python_missing_root_is_an_error() {
 
 #[test]
 fn python_subcommand_exits_zero_on_a_clean_tree() {
-    assert_eq!(unit_location_exit("clean", None), 0);
+    assert_eq!(unit_location_exit("clean", "python"), 0);
 }
 
 #[test]
 fn python_subcommand_exits_nonzero_on_a_red_tree() {
-    assert_eq!(unit_location_exit("red", None), 1);
+    assert_eq!(unit_location_exit("red", "python"), 1);
 }
 
 // ---- TypeScript (#18) ----------------------------------------------------
@@ -113,13 +116,45 @@ fn typescript_red_tree_reports_every_missing_twin() {
 
 #[test]
 fn typescript_subcommand_exits_zero_on_a_clean_tree() {
+    assert_eq!(unit_location_exit("typescript/clean", "typescript"), 0);
+}
+
+#[test]
+fn typescript_subcommand_exits_nonzero_on_a_red_tree() {
+    assert_eq!(unit_location_exit("typescript/red", "typescript"), 1);
+}
+
+// ---- CLI surface (#22) ---------------------------------------------------
+
+/// Raw result of invoking the CLI with `args` after the program name, so a
+/// usage error (clap) can be asserted rather than unwrapped away.
+fn run_cli(args: &[&str]) -> anyhow::Result<i32> {
+    let argv: Vec<OsString> = std::iter::once(OsString::from("testing-conventions"))
+        .chain(args.iter().copied().map(OsString::from))
+        .collect();
+    run(argv)
+}
+
+#[test]
+fn unit_location_requires_language() {
+    // Omitting `--language` is a usage error — never a silent `python` run.
+    let err = run_cli(&["unit", "location", "src"]).expect_err("--language is required");
+    let clap_err = err
+        .downcast_ref::<clap::Error>()
+        .expect("a missing required flag should surface as a clap::Error");
     assert_eq!(
-        unit_location_exit("typescript/clean", Some("typescript")),
-        0
+        clap_err.kind(),
+        clap::error::ErrorKind::MissingRequiredArgument
     );
 }
 
 #[test]
-fn typescript_subcommand_exits_nonzero_on_a_red_tree() {
-    assert_eq!(unit_location_exit("typescript/red", Some("typescript")), 1);
+fn the_flat_unit_location_subcommand_is_gone() {
+    // The pre-#22 flat form (`unit-location …`) no longer parses; the rule now
+    // lives at `unit location`.
+    let err = run_cli(&["unit-location", "src"]).expect_err("the flat subcommand was removed");
+    let clap_err = err
+        .downcast_ref::<clap::Error>()
+        .expect("an unknown subcommand should surface as a clap::Error");
+    assert_eq!(clap_err.kind(), clap::error::ErrorKind::InvalidSubcommand);
 }

testing_conventions-0.0.4/rust/MIGRATIONS.md

@@ -1,61 +0,0 @@
-# Migrations
-
-Upgrade notes for breaking changes. New entries go under `## Unreleased`.
-On release, the section is renamed to `## v<OLD> → v<NEW>`.
-
-Each entry has five sections, in order:
-
-1. **Summary** — one paragraph: what changed and why.
-2. **Required changes** — before/after for public API. "None" if purely additive.
-3. **Deprecations removed** — anything previously warned about that's now gone.
-4. **Behavior changes without code changes** — same API, different runtime behavior.
-5. **Verification** — commands that confirm the upgrade worked, with expected output.
-
-## Unreleased
-
-### Summary
-
-Adds the `config` module: a `Config` schema holding the per-language `coverage`
-thresholds (`[python]` / `[typescript]` / `[rust]`), plus `load_config()`, which
-reads one TOML file into it and validates the config itself (the self-guard) —
-unknown keys and malformed TOML are rejected rather than silently accepted.
-Purely additive; nothing consumes the parsed config yet.
-
-Also adds the first structural rule — unit-test location/naming — for two
-languages. `missing_unit_tests(root, language)` walks a directory and returns
-every source file with no colocated test, and `unit-location [--lang …] <PATH>`
-runs that check and exits non-zero on any orphan. Python (#15): `foo.py` →
-`foo_test.py`, `__init__.py` exempt. TypeScript (#18): `foo-bar.ts` →
-`foo-bar.test.ts` (`.ts`/`.tsx`/`.mts`/`.cts`), `*.d.ts`/`*.d.mts`/`*.d.cts`
-ignored. Purely additive.
-
-### Required changes
-
-None. New, additive API: `testing_conventions::config::{Config, load_config}`,
-`testing_conventions::location::{missing_unit_tests, Language}`, and the
-`unit-location [--lang python|typescript] <PATH>` CLI subcommand.
-
-### Deprecations removed
-
-None.
-
-### Behavior changes without code changes
-
-None.
-
-### Verification
-
-```
-cd packages/rust && cargo test --test config_loader
-```
-
-Expected: the loader's integration tests pass — the canonical config loads into
-memory, and unknown-key, malformed, and missing-file configs are rejected.
-
-```
-cd packages/rust && cargo test --test unit_location
-```
-
-Expected: the location check's integration tests pass for both languages — each
-clean fixture reports no orphans, each red fixture reports its missing twins, and
-`unit-location` exits non-zero on the red fixtures.