From 7568b3dd7de877efc85bf41a96342820c2fded9c Mon Sep 17 00:00:00 2001 From: "m.osumi" Date: Thu, 1 Jan 2026 17:04:13 +0900 Subject: [PATCH 1/7] chore: rename package from @cawpea/coderef to docs-coderef MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Changes: - Package name: @cawpea/coderef → docs-coderef (remove scope) - CLI command: coderef → docs-coderef - Config file: .coderefrc.json → .docs-coderefrc.json - package.json field: "coderef" → "docs-coderef" - Environment variables: CODEREF_* → DOCS_CODEREF_* - Binary: bin/coderef.js → bin/docs-coderef.js - Repository URLs updated to cawpea/docs-coderef 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 --- CHANGELOG.md | 65 +++++++++++++++++------------ CLAUDE.md | 2 +- README.md | 20 ++++----- bin/{coderef.js => docs-coderef.js} | 4 +- docs/README.md | 2 +- docs/development/documentation.md | 2 +- docs/development/release.md | 22 +++++----- docs/user-guide/cli-usage.md | 24 +++++------ docs/user-guide/code-ref-syntax.md | 4 +- docs/user-guide/configuration.md | 22 +++++----- docs/user-guide/installation.md | 6 +-- package-lock.json | 6 +-- package.json | 10 ++--- src/cli/validate.ts | 8 ++-- src/config.test.ts | 50 +++++++++++----------- src/config.ts | 40 +++++++++--------- src/index.ts | 6 +-- 17 files changed, 152 insertions(+), 141 deletions(-) rename bin/{coderef.js => docs-coderef.js} (95%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 83ab30c..fd7ec72 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,25 +5,36 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -# [1.0.0](https://github.com/cawpea/coderef/compare/v0.1.0...v1.0.0) (2026-01-01) +## [Unreleased] + +### Changed + +- **Package rename**: Changed package name from `@cawpea/coderef` to `docs-coderef` (removed scope) +- **CLI command**: Changed from `coderef` to `docs-coderef` +- **Config file**: Renamed from `.docs-coderefrc.json` to `.docs-coderefrc.json` +- **package.json field**: Changed from `"coderef"` to `"docs-coderef"` +- **Environment variables**: Changed from `CODEREF_*` to `DOCS_CODEREF_*` +- **Repository**: Renamed from `cawpea/coderef` to `cawpea/docs-coderef` + +# [1.0.0](https://github.com/cawpea/docs-coderef/compare/v0.1.0...v1.0.0) (2026-01-01) ### Bug Fixes -* exclude CODE_REF comments in unclosed code blocks from validation ([f1f5287](https://github.com/cawpea/coderef/commit/f1f52879dbed2d8ffaaf29fdba959e401fc81d2a)) -* handle variable-length backtick sequences in code blocks ([b5674ad](https://github.com/cawpea/coderef/commit/b5674add6060fbb429190ca97a02526ae16c31f2)) +* exclude CODE_REF comments in unclosed code blocks from validation ([f1f5287](https://github.com/cawpea/docs-coderef/commit/f1f52879dbed2d8ffaaf29fdba959e401fc81d2a)) +* handle variable-length backtick sequences in code blocks ([b5674ad](https://github.com/cawpea/docs-coderef/commit/b5674add6060fbb429190ca97a02526ae16c31f2)) ### Features -* remove default .docsignore value from configuration ([67967d3](https://github.com/cawpea/coderef/commit/67967d3adccb5709ea8bfc2e357d8ff685831e12)) +* remove default .docsignore value from configuration ([67967d3](https://github.com/cawpea/docs-coderef/commit/67967d3adccb5709ea8bfc2e357d8ff685831e12)) ### BREAKING CHANGES * The `ignoreFile` configuration no longer defaults to '.docsignore'. To continue using .docsignore, explicitly set `ignoreFile: '.docsignore'` in your -configuration file (.coderefrc.json or package.json). +configuration file (.docs-coderefrc.json or package.json). This change makes the ignore file behavior explicit rather than implicit, applying ignore patterns only when intentionally configured. All documentation examples now @@ -38,31 +49,31 @@ Co-Authored-By: Claude Sonnet 4.5 ### Bug Fixes -* add npm rebuild step to resolve rollup native binary issue in CI ([4ec06ad](https://github.com/cawpea/coderef/commit/4ec06add097033d7aa6aa531e08c8e09c693b599)) -* add pull-requests write permission to claude-code-review workflow ([be5b41d](https://github.com/cawpea/coderef/commit/be5b41d41015aa05697099625ad484e441ba2ffe)) -* add rollup as explicit devDependency to resolve CI build issue ([01061e5](https://github.com/cawpea/coderef/commit/01061e519ab3f80d884810738e4396d3c47d2f53)) -* clear npm cache to resolve rollup native binary issue in CI ([0cd15bd](https://github.com/cawpea/coderef/commit/0cd15bd142aec85303469c8d917955711f4121c6)) -* correct collectCoverageFrom pattern order in Jest config ([dbac613](https://github.com/cawpea/coderef/commit/dbac61383fe0e4dbe6d3654c22615b0bab8235b3)) -* prevent command injection in git-diff by using spawnSync ([105a9c2](https://github.com/cawpea/coderef/commit/105a9c263a5ade19d138a0d5ec020619b62e824e)) -* reinstall rollup to ensure native binaries are installed in CI ([389e7af](https://github.com/cawpea/coderef/commit/389e7afaa7792b0eadf75fa9bef8e1fe0f708360)) -* run npm install after npm ci to fix rollup native binary issue ([2816913](https://github.com/cawpea/coderef/commit/2816913af1d10e445b2942ecf1044f39e40f25ff)) -* translate remaining japanese character to english in src/utils/fix.ts ([68c57ba](https://github.com/cawpea/coderef/commit/68c57babfdd5ee847af57d29b47ac28168e456cf)) -* update project root to use config ([97724b3](https://github.com/cawpea/coderef/commit/97724b3467d61b67917a0c8c4446dd8485482960)) +* add npm rebuild step to resolve rollup native binary issue in CI ([4ec06ad](https://github.com/cawpea/docs-coderef/commit/4ec06add097033d7aa6aa531e08c8e09c693b599)) +* add pull-requests write permission to claude-code-review workflow ([be5b41d](https://github.com/cawpea/docs-coderef/commit/be5b41d41015aa05697099625ad484e441ba2ffe)) +* add rollup as explicit devDependency to resolve CI build issue ([01061e5](https://github.com/cawpea/docs-coderef/commit/01061e519ab3f80d884810738e4396d3c47d2f53)) +* clear npm cache to resolve rollup native binary issue in CI ([0cd15bd](https://github.com/cawpea/docs-coderef/commit/0cd15bd142aec85303469c8d917955711f4121c6)) +* correct collectCoverageFrom pattern order in Jest config ([dbac613](https://github.com/cawpea/docs-coderef/commit/dbac61383fe0e4dbe6d3654c22615b0bab8235b3)) +* prevent command injection in git-diff by using spawnSync ([105a9c2](https://github.com/cawpea/docs-coderef/commit/105a9c263a5ade19d138a0d5ec020619b62e824e)) +* reinstall rollup to ensure native binaries are installed in CI ([389e7af](https://github.com/cawpea/docs-coderef/commit/389e7afaa7792b0eadf75fa9bef8e1fe0f708360)) +* run npm install after npm ci to fix rollup native binary issue ([2816913](https://github.com/cawpea/docs-coderef/commit/2816913af1d10e445b2942ecf1044f39e40f25ff)) +* translate remaining japanese character to english in src/utils/fix.ts ([68c57ba](https://github.com/cawpea/docs-coderef/commit/68c57babfdd5ee847af57d29b47ac28168e456cf)) +* update project root to use config ([97724b3](https://github.com/cawpea/docs-coderef/commit/97724b3467d61b67917a0c8c4446dd8485482960)) ### Features -* add ESLint configuration for scripts directory ([236ad04](https://github.com/cawpea/coderef/commit/236ad042620d3b6ad9af2f2c57469e4e95f52f5d)) -* add variable reference support in CODE_REF ([d098259](https://github.com/cawpea/coderef/commit/d098259dcecf185e0743baddd0dccc4b960ea471)) -* implement CLI with commander and programmatic API ([3ec29f8](https://github.com/cawpea/coderef/commit/3ec29f8b18f6128e85723df6315a76ed52baacf1)) -* implement configuration system ([43bf006](https://github.com/cawpea/coderef/commit/43bf006df05e2fbf31301ed081c9807a5b3c2a60)) -* integrate configuration system into fix.ts ([6192ccd](https://github.com/cawpea/coderef/commit/6192ccdeec20c3b783b606c0de779463fad56066)) -* integrate configuration system into validate.ts ([b6638ef](https://github.com/cawpea/coderef/commit/b6638ef47b0c9f7019f8271776d01e041cda3969)) -* migrate core logic and utils from figma-a11y-reviewer ([19efe8c](https://github.com/cawpea/coderef/commit/19efe8caafc4396054ab4d37ebe79d25a9c21846)) -* translate comments and logs to english in src/cli/fix.ts ([f4cd0b8](https://github.com/cawpea/coderef/commit/f4cd0b89f12056a3139dfbe50bc6ff1ec9825e05)) -* translate comments and messages to english in src/core/validate.ts and tests ([79f609e](https://github.com/cawpea/coderef/commit/79f609e0bc22eab31bbe38a69d01e1a54e7e099b)) -* translate comments and messages to english in src/utils/fix.ts and tests ([7b2dafb](https://github.com/cawpea/coderef/commit/7b2dafb44a5f0cd3c0ae3f94640de7447d432339)) -* translate japanese logs and comments to english ([4a20066](https://github.com/cawpea/coderef/commit/4a20066692f73e453cf806ed0d2dc2ed097bf9cd)) +* add ESLint configuration for scripts directory ([236ad04](https://github.com/cawpea/docs-coderef/commit/236ad042620d3b6ad9af2f2c57469e4e95f52f5d)) +* add variable reference support in CODE_REF ([d098259](https://github.com/cawpea/docs-coderef/commit/d098259dcecf185e0743baddd0dccc4b960ea471)) +* implement CLI with commander and programmatic API ([3ec29f8](https://github.com/cawpea/docs-coderef/commit/3ec29f8b18f6128e85723df6315a76ed52baacf1)) +* implement configuration system ([43bf006](https://github.com/cawpea/docs-coderef/commit/43bf006df05e2fbf31301ed081c9807a5b3c2a60)) +* integrate configuration system into fix.ts ([6192ccd](https://github.com/cawpea/docs-coderef/commit/6192ccdeec20c3b783b606c0de779463fad56066)) +* integrate configuration system into validate.ts ([b6638ef](https://github.com/cawpea/docs-coderef/commit/b6638ef47b0c9f7019f8271776d01e041cda3969)) +* migrate core logic and utils from figma-a11y-reviewer ([19efe8c](https://github.com/cawpea/docs-coderef/commit/19efe8caafc4396054ab4d37ebe79d25a9c21846)) +* translate comments and logs to english in src/cli/fix.ts ([f4cd0b8](https://github.com/cawpea/docs-coderef/commit/f4cd0b89f12056a3139dfbe50bc6ff1ec9825e05)) +* translate comments and messages to english in src/core/validate.ts and tests ([79f609e](https://github.com/cawpea/docs-coderef/commit/79f609e0bc22eab31bbe38a69d01e1a54e7e099b)) +* translate comments and messages to english in src/utils/fix.ts and tests ([7b2dafb](https://github.com/cawpea/docs-coderef/commit/7b2dafb44a5f0cd3c0ae3f94640de7447d432339)) +* translate japanese logs and comments to english ([4a20066](https://github.com/cawpea/docs-coderef/commit/4a20066692f73e453cf806ed0d2dc2ed097bf9cd)) ## [Unreleased] @@ -72,4 +83,4 @@ Co-Authored-By: Claude Sonnet 4.5 - Basic directory structure - Configuration files (package.json, tsconfig.json, jest.config.js) -[unreleased]: https://github.com/cawpea/coderef/compare/v0.1.0...HEAD +[unreleased]: https://github.com/cawpea/docs-coderef/compare/v0.1.0...HEAD diff --git a/CLAUDE.md b/CLAUDE.md index af6ac37..5f1face 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co ## Project Overview -`@cawpea/coderef` is a tool for validating and auto-fixing code references in markdown documentation. It ensures code snippets in documentation stay synchronized with actual source code through CODE_REF comments and AST-based symbol searching. +`docs-coderef` is a tool for validating and auto-fixing code references in markdown documentation. It ensures code snippets in documentation stay synchronized with actual source code through CODE_REF comments and AST-based symbol searching. ## Quick Reference diff --git a/README.md b/README.md index 07104d3..45882d5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# @cawpea/coderef +# docs-coderef > Validate and fix code references in markdown documentation @@ -8,7 +8,7 @@ ## Overview -`@cawpea/coderef` is a tool to validate and automatically fix code references in markdown documentation. It ensures that code snippets in your documentation stay in sync with your actual source code. +`docs-coderef` is a tool to validate and automatically fix code references in markdown documentation. It ensures that code snippets in your documentation stay in sync with your actual source code. ## Features @@ -22,7 +22,7 @@ ## Installation ```bash -npm install --save-dev @cawpea/coderef +npm install --save-dev docs-coderef ``` ## Quick Start @@ -31,19 +31,19 @@ npm install --save-dev @cawpea/coderef ```bash # Validate all CODE_REF references -npx coderef validate +npx docs-coderef validate # Fix errors interactively -npx coderef fix +npx docs-coderef fix # Auto-fix without prompts -npx coderef fix --auto +npx docs-coderef fix --auto ``` ### Programmatic Usage ```typescript -import { validate, fix } from '@cawpea/coderef'; +import { validate, fix } from 'docs-coderef'; // Validate const result = await validate({ @@ -110,7 +110,7 @@ export function generateToken(userId: string): string { Call this function with a user ID to generate a valid token. ```` -When you run `npx coderef validate`, it will verify that the `generateToken` function exists in `src/auth/jwt.ts` and extract its implementation automatically. +When you run `npx docs-coderef validate`, it will verify that the `generateToken` function exists in `src/auth/jwt.ts` and extract its implementation automatically. ### Example 2: Keeping Configuration Examples Up-to-Date @@ -133,7 +133,7 @@ export const config = { These values are loaded at application startup. ```` -If the `config` object in your source code changes, running `npx coderef fix --auto` will automatically update the documentation to reflect the current implementation. +If the `config` object in your source code changes, running `npx docs-coderef fix --auto` will automatically update the documentation to reflect the current implementation. ### Example 3: Documenting Specific Code Sections @@ -165,7 +165,7 @@ For more examples and usage patterns, see [docs/user-guide/](docs/user-guide/). ## Configuration -Create `.coderefrc.json` in your project root: +Create `.docs-coderefrc.json` in your project root: ```json { diff --git a/bin/coderef.js b/bin/docs-coderef.js similarity index 95% rename from bin/coderef.js rename to bin/docs-coderef.js index 61772d6..cf89827 100755 --- a/bin/coderef.js +++ b/bin/docs-coderef.js @@ -1,14 +1,14 @@ #!/usr/bin/env node /** - * CLI entry point for @cawpea/coderef + * CLI entry point for docs-coderef */ const { program } = require('commander'); const packageJson = require('../package.json'); program - .name('coderef') + .name('docs-coderef') .description('Validate and fix code references in markdown documentation') .version(packageJson.version); diff --git a/docs/README.md b/docs/README.md index f4c7c9e..2a265be 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Documentation Index -Welcome to the @cawpea/coderef documentation. This guide is organized into three main sections: +Welcome to the docs-coderef documentation. This guide is organized into three main sections: ## For Users diff --git a/docs/development/documentation.md b/docs/development/documentation.md index 0851b1f..7a5ef09 100644 --- a/docs/development/documentation.md +++ b/docs/development/documentation.md @@ -1,6 +1,6 @@ # Documentation Guidelines -This guide explains how to write and maintain documentation for the @cawpea/coderef project. +This guide explains how to write and maintain documentation for the docs-coderef project. ## Documentation Structure diff --git a/docs/development/release.md b/docs/development/release.md index 1ab3c6c..35ce48e 100644 --- a/docs/development/release.md +++ b/docs/development/release.md @@ -1,6 +1,6 @@ # Release Process -This document describes the release process for `@cawpea/coderef`. +This document describes the release process for `docs-coderef`. ## Overview @@ -82,7 +82,7 @@ You can manually trigger a release from the GitHub UI when needed. #### Steps 1. **Open GitHub Repository Page** - - https://github.com/cawpea/coderef + - https://github.com/cawpea/docs-coderef 2. **Navigate to Actions Tab** - Click the "Actions" tab at the top @@ -144,7 +144,7 @@ See [Git Conventions](./git-conventions.md) for more details. When a release succeeds, the following are automatically created: 1. **npm Package** - - https://www.npmjs.com/package/@cawpea/coderef + - https://www.npmjs.com/package/docs-coderef - New version is published 2. **Git Tag** @@ -169,7 +169,7 @@ After a release, verify the following: ### 1. Check GitHub Actions -- Visit https://github.com/cawpea/coderef/actions +- Visit https://github.com/cawpea/docs-coderef/actions - Verify Release workflow completed successfully - Ensure all steps have green checkmarks @@ -177,15 +177,15 @@ After a release, verify the following: ```bash # Check latest version -npm view @cawpea/coderef version +npm view docs-coderef version # Test package installation -npm install @cawpea/coderef@latest +npm install docs-coderef@latest ``` ### 3. Check GitHub Release -- Visit https://github.com/cawpea/coderef/releases +- Visit https://github.com/cawpea/docs-coderef/releases - Verify new release was created - Verify release notes are correctly generated @@ -237,7 +237,7 @@ git describe --tags --abbrev=0 2. **Package Name Conflict** - Verify package with same name doesn't already exist on npm - - For scoped packages (`@cawpea/coderef`), verify `publishConfig.access: "public"` is set + - For scoped packages (`docs-coderef`), verify `publishConfig.access: "public"` is set 3. **Network Error** - May be a temporary error @@ -280,16 +280,16 @@ Procedures for rolling back a release when issues occur. ```bash # Unpublish package version (within 72 hours) -npm unpublish @cawpea/coderef@X.Y.Z +npm unpublish docs-coderef@X.Y.Z # Or deprecate package (after 72 hours) -npm deprecate @cawpea/coderef@X.Y.Z "This version has critical issues. Please use vX.Y.Z-1 instead." +npm deprecate docs-coderef@X.Y.Z "This version has critical issues. Please use vX.Y.Z-1 instead." ``` ### Delete GitHub Release 1. **Delete from GitHub UI** - - Visit https://github.com/cawpea/coderef/releases + - Visit https://github.com/cawpea/docs-coderef/releases - Open the relevant release - Click "Delete" button diff --git a/docs/user-guide/cli-usage.md b/docs/user-guide/cli-usage.md index 6cb0cff..a2c7c89 100644 --- a/docs/user-guide/cli-usage.md +++ b/docs/user-guide/cli-usage.md @@ -7,7 +7,7 @@ Validate all CODE_REF references in your documentation: ```bash -npx coderef validate +npx docs-coderef validate ``` ### Validate Specific Files or Directories @@ -16,13 +16,13 @@ You can specify files or directories to validate: ```bash # Validate a specific file -npx coderef validate docs/README.md +npx docs-coderef validate docs/README.md # Validate a specific directory -npx coderef validate docs/backend/ +npx docs-coderef validate docs/backend/ # Validate multiple files/directories -npx coderef validate docs/README.md docs/api/ +npx docs-coderef validate docs/README.md docs/api/ ``` ### Options @@ -30,7 +30,7 @@ npx coderef validate docs/README.md docs/api/ - `--verbose`, `-v`: Display detailed output including reference counts per file ```bash -npx coderef validate --verbose +npx docs-coderef validate --verbose ``` ## Fix Command @@ -40,7 +40,7 @@ npx coderef validate --verbose Fix errors interactively with colored diffs: ```bash -npx coderef fix +npx docs-coderef fix ``` This will prompt you for each error with options to apply the fix or skip. @@ -50,25 +50,25 @@ This will prompt you for each error with options to apply the fix or skip. - `--auto`: Automatically apply all fixes without prompting for confirmation ```bash -npx coderef fix --auto +npx docs-coderef fix --auto ``` - `--dry-run`: Simulate fixes without making actual changes (useful for testing) ```bash -npx coderef fix --dry-run +npx docs-coderef fix --dry-run ``` - `--backup`: Create backup files before applying fixes (default: no backup) ```bash -npx coderef fix --backup +npx docs-coderef fix --backup ``` - `--verbose`, `-v`: Display detailed output during the fix process ```bash -npx coderef fix --verbose +npx docs-coderef fix --verbose ``` ### Combining Options @@ -77,10 +77,10 @@ You can combine multiple options: ```bash # Auto-fix with backup -npx coderef fix --auto --backup +npx docs-coderef fix --auto --backup # Dry run with verbose output -npx coderef fix --dry-run --verbose +npx docs-coderef fix --dry-run --verbose ``` ## Exit Codes diff --git a/docs/user-guide/code-ref-syntax.md b/docs/user-guide/code-ref-syntax.md index 2ac3c2b..74ccd90 100644 --- a/docs/user-guide/code-ref-syntax.md +++ b/docs/user-guide/code-ref-syntax.md @@ -345,13 +345,13 @@ Always use paths relative to your project root. After adding CODE_REF comments, run validation: ```bash -npx coderef validate +npx docs-coderef validate ``` If there are mismatches, fix them interactively: ```bash -npx coderef fix +npx docs-coderef fix ``` For implementation details, see [CODE_REF Syntax Implementation](../architecture/code-ref-syntax.md). diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md index 825e4bf..6ba79e3 100644 --- a/docs/user-guide/configuration.md +++ b/docs/user-guide/configuration.md @@ -2,7 +2,7 @@ ## Configuration File -Create `.coderefrc.json` in your project root: +Create `.docs-coderefrc.json` in your project root: ```json { @@ -19,9 +19,9 @@ Create `.coderefrc.json` in your project root: The tool loads configuration from multiple sources with the following precedence (highest to lowest): 1. **Programmatic options** - Passed directly to the API -2. **Environment variables** - `CODEREF_*` prefixed variables -3. **`.coderefrc.json`** - Configuration file in project root -4. **`package.json`** - `"coderef"` field +2. **Environment variables** - `DOCS_CODEREF_*` prefixed variables +3. **`.docs-coderefrc.json`** - Configuration file in project root +4. **`package.json`** - `"docs-coderef"` field 5. **Default values** - Built-in defaults ## Configuration Options @@ -188,19 +188,19 @@ You can override configuration using environment variables: ```bash # Set project root -export CODEREF_PROJECT_ROOT=/path/to/project +export DOCS_CODEREF_PROJECT_ROOT=/path/to/project # Set docs directory -export CODEREF_DOCS_DIR=documentation +export DOCS_CODEREF_DOCS_DIR=documentation # Set ignore file -export CODEREF_IGNORE_FILE=.customignore +export DOCS_CODEREF_IGNORE_FILE=.customignore # Enable verbose mode -export CODEREF_VERBOSE=true +export DOCS_CODEREF_VERBOSE=true # Run validation -npx coderef validate +npx docs-coderef validate ``` ## package.json Configuration @@ -211,7 +211,7 @@ Alternatively, you can define configuration in `package.json`: { "name": "my-package", "version": "1.0.0", - "coderef": { + "docs-coderef": { "docsDir": "documentation", "verbose": true } @@ -267,7 +267,7 @@ TODO.md You can also configure the tool programmatically when using the API: ```typescript -import { validate, fix } from '@cawpea/coderef'; +import { validate, fix } from '@cawpea/docs-coderef'; // Validate with custom configuration await validate({ diff --git a/docs/user-guide/installation.md b/docs/user-guide/installation.md index f2dea68..135aec3 100644 --- a/docs/user-guide/installation.md +++ b/docs/user-guide/installation.md @@ -8,15 +8,15 @@ ## Install the Package ```bash -npm install --save-dev @cawpea/coderef +npm install --save-dev docs-coderef ``` You can also use yarn or pnpm: ```bash # yarn -yarn add --dev @cawpea/coderef +yarn add --dev docs-coderef # pnpm -pnpm add --save-dev @cawpea/coderef +pnpm add --save-dev docs-coderef ``` diff --git a/package-lock.json b/package-lock.json index cc74fe4..0e44166 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "@cawpea/coderef", + "name": "docs-coderef", "version": "1.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "@cawpea/coderef", + "name": "docs-coderef", "version": "1.0.0", "license": "MIT", "dependencies": { @@ -14,7 +14,7 @@ "commander": "^14.0.2" }, "bin": { - "coderef": "bin/coderef.js" + "docs-coderef": "bin/docs-coderef.js" }, "devDependencies": { "@semantic-release/changelog": "^6.0.3", diff --git a/package.json b/package.json index 56a993c..c702189 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@cawpea/coderef", + "name": "docs-coderef", "version": "1.0.0", "description": "Validate and fix code references in markdown documentation", "keywords": [ @@ -16,7 +16,7 @@ "module": "./dist/index.mjs", "types": "./dist/index.d.ts", "bin": { - "coderef": "./bin/coderef.js" + "docs-coderef": "./bin/docs-coderef.js" }, "exports": { ".": { @@ -86,12 +86,12 @@ }, "repository": { "type": "git", - "url": "https://github.com/cawpea/coderef.git" + "url": "https://github.com/cawpea/docs-coderef.git" }, "bugs": { - "url": "https://github.com/cawpea/coderef/issues" + "url": "https://github.com/cawpea/docs-coderef/issues" }, - "homepage": "https://github.com/cawpea/coderef#readme", + "homepage": "https://github.com/cawpea/docs-coderef#readme", "author": "cawpea", "license": "MIT", "lint-staged": { diff --git a/src/cli/validate.ts b/src/cli/validate.ts index 235e7ad..76175c1 100644 --- a/src/cli/validate.ts +++ b/src/cli/validate.ts @@ -4,10 +4,10 @@ * CLI for validating CODE_REF references in markdown documentation * * Usage: - * coderef validate # Validate all files - * coderef validate --verbose # Verbose output - * coderef validate docs/README.md # Specific file - * coderef validate docs/backend/ # Specific directory + * docs-coderef validate # Validate all files + * docs-coderef validate --verbose # Verbose output + * docs-coderef validate docs/README.md # Specific file + * docs-coderef validate docs/backend/ # Specific directory */ import * as fs from 'fs'; diff --git a/src/config.test.ts b/src/config.test.ts index ba0ded8..1609580 100644 --- a/src/config.test.ts +++ b/src/config.test.ts @@ -49,8 +49,8 @@ describe('Config System', () => { }); }); - describe('.coderefrc.json support', () => { - it('should load configuration from .coderefrc.json', () => { + describe('.docs-coderefrc.json support', () => { + it('should load configuration from .docs-coderefrc.json', () => { const configContent = { docsDir: 'documentation', ignoreFile: '.docignore', @@ -58,7 +58,7 @@ describe('Config System', () => { }; fs.writeFileSync( - path.join(testDir, '.coderefrc.json'), + path.join(testDir, '.docs-coderefrc.json'), JSON.stringify(configContent, null, 2) ); @@ -69,19 +69,19 @@ describe('Config System', () => { expect(config.verbose).toBe(true); }); - it('should throw error for invalid .coderefrc.json', () => { - fs.writeFileSync(path.join(testDir, '.coderefrc.json'), 'invalid json{'); + it('should throw error for invalid .docs-coderefrc.json', () => { + fs.writeFileSync(path.join(testDir, '.docs-coderefrc.json'), 'invalid json{'); - expect(() => loadConfig()).toThrow('Failed to load .coderefrc.json'); + expect(() => loadConfig()).toThrow('Failed to load .docs-coderefrc.json'); }); }); describe('package.json support', () => { - it('should load configuration from package.json "coderef" field', () => { + it('should load configuration from package.json "docs-coderef" field', () => { const packageJson = { name: 'test-package', version: '1.0.0', - coderef: { + 'docs-coderef': { docsDir: 'doc', verbose: true, }, @@ -95,7 +95,7 @@ describe('Config System', () => { expect(config.verbose).toBe(true); }); - it('should ignore package.json without coderef field', () => { + it('should ignore package.json without docs-coderef field', () => { const packageJson = { name: 'test-package', version: '1.0.0', @@ -119,9 +119,9 @@ describe('Config System', () => { describe('Environment variable support', () => { it('should load configuration from environment variables', () => { - process.env.CODEREF_DOCS_DIR = 'envdocs'; - process.env.CODEREF_IGNORE_FILE = '.envignore'; - process.env.CODEREF_VERBOSE = 'true'; + process.env.DOCS_CODEREF_DOCS_DIR = 'envdocs'; + process.env.DOCS_CODEREF_IGNORE_FILE = '.envignore'; + process.env.DOCS_CODEREF_VERBOSE = 'true'; const config = loadConfig(); @@ -130,10 +130,10 @@ describe('Config System', () => { expect(config.verbose).toBe(true); }); - it('should handle CODEREF_PROJECT_ROOT', () => { + it('should handle DOCS_CODEREF_PROJECT_ROOT', () => { const customRoot = path.join(testDir, 'custom'); fs.mkdirSync(customRoot); - process.env.CODEREF_PROJECT_ROOT = customRoot; + process.env.DOCS_CODEREF_PROJECT_ROOT = customRoot; const config = loadConfig(); @@ -141,7 +141,7 @@ describe('Config System', () => { }); it('should parse verbose as boolean', () => { - process.env.CODEREF_VERBOSE = 'false'; + process.env.DOCS_CODEREF_VERBOSE = 'false'; const config = loadConfig(); expect(config.verbose).toBe(false); }); @@ -154,16 +154,16 @@ describe('Config System', () => { path.join(testDir, 'package.json'), JSON.stringify({ name: 'test', - coderef: { docsDir: 'package-docs', verbose: false }, + 'docs-coderef': { docsDir: 'package-docs', verbose: false }, }) ); fs.writeFileSync( - path.join(testDir, '.coderefrc.json'), + path.join(testDir, '.docs-coderefrc.json'), JSON.stringify({ docsDir: 'rc-docs', ignoreFile: '.rcignore' }) ); - process.env.CODEREF_DOCS_DIR = 'env-docs'; + process.env.DOCS_CODEREF_DOCS_DIR = 'env-docs'; }); it('should prioritize programmatic options over all other sources', () => { @@ -176,19 +176,19 @@ describe('Config System', () => { expect(config.docsDir).toBe('env-docs'); }); - it('should prioritize .coderefrc.json over package.json', () => { - delete process.env.CODEREF_DOCS_DIR; + it('should prioritize .docs-coderefrc.json over package.json', () => { + delete process.env.DOCS_CODEREF_DOCS_DIR; const config = loadConfig(); expect(config.docsDir).toBe('rc-docs'); expect(config.ignoreFile).toBe('.rcignore'); }); it('should use package.json when higher priority sources dont specify a field', () => { - delete process.env.CODEREF_DOCS_DIR; - delete process.env.CODEREF_VERBOSE; + delete process.env.DOCS_CODEREF_DOCS_DIR; + delete process.env.DOCS_CODEREF_VERBOSE; fs.writeFileSync( - path.join(testDir, '.coderefrc.json'), + path.join(testDir, '.docs-coderefrc.json'), JSON.stringify({ ignoreFile: '.rcignore' }) ); @@ -273,7 +273,7 @@ describe('Config System', () => { it('should inherit all base configuration options', () => { fs.writeFileSync( - path.join(testDir, '.coderefrc.json'), + path.join(testDir, '.docs-coderefrc.json'), JSON.stringify({ docsDir: 'documentation', verbose: true }) ); @@ -356,7 +356,7 @@ describe('Config System', () => { fs.mkdirSync(packagesDir, { recursive: true }); fs.writeFileSync( - path.join(packagesDir, '.coderefrc.json'), + path.join(packagesDir, '.docs-coderefrc.json'), JSON.stringify({ docsDir: '../../docs' }) ); diff --git a/src/config.ts b/src/config.ts index 148ea49..857892d 100644 --- a/src/config.ts +++ b/src/config.ts @@ -1,10 +1,10 @@ /** - * Configuration system for @cawpea/coderef + * Configuration system for docs-coderef * * Supports loading configuration from: - * - .coderefrc.json file - * - package.json "coderef" field - * - Environment variables (CODEREF_*) + * - .docs-coderefrc.json file + * - package.json "docs-coderef" field + * - Environment variables (DOCS_CODEREF_*) * - Programmatic options */ @@ -85,10 +85,10 @@ function getDefaultConfig(): CodeRefConfig { } /** - * Load configuration from .coderefrc.json file + * Load configuration from .docs-coderefrc.json file */ function loadConfigFile(projectRoot: string): PartialCodeRefConfig | null { - const configPath = path.join(projectRoot, '.coderefrc.json'); + const configPath = path.join(projectRoot, '.docs-coderefrc.json'); if (!fs.existsSync(configPath)) { return null; @@ -99,13 +99,13 @@ function loadConfigFile(projectRoot: string): PartialCodeRefConfig | null { return JSON.parse(content); } catch (error) { throw new Error( - `Failed to load .coderefrc.json: ${error instanceof Error ? error.message : String(error)}` + `Failed to load .docs-coderefrc.json: ${error instanceof Error ? error.message : String(error)}` ); } } /** - * Load configuration from package.json "coderef" field + * Load configuration from package.json "docs-coderef" field */ function loadPackageJsonConfig(projectRoot: string): PartialCodeRefConfig | null { const packageJsonPath = path.join(projectRoot, 'package.json'); @@ -117,7 +117,7 @@ function loadPackageJsonConfig(projectRoot: string): PartialCodeRefConfig | null try { const content = fs.readFileSync(packageJsonPath, 'utf-8'); const packageJson = JSON.parse(content); - return packageJson.coderef || null; + return packageJson['docs-coderef'] || null; } catch (_error) { // Silently ignore package.json parsing errors return null; @@ -130,20 +130,20 @@ function loadPackageJsonConfig(projectRoot: string): PartialCodeRefConfig | null function loadEnvConfig(): PartialCodeRefConfig { const config: PartialCodeRefConfig = {}; - if (process.env.CODEREF_PROJECT_ROOT) { - config.projectRoot = process.env.CODEREF_PROJECT_ROOT; + if (process.env.DOCS_CODEREF_PROJECT_ROOT) { + config.projectRoot = process.env.DOCS_CODEREF_PROJECT_ROOT; } - if (process.env.CODEREF_DOCS_DIR) { - config.docsDir = process.env.CODEREF_DOCS_DIR; + if (process.env.DOCS_CODEREF_DOCS_DIR) { + config.docsDir = process.env.DOCS_CODEREF_DOCS_DIR; } - if (process.env.CODEREF_IGNORE_FILE) { - config.ignoreFile = process.env.CODEREF_IGNORE_FILE; + if (process.env.DOCS_CODEREF_IGNORE_FILE) { + config.ignoreFile = process.env.DOCS_CODEREF_IGNORE_FILE; } - if (process.env.CODEREF_VERBOSE) { - config.verbose = process.env.CODEREF_VERBOSE === 'true'; + if (process.env.DOCS_CODEREF_VERBOSE) { + config.verbose = process.env.DOCS_CODEREF_VERBOSE === 'true'; } return config; @@ -155,8 +155,8 @@ function loadEnvConfig(): PartialCodeRefConfig { * Precedence (highest to lowest): * 1. Programmatic options * 2. Environment variables - * 3. .coderefrc.json - * 4. package.json "coderef" field + * 3. .docs-coderefrc.json + * 4. package.json "docs-coderef" field * 5. Default values */ function mergeConfigs( @@ -213,7 +213,7 @@ export function loadConfig(options: PartialCodeRefConfig = {}): CodeRefConfig { const defaultConfig = getDefaultConfig(); // Determine projectRoot first (needed for loading config files) - const projectRoot = options.projectRoot || process.env.CODEREF_PROJECT_ROOT || process.cwd(); + const projectRoot = options.projectRoot || process.env.DOCS_CODEREF_PROJECT_ROOT || process.cwd(); // Load from all sources const packageJsonConfig = loadPackageJsonConfig(projectRoot); diff --git a/src/index.ts b/src/index.ts index 23399d6..7499b3f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,12 +1,12 @@ /** - * @cawpea/coderef - Validate and fix code references in markdown documentation + * docs-coderef - Validate and fix code references in markdown documentation * * This is the main entry point for programmatic usage. - * For CLI usage, use the `coderef` command. + * For CLI usage, use the `docs-coderef` command. * * @example * ```typescript - * import { validateCodeRef, extractCodeRefs, loadConfig } from '@cawpea/coderef'; + * import { validateCodeRef, extractCodeRefs, loadConfig } from 'docs-coderef'; * * const config = loadConfig(); * const refs = extractCodeRefs(markdownContent, 'docs/README.md'); From c8401ae88c695461620cea9cff5aa526764a1288 Mon Sep 17 00:00:00 2001 From: "m.osumi" Date: Thu, 1 Jan 2026 17:14:07 +0900 Subject: [PATCH 2/7] chore: fix typo --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fd7ec72..df945ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **Package rename**: Changed package name from `@cawpea/coderef` to `docs-coderef` (removed scope) - **CLI command**: Changed from `coderef` to `docs-coderef` -- **Config file**: Renamed from `.docs-coderefrc.json` to `.docs-coderefrc.json` +- **Config file**: Renamed from `.coderefrc.json` to `.docs-coderefrc.json` - **package.json field**: Changed from `"coderef"` to `"docs-coderef"` - **Environment variables**: Changed from `CODEREF_*` to `DOCS_CODEREF_*` - **Repository**: Renamed from `cawpea/coderef` to `cawpea/docs-coderef` From 6e24ff59ab90c10d3c68fe7fd3e74cbd2e043ba3 Mon Sep 17 00:00:00 2001 From: "m.osumi" Date: Thu, 1 Jan 2026 17:18:40 +0900 Subject: [PATCH 3/7] chore: reset version to 0.1.0 for initial npm publish MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 --- CHANGELOG.md | 61 ---------------------------------------------------- package.json | 2 +- 2 files changed, 1 insertion(+), 62 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index df945ba..bae762a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,67 +16,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **Environment variables**: Changed from `CODEREF_*` to `DOCS_CODEREF_*` - **Repository**: Renamed from `cawpea/coderef` to `cawpea/docs-coderef` -# [1.0.0](https://github.com/cawpea/docs-coderef/compare/v0.1.0...v1.0.0) (2026-01-01) - - -### Bug Fixes - -* exclude CODE_REF comments in unclosed code blocks from validation ([f1f5287](https://github.com/cawpea/docs-coderef/commit/f1f52879dbed2d8ffaaf29fdba959e401fc81d2a)) -* handle variable-length backtick sequences in code blocks ([b5674ad](https://github.com/cawpea/docs-coderef/commit/b5674add6060fbb429190ca97a02526ae16c31f2)) - - -### Features - -* remove default .docsignore value from configuration ([67967d3](https://github.com/cawpea/docs-coderef/commit/67967d3adccb5709ea8bfc2e357d8ff685831e12)) - - -### BREAKING CHANGES - -* The `ignoreFile` configuration no longer defaults to '.docsignore'. -To continue using .docsignore, explicitly set `ignoreFile: '.docsignore'` in your -configuration file (.docs-coderefrc.json or package.json). - -This change makes the ignore file behavior explicit rather than implicit, applying -ignore patterns only when intentionally configured. All documentation examples now -use `.gitignore` instead of `.docsignore` to reflect this generic approach. - -🤖 Generated with [Claude Code](https://claude.com/claude-code) - -Co-Authored-By: Claude Sonnet 4.5 - -# 1.0.0 (2025-12-31) - - -### Bug Fixes - -* add npm rebuild step to resolve rollup native binary issue in CI ([4ec06ad](https://github.com/cawpea/docs-coderef/commit/4ec06add097033d7aa6aa531e08c8e09c693b599)) -* add pull-requests write permission to claude-code-review workflow ([be5b41d](https://github.com/cawpea/docs-coderef/commit/be5b41d41015aa05697099625ad484e441ba2ffe)) -* add rollup as explicit devDependency to resolve CI build issue ([01061e5](https://github.com/cawpea/docs-coderef/commit/01061e519ab3f80d884810738e4396d3c47d2f53)) -* clear npm cache to resolve rollup native binary issue in CI ([0cd15bd](https://github.com/cawpea/docs-coderef/commit/0cd15bd142aec85303469c8d917955711f4121c6)) -* correct collectCoverageFrom pattern order in Jest config ([dbac613](https://github.com/cawpea/docs-coderef/commit/dbac61383fe0e4dbe6d3654c22615b0bab8235b3)) -* prevent command injection in git-diff by using spawnSync ([105a9c2](https://github.com/cawpea/docs-coderef/commit/105a9c263a5ade19d138a0d5ec020619b62e824e)) -* reinstall rollup to ensure native binaries are installed in CI ([389e7af](https://github.com/cawpea/docs-coderef/commit/389e7afaa7792b0eadf75fa9bef8e1fe0f708360)) -* run npm install after npm ci to fix rollup native binary issue ([2816913](https://github.com/cawpea/docs-coderef/commit/2816913af1d10e445b2942ecf1044f39e40f25ff)) -* translate remaining japanese character to english in src/utils/fix.ts ([68c57ba](https://github.com/cawpea/docs-coderef/commit/68c57babfdd5ee847af57d29b47ac28168e456cf)) -* update project root to use config ([97724b3](https://github.com/cawpea/docs-coderef/commit/97724b3467d61b67917a0c8c4446dd8485482960)) - - -### Features - -* add ESLint configuration for scripts directory ([236ad04](https://github.com/cawpea/docs-coderef/commit/236ad042620d3b6ad9af2f2c57469e4e95f52f5d)) -* add variable reference support in CODE_REF ([d098259](https://github.com/cawpea/docs-coderef/commit/d098259dcecf185e0743baddd0dccc4b960ea471)) -* implement CLI with commander and programmatic API ([3ec29f8](https://github.com/cawpea/docs-coderef/commit/3ec29f8b18f6128e85723df6315a76ed52baacf1)) -* implement configuration system ([43bf006](https://github.com/cawpea/docs-coderef/commit/43bf006df05e2fbf31301ed081c9807a5b3c2a60)) -* integrate configuration system into fix.ts ([6192ccd](https://github.com/cawpea/docs-coderef/commit/6192ccdeec20c3b783b606c0de779463fad56066)) -* integrate configuration system into validate.ts ([b6638ef](https://github.com/cawpea/docs-coderef/commit/b6638ef47b0c9f7019f8271776d01e041cda3969)) -* migrate core logic and utils from figma-a11y-reviewer ([19efe8c](https://github.com/cawpea/docs-coderef/commit/19efe8caafc4396054ab4d37ebe79d25a9c21846)) -* translate comments and logs to english in src/cli/fix.ts ([f4cd0b8](https://github.com/cawpea/docs-coderef/commit/f4cd0b89f12056a3139dfbe50bc6ff1ec9825e05)) -* translate comments and messages to english in src/core/validate.ts and tests ([79f609e](https://github.com/cawpea/docs-coderef/commit/79f609e0bc22eab31bbe38a69d01e1a54e7e099b)) -* translate comments and messages to english in src/utils/fix.ts and tests ([7b2dafb](https://github.com/cawpea/docs-coderef/commit/7b2dafb44a5f0cd3c0ae3f94640de7447d432339)) -* translate japanese logs and comments to english ([4a20066](https://github.com/cawpea/docs-coderef/commit/4a20066692f73e453cf806ed0d2dc2ed097bf9cd)) - -## [Unreleased] - ### Added - Initial project setup diff --git a/package.json b/package.json index c702189..12d39d3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "docs-coderef", - "version": "1.0.0", + "version": "0.1.0", "description": "Validate and fix code references in markdown documentation", "keywords": [ "markdown", From ff8a89a518ad0eff85e25572eed31d7b408258dd Mon Sep 17 00:00:00 2001 From: "m.osumi" Date: Thu, 1 Jan 2026 17:20:38 +0900 Subject: [PATCH 4/7] docs: remove development state in README.md --- README.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/README.md b/README.md index 45882d5..6e548e9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,6 @@ # docs-coderef -> Validate and fix code references in markdown documentation - -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) - -**Status**: 🚧 Under Development +Validate and fix code references in markdown documentation ## Overview @@ -175,10 +171,6 @@ Create `.docs-coderefrc.json` in your project root: } ``` -## Development - -This package is currently under active development. More documentation will be added soon. - ## License MIT © cawpea From 527b2307136f860002ed8cbbfc3da4abff0a5589 Mon Sep 17 00:00:00 2001 From: "m.osumi" Date: Thu, 1 Jan 2026 20:25:17 +0900 Subject: [PATCH 5/7] chore: remove publichConfig in package.json --- docs/development/release.md | 2 +- package.json | 3 --- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/development/release.md b/docs/development/release.md index 35ce48e..ca96e5a 100644 --- a/docs/development/release.md +++ b/docs/development/release.md @@ -237,7 +237,7 @@ git describe --tags --abbrev=0 2. **Package Name Conflict** - Verify package with same name doesn't already exist on npm - - For scoped packages (`docs-coderef`), verify `publishConfig.access: "public"` is set + - For scoped packages (e.g., `@company/package-name`), verify `publishConfig.access: "public"` is set 3. **Network Error** - May be a temporary error diff --git a/package.json b/package.json index 12d39d3..f298111 100644 --- a/package.json +++ b/package.json @@ -51,9 +51,6 @@ "engines": { "node": ">=22.0.0" }, - "publishConfig": { - "access": "public" - }, "dependencies": { "@typescript-eslint/typescript-estree": "^8.50.1", "chalk": "^4.1.2", From 10fb1c679532f3cebd4ef28321be8c4903d7d458 Mon Sep 17 00:00:00 2001 From: "m.osumi" Date: Thu, 1 Jan 2026 20:31:38 +0900 Subject: [PATCH 6/7] chore: update package-lock.json --- package-lock.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 0e44166..ae710c0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "docs-coderef", - "version": "1.0.0", + "version": "0.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "docs-coderef", - "version": "1.0.0", + "version": "0.1.0", "license": "MIT", "dependencies": { "@typescript-eslint/typescript-estree": "^8.50.1", From b091dba5352de6550461f35a42e9289ac146cd11 Mon Sep 17 00:00:00 2001 From: "m.osumi" Date: Thu, 1 Jan 2026 20:33:19 +0900 Subject: [PATCH 7/7] chore: fix typo --- docs/user-guide/configuration.md | 2 +- scripts/lib/path-checker.test.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md index 6ba79e3..49dad76 100644 --- a/docs/user-guide/configuration.md +++ b/docs/user-guide/configuration.md @@ -267,7 +267,7 @@ TODO.md You can also configure the tool programmatically when using the API: ```typescript -import { validate, fix } from '@cawpea/docs-coderef'; +import { validate, fix } from 'docs-coderef'; // Validate with custom configuration await validate({ diff --git a/scripts/lib/path-checker.test.ts b/scripts/lib/path-checker.test.ts index d6560d5..fcd0012 100644 --- a/scripts/lib/path-checker.test.ts +++ b/scripts/lib/path-checker.test.ts @@ -37,7 +37,7 @@ describe('path-checker', () => { }); it('should return true when bin/ files are changed', () => { - const changedFiles = ['bin/coderef.js']; + const changedFiles = ['bin/docs-coderef.js']; const result = requiresDocsUpdate(changedFiles);