Skip to content

Commit 1b19429

Browse files
jonathanMLDevzho
andauthored
addressed coverage and docs issues (#98)
* addressed coverage and docs issues * added baseline.json * addressed ai reviews * rename CppDigest as cppalliance * addressed first human review results --------- Co-authored-by: zho <jornathanm910923@gmail.com>
1 parent c8f35db commit 1b19429

21 files changed

Lines changed: 960 additions & 54 deletions

.github/workflows/ci.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,6 @@ jobs:
8484

8585
- name: Package dry run
8686
run: npm pack --dry-run
87+
88+
- name: Verify internal markdown links
89+
run: npm run docs:link-check

.markdown-link-check.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "^https?://"
5+
},
6+
{
7+
"pattern": "^mailto:"
8+
}
9+
],
10+
"retryOn429": true,
11+
"retryCount": 2,
12+
"aliveStatusCodes": [200, 206, 403]
13+
}

CHANGELOG.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ Tagged releases are published to npm from GitHub Actions when a **GitHub Release
2121
- `--version` CLI flag prints the package version and exits.
2222
- `list_namespaces` response now includes `expires_at_iso` so clients see the cache expiry as an ISO-8601 timestamp without converting `cache_ttl_seconds`.
2323
- `examples/README.md` describing the library embedding sample.
24-
- GitHub Actions **CI** matrix across **ubuntu-latest**, **windows-latest**, and **macos-latest**, each with **Node.js** **20.x** and **22.x**: typecheck, lint, Prettier, build, `test:coverage`, **CycloneDX** SBOM artifact upload (per job), **Codecov** upload (**Ubuntu** + Node **20.x** only), plus a separate **quality** job (`npm audit`, `npm pack --dry-run`).
25-
- `npm run test:coverage` with Vitest coverage thresholds (see `vitest.config.ts`).
24+
- GitHub Actions **CI** matrix across **ubuntu-latest**, **windows-latest**, and **macos-latest**, each with **Node.js** **20.x** and **22.x**: typecheck, lint, Prettier, build, `test:coverage`, **CycloneDX** SBOM artifact upload (per job), **Codecov** upload (**Ubuntu** + Node **20.x** only), plus a separate **quality** job (`npm audit`, `npm pack --dry-run`, **markdown-link-check** on README/CHANGELOG/docs).
25+
- Vitest **global** coverage thresholds in `vitest.config.ts` (lines 73%, statements 72%, branches 58%, functions 76% — measured baseline minus slack); `npm run test:coverage` exits non-zero when any bucket regresses.
2626
- `@vitest/coverage-v8` devDependency for coverage reports (`lcov`, `json-summary`, HTML).
27+
- `docs/` reference set (TOOLS, CONFIGURATION, SECURITY, CONTRIBUTING, CI_CD, FAQ, MIGRATION, RELEASING) and worked examples `examples/suggest-flow-demo.ts`, `examples/guided-query-demo.ts`, `examples/library-embedding-demo.ts`.
2728

2829
### Changed
2930

@@ -40,7 +41,7 @@ Tagged releases are published to npm from GitHub Actions when a **GitHub Release
4041
- `.env.example` log-level options corrected to the four levels actually supported (`DEBUG`, `INFO`, `WARN`, `ERROR`); the stale `WARNING`/`CRITICAL` values are gone.
4142
- README Slack URL example now matches the generator output (`https://app.slack.com/client/{team_id}/{channel_id}/p{messageId}`).
4243
- README "Comparison with Python Version" no longer claims an identical API; the new TypeScript-only tools (`guided_query`, `query_documents`, `keyword_search`, `namespace_router`, `suggest_query_params`, `count`, `generate_urls`) are listed explicitly.
43-
- `npm run ci` now runs `test:coverage` so merges are gated on coverage thresholds.
44+
- CI **quality** job: `npm run docs:link-check` runs `markdown-link-check` in a single `npx` invocation over `README.md`, `CHANGELOG.md`, and all `docs/**/*.md` (via `scripts/docs-link-check.mjs`) instead of one `npx` per file under `docs/`.
4445
- **Breaking (runtime / tooling):** `engines.node` is now **>=20.12.0**. Vitest **4** (bundled **rolldown**) imports `util.styleText` from `node:util` (added in Node **20.12**), and **`@vitest/coverage-v8`** uses `node:inspector/promises` (Node **≥19**). CI tests only **20.x** and **22.x**.
4546
- Dependabot groups related **vitest**, **typescript-eslint**, and **eslint/prettier** updates.
4647

@@ -89,7 +90,7 @@ details. Newer shipped changes are recorded in this changelog by version.
8990
- Environment variable support
9091
- Full documentation and examples
9192

92-
[Unreleased]: https://github.com/CppDigest/pinecone-read-only-mcp-typescript/compare/v0.1.6...HEAD
93-
[0.1.6]: https://github.com/CppDigest/pinecone-read-only-mcp-typescript/compare/v0.1.1...v0.1.6
94-
[0.1.1]: https://github.com/CppDigest/pinecone-read-only-mcp-typescript/compare/v0.1.0...v0.1.1
95-
[0.1.0]: https://github.com/CppDigest/pinecone-read-only-mcp-typescript/releases/tag/v0.1.0
93+
[Unreleased]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.1.6...HEAD
94+
[0.1.6]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.1.1...v0.1.6
95+
[0.1.1]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/compare/v0.1.0...v0.1.1
96+
[0.1.0]: https://github.com/cppalliance/pinecone-read-only-mcp-typescript/releases/tag/v0.1.0

0 commit comments

Comments
 (0)