Skip to content

Commit 35c5e57

Browse files
committed
docs(claude): reduce verbosity in documentation
Condensed verbose sections to minimize AI misinterpretation: - Fixed incorrect script command references - Reduced test helpers documentation from 22 lines to 7 lines - Simplified command list to match actual package.json scripts
1 parent 11b7985 commit 35c5e57

File tree

1 file changed

+9
-26
lines changed

1 file changed

+9
-26
lines changed

CLAUDE.md

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,11 @@ TypeScript implementation of [Package URL specification](https://github.com/pack
117117
### Commands
118118
- **Build**: `pnpm build` (production build)
119119
- **Watch**: `pnpm build --watch` (dev mode with 68% faster incremental builds)
120-
- **Test**: `pnpm test`, `pnpm test:unit`
121-
- **Type check**: `pnpm check:tsc`
122-
- **Lint**: `pnpm check:lint`
120+
- **Test**: `pnpm test`
121+
- **Type check**: `pnpm type`
122+
- **Lint**: `pnpm lint`
123123
- **Check all**: `pnpm check`
124-
- **Fix**: `pnpm check:lint:fix` or `pnpm fix`
124+
- **Fix**: `pnpm fix`
125125
- **Coverage**: `pnpm cover`
126126

127127
**Development tip:** Use `pnpm build --watch` for 68% faster rebuilds (9ms vs 27ms). Incremental builds use esbuild's context API for in-memory caching.
@@ -242,30 +242,13 @@ With `exactOptionalPropertyTypes`, assign conditionally:
242242
- **Test helpers**: `test/utils/test-helpers.mts` - Reusable test utilities
243243
- **Assertion helpers**: `test/utils/assertions.mts` - Property validation helpers
244244

245-
#### Test Helpers (`test/utils/test-helpers.mts`)
245+
#### Test Helpers
246246

247-
**createTestPurl(type, name, opts?)** - Factory for creating PackageURL instances
248-
```typescript
249-
import { createTestPurl } from './utils/test-helpers.mts'
247+
Test helpers in `test/utils/test-helpers.mts`:
248+
- `createTestPurl(type, name, opts?)` - Factory for PackageURL instances
249+
- `createTestFunction(returnValue?)` - Creates test functions with optional return values
250250

251-
// Before: new PackageURL('npm', undefined, 'lodash', '4.17.21', undefined, undefined)
252-
// After:
253-
const purl = createTestPurl('npm', 'lodash', { version: '4.17.21' })
254-
255-
// With all options:
256-
const purl = createTestPurl('npm', 'lodash', {
257-
version: '4.17.21',
258-
namespace: '@scope',
259-
qualifiers: { arch: 'x64' },
260-
subpath: 'dist/index.js'
261-
})
262-
```
263-
264-
**createTestFunction(returnValue?)** - Creates test functions with optional return values
265-
```typescript
266-
const testFn = createTestFunction('result')
267-
expect(testFn()).toBe('result')
268-
```
251+
See file for usage examples.
269252

270253
#### Running Tests
271254
- **All tests**: `pnpm test` or `pnpm test:unit`

0 commit comments

Comments
 (0)