@doccov/cli 0.2.1 → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ryan Waits
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,67 +1,43 @@
 # @doccov/cli
 
-Command-line interface for documentation coverage and drift detection in TypeScript.
+Command-line interface for documentation coverage and drift detection.
 
 ## Install
+
 ```bash
 npm install -g @doccov/cli
 ```
 
-## Common Commands
+## Usage
+
 ```bash
-# Check documentation coverage (fail if below 80%)
+# Check coverage
 doccov check --min-coverage 80
 
-# Generate openpkg.json spec
-doccov generate
-
-# Point at a specific entry file
-doccov generate src/index.ts --output openpkg.json
-
-# Scaffold a config to pin defaults
-doccov init
-
-# Strict mode: require examples and 90% coverage
-doccov check --min-coverage 90 --require-examples
-```
-
-## Flags at a Glance
-- `--min-coverage <percentage>` – fail if coverage drops below threshold
-- `--require-examples` – require `@example` blocks on all exports
-- `--include <id>` / `--exclude <id>` – narrow the surface area
-- `--package <name>` – target a workspace package from the monorepo root
-- `--no-external-types` – skip pulling types from installed deps
-- `--output <file>` – write somewhere other than `openpkg.json`
-
-## Config File
-Optional `doccov.config.(ts|js|mjs)` keeps CLI defaults alongside your project:
-```ts
-// doccov.config.ts
-import { defineConfig } from '@doccov/cli/config';
+# Generate spec
+doccov generate -o openpkg.json
 
-export default defineConfig({
-  include: ['createUser'],
-  exclude: ['internalHelper'],
-});
+# Require examples
+doccov check --require-examples
 ```
-CLI flags always win over config values.
 
-## Drift Detection
+## Commands
 
-DocCov detects when your TSDoc comments drift from your code:
+| Command | Description |
+|---------|-------------|
+| `check` | Validate coverage thresholds |
+| `generate` | Generate OpenPkg spec |
+| `diff` | Compare two specs |
+| `report` | Generate coverage report |
+| `scan` | Analyze GitHub repos |
+| `init` | Create config file |
 
-```
-✖ Docs coverage 72% fell below required 80%.
+## Documentation
 
-Missing documentation details:
-  • createUser: missing params, examples
-  • updateUser: JSDoc documents parameter "userId" which is not present in the signature.
-    Suggestion: Did you mean "id"?
-```
+- [CLI Overview](../../docs/cli/overview.md)
+- [Command Reference](../../docs/cli/commands/)
+- [Configuration](../../docs/cli/configuration.md)
 
-## More
-Full command reference and troubleshooting tips live in the repository:
-- [Usage docs](../../USAGE.md)
-- [Fixtures](../../tests/fixtures/README.md)
+## License
 
-MIT License
+MIT