docguard-cli 0.9.6__tar.gz → 0.9.8__tar.gz

{docguard_cli-0.9.6 → docguard_cli-0.9.8}/.docguard.json

@@ -1,6 +1,7 @@
 {
   "projectName": "docguard",
-  "version": "0.3",
+  "version": "0.4",
+  "profile": "enterprise",
 
   "projectType": "cli",
 

docguard_cli-0.9.8/.github/workflows/release.yml

@@ -0,0 +1,78 @@
+name: Publish to npm + PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  # ── Run tests first ──
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18, 20, 22]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Run Tests
+        run: npm test
+      - name: Guard (self-check)
+        run: node cli/docguard.mjs guard || [ $? -eq 2 ]
+
+  # ── Publish to npm ──
+  publish-npm:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Sync version from tag
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          npm version "$VERSION" --no-git-tag-version --allow-same-version
+          echo "Publishing version $VERSION"
+
+      - name: Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  # ── Publish to PyPI ──
+  publish-pypi:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Sync version from tag
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          sed -i "s/^version = \".*\"/version = \"$VERSION\"/" pyproject.toml
+          echo "Publishing version $VERSION"
+          grep 'version' pyproject.toml
+
+      - name: Install build tools
+        run: pip install build twine
+
+      - name: Build
+        run: python -m build
+
+      - name: Publish
+        run: python -m twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

{docguard_cli-0.9.6 → docguard_cli-0.9.8}/.github/workflows/spec-kit-extension.yml

@@ -19,7 +19,7 @@ jobs:
 
       - name: Sync version in extension.yml
         run: |
-          sed -i "s/version: \".*\"/version: \"${GITHUB_REF_NAME#v}\"/" extensions/spec-kit-docguard/extension.yml
+          sed -i 's/^  version: ".*"/  version: "'"${GITHUB_REF_NAME#v}"'"/' extensions/spec-kit-docguard/extension.yml
           echo "Updated extension.yml to version ${GITHUB_REF_NAME#v}"
           grep 'version:' extensions/spec-kit-docguard/extension.yml
 

