docs: Update contributor docs for core bundling in v4.0.0#153
Open
promptless[bot] wants to merge 2 commits intomainfrom
Open
docs: Update contributor docs for core bundling in v4.0.0#153promptless[bot] wants to merge 2 commits intomainfrom
promptless[bot] wants to merge 2 commits intomainfrom
Conversation
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| This repo depends on | ||
| - [`doc-detective-core`](doc-detective-core) for the primary testing logic. | ||
| - [`doc-detective-common`](doc-detective-common) for JSON schema definitions, schema validation logic, and path resolution logic. No newline at end of file | ||
| As of v4.0.0, `doc-detective` bundles the core testing logic directly (previously provided by the separate `doc-detective-core` package). The codebase is written in TypeScript and supports both ESM and CommonJS module systems. |
Contributor
Author
There was a problem hiding this comment.
Citation: Based on package.json changes showing version bump to 4.0.0-beta.0, removal of doc-detective-core dependency, addition of "type": "module", and new exports config supporting both ESM and CJS.
View source
| :::note | ||
|
|
||
| This repo depends on [`doc-detective-common`](doc-detective-common) for JSON schema definitions, schema validation logic, and path resolution logic. No newline at end of file | ||
| As of v4.0.0, core functionality is bundled into the main [`doc-detective`](doc-detective) package. `doc-detective-core` is no longer published as a separate NPM package. |
Contributor
Author
There was a problem hiding this comment.
Citation: Based on package.json removal of doc-detective-core dependency and addition of src/core/ directory containing the bundled core functionality.
View source
Contributor
Author
| - [`doc-detective-common`](doc-detective-common) for JSON schema definitions, schema validation logic, and path resolution logic. No newline at end of file | ||
| As of v4.0.0, `doc-detective` bundles the core testing logic directly (previously provided by the separate `doc-detective-core` package). The codebase is written in TypeScript and supports both ESM and CommonJS module systems. | ||
|
|
||
| This repo depends on [`doc-detective-common`](doc-detective-common) for JSON schema definitions, schema validation logic, and path resolution logic. No newline at end of file |
Contributor
Author
There was a problem hiding this comment.
Citation: Removed "path resolution logic" from dependency list because PR #157 removed resolvePaths from public exports in src/index.ts—the function and its source files (src/resolvePaths.js, src/resolvePaths.ts) were deleted.
View source
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Open this suggestion in Promptless to view citations and reasoning process
Updates the contributor repository documentation to reflect the v4.0.0 architectural change where
doc-detective-coreis now bundled directly into the maindoc-detectivepackage. Thedoc-detective.mdpage now notes the bundled core and TypeScript/ESM codebase, whiledoc-detective-core.mdincludes a deprecation notice explaining the package is no longer published separately.Trigger Events
doc-detective/doc-detective PR #170: Bundle `core`, refactor to be ESM in Typescript
Promptless Research (1 GitHub PR)
Agent Response
Tip: See how your feedback shapes Promptless in Agent Knowledge Base 🧠