docs-index-keeper 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Oleg Koval
+
+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

@@ -0,0 +1,125 @@
+# docs-index-keeper
+
+[![npm version](https://img.shields.io/npm/v/docs-index-keeper.svg)](https://www.npmjs.com/package/docs-index-keeper)
+[![npm downloads](https://img.shields.io/npm/dm/docs-index-keeper.svg)](https://www.npmjs.com/package/docs-index-keeper)
+[![CI](https://github.com/oleg-koval/docs-index-keeper/actions/workflows/ci.yml/badge.svg)](https://github.com/oleg-koval/docs-index-keeper/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node](https://img.shields.io/node/v/docs-index-keeper.svg)](https://nodejs.org)
+
+**Keep your docs index in sync automatically.** When you add or change Markdown files under `docs/`, a pre-commit hook (or CI step) updates the index table—no manual edits, no forgotten entries.
+
+- **Zero config for common setups:** `docs/README.md` index, exclude `archive/`, optional warning for root-level `.md`
+- **Composable:** Use with [Husky](https://typicode.github.io/husky/) or plain `.git/hooks/pre-commit`
+- **CI-friendly:** `docs-index-keeper check` exits 1 if the index would change (enforce “index must be up to date”)
+- **Portable:** Node 18+, no runtime dependencies, works with npm / pnpm / yarn / bun
+
+---
+
+## Why use it?
+
+| Problem | What docs-index-keeper does |
+|--------|-----------------------------|
+| New runbooks or guides get added under `docs/` but nobody updates the index | Pre-commit (or CI) adds a row to `docs/README.md` automatically |
+| Contributors forget to touch the index | Hook runs on staged `.md` files; index is updated and re-staged in the same commit |
+| “Is this doc listed?” is a recurring review comment | Index stays in sync by construction |
+| Onboarding: “Where do I find X?” | Single table in `docs/README.md` is always up to date |
+
+**ROI:** A few minutes to run `npx docs-index-keeper init` once. After that, you avoid repeated manual index edits and review back-and-forth every time someone adds a doc. The index becomes a reliable map of your docs without extra process.
+
+---
+
+## Quick start
+
+```bash
+# In your repo root (with a docs/ folder and docs/README.md index table)
+npm install -D docs-index-keeper
+npx docs-index-keeper init
+```
+
+Then, when you `git add docs/my-new-guide.md` and commit, the hook will run `docs-index-keeper update` and add the new row to `docs/README.md` (and stage it).
+
+---
+
+## Commands
+
+| Command | Purpose |
+|--------|---------|
+| `docs-index-keeper init` | Add a pre-commit hook (Husky or `.git/hooks/pre-commit`) that runs `update` and stages the index file |
+| `docs-index-keeper update` | Update the index from **staged** `.md` files (used by the hook) |
+| `docs-index-keeper check` | Dry run; exit 1 if the index would change (use in CI to require an up-to-date index) |
+| `docs-index-keeper add <path>` | Add a single file to the index (e.g. `docs-index-keeper add docs/runbook.md`) |
+
+---
+
+## Config
+
+Put config in `package.json` or in `.docs-index-keeper.json` at the repo root.
+
+**Example (package.json):**
+
+```json
+{
+  "docsIndexKeeper": {
+    "indexFile": "docs/README.md",
+    "docsDir": "docs",
+    "exclude": ["README.md", "archive/"],
+    "allowedRootMd": ["README.md", "AGENTS.md", "CONTRIBUTING.md"],
+    "warnRootMd": true
+  }
+}
+```
+
+- **indexFile** — Path to the Markdown file that contains the index table (default: `docs/README.md`).
+- **docsDir** — Directory treated as “docs” (default: `docs`).
+- **exclude** — Paths under `docsDir` that are not added (e.g. `README.md`, `archive/`).
+- **allowedRootMd** — Root-level `.md` files that do not trigger a warning when changed.
+- **warnRootMd** — If `true`, warn when new/changed `.md` in repo root (or `.github/`) are staged; suggests moving them to `docs/`.
+
+---
+
+## Index format
+
+The index file should contain a Markdown table with a header like `| Doc | Purpose |`. New rows are inserted before a “sentinel” row (e.g. `| [archive/](archive/) | … |`) or at the end of the table. The **title** for the link is taken from the filename; the **purpose** column uses the first `#` heading in the file, or a slugified filename.
+
+---
+
+## CI: require index up to date
+
+```yaml
+# .github/workflows/docs-index-check.yml
+- run: npm ci
+- run: npx docs-index-keeper check
+```
+
+Use `DOCS_INDEX_KEEPER_STAGED` to simulate staged files (e.g. in tests or CI):
+
+```bash
+DOCS_INDEX_KEEPER_STAGED="docs/foo.md" npx docs-index-keeper check
+```
+
+---
+
+## Releases (maintainers)
+
+**Publishing is done in CI/CD.** Push to `main` → CI runs tests, then [semantic-release](https://semantic-release.gitbook.io/) bumps the version (SemVer), publishes to npm, and creates a GitHub release when there are releasable commits.
+
+**One-shot: create repo, commit, push** (no local npm publish):
+
+```bash
+./publish.sh
+```
+
+Run from the package root. Requires `git`, `gh` (logged in), and `npm`. Overrides: `PROJECT_DIR`, `REUSE_REMOTE_REPO=true`, `COMMIT_MSG="..."`. After push, CI performs the npm publish.
+
+- **Versioning:** Use [Conventional Commits](https://www.conventionalcommits.org/): `feat:` → minor, `fix:` → patch, `BREAKING CHANGE:` (or `feat!:` / `fix!:`) → major.
+- **Secrets:** In the repo’s GitHub Settings → Secrets and variables → Actions, add **NPM_TOKEN** (npm token with **Read and write** for your packages). Paste the token with **no trailing newline or space**. Use `scripts/set-npm-token-secret.sh --from-browser` after creating a token at https://www.npmjs.com/settings/~/tokens (Granular). `GITHUB_TOKEN` is provided by Actions.
+
+**Publishing to GitHub Package Registry (instead of npm):** Use a scoped name in `package.json` (e.g. `@oleg-koval/docs-index-keeper`) and add `"publishConfig": { "registry": "https://npm.pkg.github.com" }`. In CI, set the secret to a GitHub PAT with `write:packages` and use it as `NPM_TOKEN` (semantic-release/npm uses `NPM_TOKEN` for any registry). Install from GitHub: `npm install @oleg-koval/docs-index-keeper` with `.npmrc`: `@oleg-koval:registry=https://npm.pkg.github.com`.
+
+**Package missing on npm?** CI can create a GitHub Release (tag + notes) while `npm publish` fails. If the package still doesn’t appear on npm: (1) In the release job logs, check for `npm error code EOTP` — then set your npm account 2FA to **“Authorization only”** at https://www.npmjs.com/settings/~/account and re-run the workflow. (2) Or publish the first version once from your machine: `npm run build && npm publish --access public` (you must be logged in and 2FA satisfied). After that, CI can publish subsequent versions.
+
+---
+
+## License
+
+MIT © [Oleg Koval](https://github.com/oleg-koval)

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,131 @@
+#!/usr/bin/env node
+import { existsSync, readFileSync, writeFileSync, chmodSync } from 'fs';
+import { join } from 'path';
+import { loadConfig } from './config.js';
+import { update, check, getFirstHeading, parseTable, insertRows } from './index.js';
+const root = process.cwd();
+function printHelp() {
+    console.log(`
+docs-index-keeper — Keep docs index in sync when new .md files are added
+
+Usage:
+  docs-index-keeper init     Add pre-commit hook (husky or plain git)
+  docs-index-keeper update   Update index from staged .md files (for pre-commit)
+  docs-index-keeper check   Dry run; exit 1 if index would change (for CI)
+  docs-index-keeper add <path>  Add a single file to the index
+
+Config: package.json "docsIndexKeeper" or .docs-index-keeper.json
+
+Examples:
+  npx docs-index-keeper init
+  DOCS_INDEX_KEEPER_STAGED="docs/foo.md" npx docs-index-keeper check
+`);
+}
+async function initAsync() {
+    const config = loadConfig(root);
+    const indexPath = config.indexFile;
+    const huskyPreCommit = `
+# When new/changed .md under docs/ are staged, add them to ${indexPath}
+staged_md=$(git diff --cached --name-only | grep '\\.md$' || true)
+if [ -n "$staged_md" ]; then
+  npx docs-index-keeper update
+  git add ${indexPath} 2>/dev/null || true
+fi
+`.trim();
+    const huskyDir = join(root, '.husky');
+    const huskyPreCommitPath = join(huskyDir, 'pre-commit');
+    if (existsSync(huskyDir)) {
+        writeFileSync(huskyPreCommitPath, huskyPreCommit);
+        console.log('[docs-index-keeper] Updated .husky/pre-commit');
+        return;
+    }
+    const gitHooks = join(root, '.git', 'hooks');
+    const preCommitPath = join(gitHooks, 'pre-commit');
+    if (existsSync(join(root, '.git'))) {
+        const content = `#!/bin/sh
+${huskyPreCommit}
+`;
+        writeFileSync(preCommitPath, content);
+        chmodSync(preCommitPath, 0o755);
+        console.log('[docs-index-keeper] Added .git/hooks/pre-commit');
+    }
+    else {
+        console.log('[docs-index-keeper] Not a git repo. Run "git init" first, or install husky and re-run init.');
+        console.log('  For husky: npm i -D husky && npx husky init');
+    }
+}
+async function main() {
+    const args = process.argv.slice(2);
+    const cmd = args[0];
+    if (!cmd || cmd === '--help' || cmd === '-h') {
+        printHelp();
+        process.exit(0);
+    }
+    const config = loadConfig(root);
+    switch (cmd) {
+        case 'init': {
+            await initAsync();
+            break;
+        }
+        case 'update': {
+            const result = update(root, config);
+            if (result.updated) {
+                console.log('[docs-index-keeper] Added to', config.indexFile + ':', result.added.map((r) => r.path).join(', '));
+            }
+            break;
+        }
+        case 'check': {
+            const ok = check(root, config);
+            if (!ok) {
+                console.error('[docs-index-keeper] Index is out of date. Stage new docs and run "docs-index-keeper update", or add them manually to', config.indexFile);
+                process.exit(1);
+            }
+            break;
+        }
+        case 'add': {
+            const pathArg = args[1];
+            if (!pathArg) {
+                console.error('[docs-index-keeper] add requires a path. Example: docs-index-keeper add docs/my-doc.md');
+                process.exit(1);
+            }
+            const indexPath = join(root, config.indexFile);
+            if (!existsSync(indexPath)) {
+                console.error('[docs-index-keeper] Index file not found:', config.indexFile);
+                process.exit(1);
+            }
+            const rel = pathArg.startsWith(config.docsDir + '/') ? pathArg.replace(new RegExp(`^${config.docsDir}/`), '') : pathArg;
+            if (config.exclude.some((e) => rel === e || rel.startsWith(e))) {
+                console.error('[docs-index-keeper] Path is excluded:', pathArg);
+                process.exit(1);
+            }
+            const fullPath = join(root, pathArg);
+            if (!existsSync(fullPath)) {
+                console.error('[docs-index-keeper] File not found:', pathArg);
+                process.exit(1);
+            }
+            let readme = readFileSync(indexPath, 'utf-8');
+            const existing = parseTable(readme);
+            const existingPaths = new Set(existing.map((r) => r.path));
+            if (existingPaths.has(rel)) {
+                console.log('[docs-index-keeper] Already in index:', rel);
+                break;
+            }
+            const title = rel.replace(/\.md$/, '');
+            const purpose = getFirstHeading(root, pathArg) || title.replace(/-/g, ' ');
+            const toAdd = [{ path: rel, title, purpose }];
+            readme = insertRows(readme, toAdd);
+            writeFileSync(indexPath, readme);
+            console.log('[docs-index-keeper] Added to', config.indexFile + ':', rel);
+            break;
+        }
+        default:
+            console.error('[docs-index-keeper] Unknown command:', cmd);
+            printHelp();
+            process.exit(1);
+    }
+}
+main().catch((err) => {
+    console.error('[docs-index-keeper]', err);
+    process.exit(1);
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,IAAI,CAAA;AACvE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAEnF,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;AAE1B,SAAS,SAAS;IAChB,OAAO,CAAC,GAAG,CAAC;;;;;;;;;;;;;;CAcb,CAAC,CAAA;AACF,CAAC;AAED,KAAK,UAAU,SAAS;IACtB,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;IAC/B,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAA;IAClC,MAAM,cAAc,GAAG;6DACoC,SAAS;;;;YAI1D,SAAS;;CAEpB,CAAC,IAAI,EAAE,CAAA;IAEN,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IACrC,MAAM,kBAAkB,GAAG,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAA;IAEvD,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzB,aAAa,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAA;QACjD,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAA;QAC5D,OAAM;IACR,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;IAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAA;IAClD,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG;EAClB,cAAc;CACf,CAAA;QACG,aAAa,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;QACrC,SAAS,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;QAC/B,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAA;IAChE,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,6FAA6F,CAAC,CAAA;QAC1G,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAA;IAC9D,CAAC;AACH,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAClC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;IAEnB,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC7C,SAAS,EAAE,CAAA;QACX,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;IAE/B,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,MAAM,SAAS,EAAE,CAAA;YACjB,MAAK;QACP,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YACnC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,MAAM,CAAC,SAAS,GAAG,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;YACjH,CAAC;YACD,MAAK;QACP,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YAC9B,IAAI,CAAC,EAAE,EAAE,CAAC;gBACR,OAAO,CAAC,KAAK,CAAC,sHAAsH,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;gBACvJ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC;YACD,MAAK;QACP,CAAC;QACD,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;YACvB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,wFAAwF,CAAC,CAAA;gBACvG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC;YACD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;YAC9C,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3B,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;gBAC5E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC;YACD,MAAM,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;YACvH,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC/D,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,OAAO,CAAC,CAAA;gBAC/D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC;YACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YACpC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1B,OAAO,CAAC,KAAK,CAAC,qCAAqC,EAAE,OAAO,CAAC,CAAA;gBAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC;YACD,IAAI,MAAM,GAAG,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;YAC7C,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;YACnC,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;YAC1D,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3B,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE,GAAG,CAAC,CAAA;gBACzD,MAAK;YACP,CAAC;YACD,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;YACtC,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YAC1E,MAAM,KAAK,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;YAC7C,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;YAClC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;YAChC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,MAAM,CAAC,SAAS,GAAG,GAAG,EAAE,GAAG,CAAC,CAAA;YACxE,MAAK;QACP,CAAC;QACD;YACE,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAA;YAC1D,SAAS,EAAE,CAAA;YACX,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACnB,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAA;IACzC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC,CAAC,CAAA"}

package/dist/config.d.ts

@@ -0,0 +1,9 @@
+export interface DocsIndexKeeperConfig {
+    indexFile: string;
+    docsDir: string;
+    exclude: string[];
+    allowedRootMd: string[];
+    warnRootMd: boolean;
+}
+export declare function loadConfig(root: string): DocsIndexKeeperConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,UAAU,EAAE,OAAO,CAAA;CACpB;AAUD,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CA4B9D"}

package/dist/config.js

@@ -0,0 +1,39 @@
+import { readFileSync, existsSync } from 'fs';
+import { join } from 'path';
+const DEFAULT = {
+    indexFile: 'docs/README.md',
+    docsDir: 'docs',
+    exclude: ['README.md', 'archive/'],
+    allowedRootMd: ['README.md', 'AGENTS.md', 'CONTRIBUTING.md', 'RENDER_DEPLOY.md', 'ENV_CHECKLIST.md', 'MIGRATION.md'],
+    warnRootMd: true,
+};
+export function loadConfig(root) {
+    const pkgPath = join(root, 'package.json');
+    if (existsSync(pkgPath)) {
+        try {
+            const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+            const cfg = pkg.docsIndexKeeper;
+            if (cfg && typeof cfg === 'object') {
+                return { ...DEFAULT, ...cfg };
+            }
+        }
+        catch {
+            // fall through to defaults
+        }
+    }
+    const rcPaths = ['.docs-index-keeper.json', '.docsindexkeeperrc.json'];
+    for (const rc of rcPaths) {
+        const p = join(root, rc);
+        if (existsSync(p)) {
+            try {
+                const cfg = JSON.parse(readFileSync(p, 'utf-8'));
+                return { ...DEFAULT, ...cfg };
+            }
+            catch {
+                break;
+            }
+        }
+    }
+    return { ...DEFAULT };
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,IAAI,CAAA;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAU3B,MAAM,OAAO,GAA0B;IACrC,SAAS,EAAE,gBAAgB;IAC3B,OAAO,EAAE,MAAM;IACf,OAAO,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC;IAClC,aAAa,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,cAAc,CAAC;IACpH,UAAU,EAAE,IAAI;CACjB,CAAA;AAED,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;IAC1C,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAA4B,CAAA;YACjF,MAAM,GAAG,GAAG,GAAG,CAAC,eAA6D,CAAA;YAC7E,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBACnC,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,EAAE,CAAA;YAC/B,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,2BAA2B;QAC7B,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,yBAAyB,EAAE,yBAAyB,CAAC,CAAA;IACtE,KAAK,MAAM,EAAE,IAAI,OAAO,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACxB,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;YAClB,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,OAAO,CAAC,CAAmC,CAAA;gBAClF,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,EAAE,CAAA;YAC/B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAK;YACP,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,EAAE,GAAG,OAAO,EAAE,CAAA;AACvB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import type { DocsIndexKeeperConfig } from './config.js';
+export interface IndexRow {
+    title: string;
+    path: string;
+    purpose?: string;
+}
+export declare function getStagedMdFiles(stagedOverride?: string): string[];
+export declare function getStagedDocs(staged: string[], config: DocsIndexKeeperConfig): string[];
+export declare function getFirstHeading(root: string, filePath: string): string | null;
+export declare function parseTable(readmeContent: string): IndexRow[];
+export declare function warnRootMd(staged: string[], config: DocsIndexKeeperConfig): void;
+export declare function computeNewRows(root: string, stagedDocs: string[], existingPaths: Set<string>, config: DocsIndexKeeperConfig): IndexRow[];
+export declare function insertRows(readme: string, newRows: IndexRow[], sentinelPattern?: string): string;
+export interface UpdateResult {
+    updated: boolean;
+    added: IndexRow[];
+}
+export declare function update(root: string, config: DocsIndexKeeperConfig, stagedOverride?: string): UpdateResult;
+export declare function check(root: string, config: DocsIndexKeeperConfig, stagedOverride?: string): boolean;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAExD,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,wBAAgB,gBAAgB,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAclE;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,qBAAqB,GAAG,MAAM,EAAE,CAQvF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAM7E;AAED,wBAAgB,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,QAAQ,EAAE,CAc5D;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAchF;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAAE,EACpB,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,EAC1B,MAAM,EAAE,qBAAqB,GAC5B,QAAQ,EAAE,CAYZ;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,eAAe,SAAiB,GAAG,MAAM,CAMxG;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,QAAQ,EAAE,CAAA;CAClB;AAED,wBAAgB,MAAM,CACpB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,qBAAqB,EAC7B,cAAc,CAAC,EAAE,MAAM,GACtB,YAAY,CAsBd;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAenG"}

package/dist/index.js

@@ -0,0 +1,127 @@
+import { execSync } from 'child_process';
+import { readFileSync, writeFileSync, existsSync } from 'fs';
+import { join } from 'path';
+export function getStagedMdFiles(stagedOverride) {
+    const envOverride = process.env.DOCS_INDEX_KEEPER_STAGED;
+    if (stagedOverride ?? envOverride) {
+        const raw = (stagedOverride ?? envOverride);
+        return raw
+            .split('\n')
+            .map((s) => s.trim())
+            .filter((s) => s.endsWith('.md'));
+    }
+    const out = execSync('git diff --cached --name-only', { encoding: 'utf-8' });
+    return out
+        .split('\n')
+        .map((s) => s.trim())
+        .filter((s) => s.endsWith('.md'));
+}
+export function getStagedDocs(staged, config) {
+    const docsPrefix = config.docsDir + '/';
+    return staged.filter((p) => {
+        if (!p.startsWith(docsPrefix))
+            return false;
+        const rel = p.slice(docsPrefix.length);
+        if (config.exclude.some((e) => rel === e || rel.startsWith(e)))
+            return false;
+        return true;
+    });
+}
+export function getFirstHeading(root, filePath) {
+    const full = join(root, filePath);
+    if (!existsSync(full))
+        return null;
+    const content = readFileSync(full, 'utf-8');
+    const match = content.match(/^#+\s+(.+)$/m);
+    return match ? match[1].trim() : null;
+}
+export function parseTable(readmeContent) {
+    const lines = readmeContent.split('\n');
+    const rows = [];
+    let inTable = false;
+    for (const line of lines) {
+        if (line.startsWith('|') && line.includes('|')) {
+            inTable = true;
+            const linkMatch = line.match(/\|\s*\[([^\]]+)\]\(([^)]+)\)\s*\|/);
+            if (linkMatch)
+                rows.push({ title: linkMatch[1], path: linkMatch[2] });
+        }
+        else if (inTable && !line.trim().startsWith('|')) {
+            break;
+        }
+    }
+    return rows;
+}
+export function warnRootMd(staged, config) {
+    if (!config.warnRootMd)
+        return;
+    const rootMd = staged.filter((p) => !p.includes('/') || p.startsWith('.github/'));
+    const inRoot = rootMd.filter((p) => {
+        const base = p.replace(/^.*\//, '');
+        return !config.allowedRootMd.includes(base);
+    });
+    if (inRoot.length) {
+        console.warn('[docs-index-keeper] New/changed .md in root or .github:', inRoot.join(', '), '\nConsider moving to docs/ and they will be added to the index.');
+    }
+}
+export function computeNewRows(root, stagedDocs, existingPaths, config) {
+    const toAdd = [];
+    for (const p of stagedDocs) {
+        const path = p.replace(new RegExp(`^${config.docsDir}/`), '');
+        if (existingPaths.has(path))
+            continue;
+        const titleFromPath = path.replace(/\.md$/, '').replace(/-/g, ' ');
+        const purpose = getFirstHeading(root, p) || titleFromPath;
+        const title = path.replace(/\.md$/, '');
+        toAdd.push({ path, title, purpose });
+        existingPaths.add(path);
+    }
+    return toAdd;
+}
+export function insertRows(readme, newRows, sentinelPattern = '| [archive/]') {
+    const newLines = newRows.map(({ path, title, purpose }) => `| [${title}](${path}) | ${purpose ?? title} |`);
+    let insertIdx = readme.indexOf(sentinelPattern);
+    if (insertIdx === -1)
+        insertIdx = readme.indexOf('\n\n', readme.indexOf('| Doc | Purpose |'));
+    if (insertIdx === -1)
+        insertIdx = readme.length;
+    return readme.slice(0, insertIdx) + newLines.join('\n') + '\n' + readme.slice(insertIdx);
+}
+export function update(root, config, stagedOverride) {
+    const indexPath = join(root, config.indexFile);
+    const staged = getStagedMdFiles(stagedOverride);
+    if (!staged.length)
+        return { updated: false, added: [] };
+    warnRootMd(staged, config);
+    const stagedDocs = getStagedDocs(staged, config);
+    if (!stagedDocs.length)
+        return { updated: false, added: [] };
+    if (!existsSync(indexPath))
+        return { updated: false, added: [] };
+    let readme = readFileSync(indexPath, 'utf-8');
+    const existing = parseTable(readme);
+    const existingPaths = new Set(existing.map((r) => r.path));
+    const toAdd = computeNewRows(root, stagedDocs, existingPaths, config);
+    if (!toAdd.length)
+        return { updated: false, added: [] };
+    readme = insertRows(readme, toAdd);
+    writeFileSync(indexPath, readme);
+    return { updated: true, added: toAdd };
+}
+export function check(root, config, stagedOverride) {
+    const indexPath = join(root, config.indexFile);
+    const staged = getStagedMdFiles(stagedOverride);
+    const stagedDocs = getStagedDocs(staged, config);
+    if (!stagedDocs.length || !existsSync(indexPath))
+        return true;
+    const readme = readFileSync(indexPath, 'utf-8');
+    const existing = parseTable(readme);
+    const existingPaths = new Set(existing.map((r) => r.path));
+    for (const p of stagedDocs) {
+        const path = p.replace(new RegExp(`^${config.docsDir}/`), '');
+        if (!existingPaths.has(path))
+            return false;
+    }
+    return true;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,IAAI,CAAA;AAC5D,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAS3B,MAAM,UAAU,gBAAgB,CAAC,cAAuB;IACtD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAA;IACxD,IAAI,cAAc,IAAI,WAAW,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,CAAC,cAAc,IAAI,WAAW,CAAE,CAAA;QAC5C,OAAO,GAAG;aACP,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;IACrC,CAAC;IACD,MAAM,GAAG,GAAG,QAAQ,CAAC,+BAA+B,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAA;IAC5E,OAAO,GAAG;SACP,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;AACrC,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAgB,EAAE,MAA6B;IAC3E,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,GAAG,GAAG,CAAA;IACvC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QACzB,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;YAAE,OAAO,KAAK,CAAA;QAC3C,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACtC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAA;QAC5E,OAAO,IAAI,CAAA;IACb,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,QAAgB;IAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IACjC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAA;IAClC,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IAC3C,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACvC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,aAAqB;IAC9C,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACvC,MAAM,IAAI,GAAe,EAAE,CAAA;IAC3B,IAAI,OAAO,GAAG,KAAK,CAAA;IACnB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/C,OAAO,GAAG,IAAI,CAAA;YACd,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAA;YACjE,IAAI,SAAS;gBAAE,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;QACvE,CAAC;aAAM,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACnD,MAAK;QACP,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAgB,EAAE,MAA6B;IACxE,IAAI,CAAC,MAAM,CAAC,UAAU;QAAE,OAAM;IAC9B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAA;IACjF,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QACjC,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QACnC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;IACF,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,CAAC,IAAI,CACV,yDAAyD,EACzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EACjB,iEAAiE,CAClE,CAAA;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,IAAY,EACZ,UAAoB,EACpB,aAA0B,EAC1B,MAA6B;IAE7B,MAAM,KAAK,GAAe,EAAE,CAAA;IAC5B,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;QAC7D,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,SAAQ;QACrC,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QAClE,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,aAAa,CAAA;QACzD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QACvC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;QACpC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAc,EAAE,OAAmB,EAAE,eAAe,GAAG,cAAc;IAC9F,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,MAAM,KAAK,KAAK,IAAI,OAAO,OAAO,IAAI,KAAK,IAAI,CAAC,CAAA;IAC3G,IAAI,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;IAC/C,IAAI,SAAS,KAAK,CAAC,CAAC;QAAE,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAA;IAC7F,IAAI,SAAS,KAAK,CAAC,CAAC;QAAE,SAAS,GAAG,MAAM,CAAC,MAAM,CAAA;IAC/C,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;AAC1F,CAAC;AAOD,MAAM,UAAU,MAAM,CACpB,IAAY,EACZ,MAA6B,EAC7B,cAAuB;IAEvB,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;IAC9C,MAAM,MAAM,GAAG,gBAAgB,CAAC,cAAc,CAAC,CAAA;IAC/C,IAAI,CAAC,MAAM,CAAC,MAAM;QAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;IAExD,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE1B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChD,IAAI,CAAC,UAAU,CAAC,MAAM;QAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;IAE5D,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;IAEhE,IAAI,MAAM,GAAG,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IAC7C,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IACnC,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;IAE1D,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,CAAC,CAAA;IACrE,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;IAEvD,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAClC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IAChC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAA;AACxC,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,IAAY,EAAE,MAA6B,EAAE,cAAuB;IACxF,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;IAC9C,MAAM,MAAM,GAAG,gBAAgB,CAAC,cAAc,CAAC,CAAA;IAC/C,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChD,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QAAE,OAAO,IAAI,CAAA;IAE7D,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IAC/C,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IACnC,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;IAE1D,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;QAC7D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAA;IAC5C,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "docs-index-keeper",
+  "version": "1.0.0",
+  "description": "Keep your docs/README.md index in sync automatically. When you add or change Markdown files under docs/, a pre-commit hook or CI step updates the index table—no manual edits, no forgotten entries.",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "docs-index-keeper": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test": "vitest run",
+    "lint": "eslint src --ext .ts",
+    "check": "npm run build && npm run test"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "docs",
+    "documentation",
+    "markdown",
+    "index",
+    "readme",
+    "pre-commit",
+    "husky",
+    "git-hooks",
+    "cli",
+    "automation",
+    "docs-index",
+    "doc-index",
+    "runbook",
+    "knowledge-base"
+  ],
+  "license": "MIT",
+  "author": "Oleg Koval <oleg-koval@users.noreply.github.com> (https://github.com/oleg-koval)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/oleg-koval/docs-index-keeper.git"
+  },
+  "homepage": "https://github.com/oleg-koval/docs-index-keeper#readme",
+  "bugs": {
+    "url": "https://github.com/oleg-koval/docs-index-keeper/issues"
+  },
+  "release": {
+    "branches": ["main"],
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ]
+  },
+  "devDependencies": {
+    "@semantic-release/github": "^11.0.0",
+    "@semantic-release/npm": "^12.0.0",
+    "@types/node": "^22.10.0",
+    "eslint": "^9.16.0",
+    "semantic-release": "^24.0.0",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.6"
+  }
+}