Skip to content
This repository was archived by the owner on Apr 8, 2026. It is now read-only.

docs: Add doc-detective-resolver repository documentation #152

Draft
promptless wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Add doc-detective-resolver repository documentation #152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/contribute/repos/doc-detective-resolver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
Copy link
Copy Markdown
Contributor Author

@promptless promptless Bot Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: TypeScript migration PR that documents the build process (npm run build), dual CJS/ESM output structure (dist/*.js, dist/index.mjs, dist/*.d.ts), and development workflow. Package description and purpose from package.json.
View source

sidebar_position: 4
---

# `doc-detective-resolver`

[`doc-detective-resolver`](https://github.com/doc-detective/resolver) is an NPM package that scans documentation for test markup and converts it into executable Doc Detective tests. It's installable via NPM (`npm i doc-detective-resolver`).

This repo depends on [`doc-detective-common`](doc-detective-common) for JSON schema definitions, schema validation logic, and path resolution logic.

## TypeScript codebase

Source code is in TypeScript (`src/`) and compiles to JavaScript for distribution. Tests run against the compiled output in `dist/`.

### Building

```bash
npm run build
```

This compiles TypeScript to JavaScript and creates an ESM wrapper for dual module support. Build output goes to `dist/` and includes CommonJS modules (`*.js`), an ESM wrapper (`index.mjs`), and TypeScript declarations (`*.d.ts`).

### Development workflow

1. Edit TypeScript files in `src/`
2. Build with `npm run build`
3. Run tests with `npm test`

Tests run against the compiled output to ensure the published package works correctly.
Loading