{docguard_cli-0.9.6 → docguard_cli-0.9.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docguard-cli
-Version: 0.9.6
+Version: 0.9.8
 Summary: The enforcement tool for Canonical-Driven Development (CDD). Audit, generate, and guard your project documentation. Zero dependencies.
 Project-URL: Homepage, https://github.com/raccioly/docguard
 Project-URL: Documentation, https://github.com/raccioly/docguard#readme
@@ -46,6 +46,8 @@ Description-Content-Type: text/markdown
 - [Templates](#-templates)
 - [AI Agent Support](#-ai-agent-support)
 - [Slash Commands](#-slash-commands)
+- [Examples](#-examples)
+- [Testing](#-testing)
 - [CI/CD Integration](#%EF%B8%8F-cicd-integration)
 - [File Structure](#-file-structure)
 - [Configuration](#%EF%B8%8F-configuration)
@@ -68,6 +70,39 @@ DocGuard is an official [GitHub Spec Kit](https://github.com/github/spec-kit) co
 
 📖 **[Philosophy](PHILOSOPHY.md)** · 📋 **[CDD Standard](STANDARD.md)** · ⚖️ **[Comparisons](COMPARISONS.md)** · 🗺️ **[Roadmap](ROADMAP.md)**
 
+### Architecture
+
+```mermaid
+graph TD
+    CLI["CLI Entry<br/>docguard.mjs"] --> Commands["Commands (15)"]
+    Commands --> guard["guard"]
+    Commands --> generate["generate"]
+    Commands --> score["score"]
+    Commands --> diagnose["diagnose"]
+    Commands --> setup["setup wizard"]
+    Commands --> other["diff · init · fix · trace<br/>agents · hooks · badge · ci · watch"]
+
+    guard --> Validators["Validators (19)"]
+    generate --> Scanners["Scanners (4)<br/>routes · schemas · doc-tools · speckit"]
+    score --> Scoring["Weighted Scoring<br/>8 categories"]
+    diagnose --> Validators
+    diagnose --> AIPrompts["AI-Ready<br/>Fix Prompts"]
+
+    Validators --> Output["Output"]
+    Scanners --> Output
+    Scoring --> Output
+    Output --> Terminal["Terminal"]
+    Output --> JSON["JSON"]
+    Output --> Badge["Badge"]
+
+    style CLI fill:#2d5016,color:#fff
+    style Validators fill:#1a3a5c,color:#fff
+    style Scanners fill:#1a3a5c,color:#fff
+    style Output fill:#5c3a1a,color:#fff
+```
+
+> **Distribution**: Node.js core (npm) · Python wrapper (PyPI) · GitHub Action (`action.yml`) · Spec Kit Extension (ZIP)
+
 ---
 
 ## ⚡ Quick Start
@@ -359,6 +394,44 @@ For advanced users and CI/CD pipelines, DocGuard includes bash scripts with `--j
 
 ---
 
+## 📁 Examples
+
+Three real-world projects to see DocGuard in action:
+
+| Example | Scenario | What You'll See |
+|---------|----------|----------------|
+| [01-express-api](examples/01-express-api/) | Node.js API with **zero docs** | Cold-start: `generate` → instant coverage |
+| [02-python-flask](examples/02-python-flask/) | Python app with **drifted docs** | Drift detection: catch when docs lie |
+| [03-spec-kit-project](examples/03-spec-kit-project/) | Full CDD + Spec Kit | Gold standard: what maturity looks like |
+
+See [examples/README.md](examples/README.md) for step-by-step instructions.
+
+---
+
+## 🧪 Testing
+
+### Test Suite
+
+```bash
+npm test    # 33 tests across 18 describe blocks
+```
+
+Covers all 15 CLI commands, project type detection, compliance profiles, JSON output format, and help completeness.
+
+### CI Matrix
+
+| Node.js | OS | Status |
+|---------|-----|--------|
+| 18 | ubuntu-latest | ✅ |
+| 20 | ubuntu-latest | ✅ |
+| 22 | ubuntu-latest | ✅ |
+
+### Self-Validation (Dogfooding)
+
+DocGuard runs its own `guard`, `score`, `diff`, `diagnose`, and `badge` commands against itself in CI — ensuring the tool passes its own checks.
+
+---
+
 ## ⚙️ CI/CD Integration
 
 ### GitHub Actions
@@ -386,7 +459,7 @@ npx docguard-cli hooks --type pre-commit
 ### GitHub Marketplace
 
 ```yaml
-- uses: raccioly/docguard@v0.9.5
+- uses: raccioly/docguard@v0.9.7
   with:
     command: guard
     fail-on-warning: true

{docguard_cli-0.9.6 → docguard_cli-0.9.8}/README.md

@@ -22,6 +22,8 @@
 - [Templates](#-templates)
 - [AI Agent Support](#-ai-agent-support)
 - [Slash Commands](#-slash-commands)
+- [Examples](#-examples)
+- [Testing](#-testing)
 - [CI/CD Integration](#%EF%B8%8F-cicd-integration)
 - [File Structure](#-file-structure)
 - [Configuration](#%EF%B8%8F-configuration)
@@ -44,6 +46,39 @@ DocGuard is an official [GitHub Spec Kit](https://github.com/github/spec-kit) co
 
 📖 **[Philosophy](PHILOSOPHY.md)** · 📋 **[CDD Standard](STANDARD.md)** · ⚖️ **[Comparisons](COMPARISONS.md)** · 🗺️ **[Roadmap](ROADMAP.md)**
 
+### Architecture
+
+```mermaid
+graph TD
+    CLI["CLI Entry<br/>docguard.mjs"] --> Commands["Commands (15)"]
+    Commands --> guard["guard"]
+    Commands --> generate["generate"]
+    Commands --> score["score"]
+    Commands --> diagnose["diagnose"]
+    Commands --> setup["setup wizard"]
+    Commands --> other["diff · init · fix · trace<br/>agents · hooks · badge · ci · watch"]
+
+    guard --> Validators["Validators (19)"]
+    generate --> Scanners["Scanners (4)<br/>routes · schemas · doc-tools · speckit"]
+    score --> Scoring["Weighted Scoring<br/>8 categories"]
+    diagnose --> Validators
+    diagnose --> AIPrompts["AI-Ready<br/>Fix Prompts"]
+
+    Validators --> Output["Output"]
+    Scanners --> Output
+    Scoring --> Output
+    Output --> Terminal["Terminal"]
+    Output --> JSON["JSON"]
+    Output --> Badge["Badge"]
+
+    style CLI fill:#2d5016,color:#fff
+    style Validators fill:#1a3a5c,color:#fff
+    style Scanners fill:#1a3a5c,color:#fff
+    style Output fill:#5c3a1a,color:#fff
+```
+
+> **Distribution**: Node.js core (npm) · Python wrapper (PyPI) · GitHub Action (`action.yml`) · Spec Kit Extension (ZIP)
+
 ---
 
 ## ⚡ Quick Start
@@ -335,6 +370,44 @@ For advanced users and CI/CD pipelines, DocGuard includes bash scripts with `--j
 
 ---
 
+## 📁 Examples
+
+Three real-world projects to see DocGuard in action:
+
+| Example | Scenario | What You'll See |
+|---------|----------|----------------|
+| [01-express-api](examples/01-express-api/) | Node.js API with **zero docs** | Cold-start: `generate` → instant coverage |
+| [02-python-flask](examples/02-python-flask/) | Python app with **drifted docs** | Drift detection: catch when docs lie |
+| [03-spec-kit-project](examples/03-spec-kit-project/) | Full CDD + Spec Kit | Gold standard: what maturity looks like |
+
+See [examples/README.md](examples/README.md) for step-by-step instructions.
+
+---
+
+## 🧪 Testing
+
+### Test Suite
+
+```bash
+npm test    # 33 tests across 18 describe blocks
+```
+
+Covers all 15 CLI commands, project type detection, compliance profiles, JSON output format, and help completeness.
+
+### CI Matrix
+
+| Node.js | OS | Status |
+|---------|-----|--------|
+| 18 | ubuntu-latest | ✅ |
+| 20 | ubuntu-latest | ✅ |
+| 22 | ubuntu-latest | ✅ |
+
+### Self-Validation (Dogfooding)
+
+DocGuard runs its own `guard`, `score`, `diff`, `diagnose`, and `badge` commands against itself in CI — ensuring the tool passes its own checks.
+
+---
+
 ## ⚙️ CI/CD Integration
 
 ### GitHub Actions
@@ -362,7 +435,7 @@ npx docguard-cli hooks --type pre-commit
 ### GitHub Marketplace
 
 ```yaml
-- uses: raccioly/docguard@v0.9.5
+- uses: raccioly/docguard@v0.9.7
   with:
     command: guard
     fail-on-warning: true

{docguard_cli-0.9.6 → docguard_cli-0.9.8}/SECURITY.md

@@ -4,15 +4,15 @@
 
 | Version | Supported |
 |---------|-----------|
-| 0.4.x   | ✅ Current |
-| < 0.4   | ❌ Not supported |
+| 0.9.x   | ✅ Current |
+| < 0.9   | ❌ Not supported |
 
 ## Reporting a Vulnerability
 
 If you discover a security vulnerability in DocGuard, please report it responsibly:
 
 1. **Do NOT** open a public GitHub issue for security vulnerabilities
-2. **Email** the maintainers directly (see repository contact info)
+2. **Report via** [GitHub Security Advisories](https://github.com/raccioly/docguard/security/advisories/new) (private, preferred)
 3. Include:
    - Description of the vulnerability
    - Steps to reproduce

{docguard_cli-0.9.6 → docguard_cli-0.9.8}/cli/commands/diff.mjs

@@ -157,7 +157,12 @@ function diffEntities(dir) {
     'EntityName', 'Entity', 'metadata', 'tbd', 'cascade', 'fields',
     'purpose', 'version', 'author', 'example', 'TODO', 'Overview',
     'Revision', 'History', 'Entities', 'Relationships', 'Indexes',
-    'Migration', 'Strategy',
+    'Migration', 'Strategy', 'Trade-offs', 'Tradeoffs', 'Notes',
+    'Summary', 'Details', 'Configuration', 'Setup', 'Reference',
+    'Appendix', 'Glossary', 'FAQ', 'Introduction', 'Background',
+    'Prerequisites', 'Requirements', 'Assumptions', 'Constraints',
+    'Dependencies', 'Architecture', 'Design', 'Implementation',
+    'Testing', 'Deployment', 'Monitoring', 'Operations', 'Security',
   ]);
 
   const headerRegex = /^### (\S+)/gm;
@@ -165,9 +170,11 @@ function diffEntities(dir) {
   while ((match = headerRegex.exec(content)) !== null) {
     const name = match[1].replace(/[`*]/g, '');
     // Skip template placeholders (<!-- ... -->) and noise words
-    if (name.startsWith('<!--') || name.length <= 1 || HEADER_NOISE.has(name) || HEADER_NOISE.has(name.toLowerCase())) {
+    if (name.startsWith('<!--') || name.length <= 2 || HEADER_NOISE.has(name) || HEADER_NOISE.has(name.toLowerCase())) {
       continue;
     }
+    // Skip hyphenated words (e.g., 'Trade-offs', 'Set-up') — these are section titles, not entities
+    if (name.includes('-')) continue;
     docEntities.add(name.toLowerCase());
   }
 
@@ -194,10 +201,16 @@ function diffEntities(dir) {
     // Common table headers and template words
     'true', 'false', 'header', 'checks', 'project', 'count', 'grade',
     'breakdown', 'issuecount', 'autofixable', 'projectname', 'projecttype',
+    // Common doc section words (not entity names)
+    'trade', 'offs', 'tradeoffs', 'setup', 'overview', 'summary',
+    'details', 'configuration', 'reference', 'pattern', 'patterns',
+    'strategy', 'approach', 'impact', 'benefit', 'risk', 'concern',
+    'action', 'result', 'outcome', 'inverted', 'composite', 'secondary',
   ]);
   while ((match = tableRegex.exec(content)) !== null) {
     const name = match[1];
-    if (name.length > 2 && !TABLE_NOISE.has(name.toLowerCase())) {
+    // Skip short names (<=3 chars) and noise words
+    if (name.length > 3 && !TABLE_NOISE.has(name.toLowerCase())) {
       docEntities.add(name.toLowerCase());
     }
   }

{docguard_cli-0.9.6 → docguard_cli-0.9.8}/cli/commands/init.mjs

@@ -8,6 +8,7 @@ import { resolve, dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { createInterface } from 'node:readline';
 import { c, PROFILES } from '../shared.mjs';
+import { ensureSkills } from '../ensure-skills.mjs';
 
 function detectProjectType(dir) {
   const pkgPath = resolve(dir, 'package.json');
@@ -285,4 +286,7 @@ export async function runInit(projectDir, config, flags) {
   } else {
     console.log(`\n  ${c.dim}Run${c.reset} ${c.cyan}docguard diagnose${c.reset} ${c.dim}to check for issues.${c.reset}\n`);
   }
+
+  // Auto-install skills and commands
+  ensureSkills(projectDir, flags);
 }