release/v0.1.0 - #3
Merged
Merged
Conversation
… test descriptions for clarity
…ds in decoder and token classes
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.
This pull request prepares the project for its first public release, adding publishing workflows, updating documentation, and configuring packaging for both npm and Deno. It also improves type annotations and clarifies API documentation. The most important changes are grouped below.
Release and Publishing Automation:
.github/workflows/publish.yamlto automate publishing to npm and JSR on GitHub release..github/workflows/ci.ymlto only run CI on pull requests, not on every push tomain.Packaging and Distribution:
package.jsonwith metadata for npm publication, including exports, files, and repository info. The build script now produces type declarations.tsconfig.build.jsonto generate type declarations in thedistdirectory.vite.config.tsfor building the library as an ES module.deno.jsonto include name, version, license, exports, and publish configuration for Deno compatibility. [1] [2]Documentation and Changelog:
README.mdwith detailed API documentation, usage examples, and installation instructions.CHANGELOG.mdpointing to GitHub Releases for change history.Type Annotations and API Improvements:
TokenandValueclass properties and methods, ensuring accurate TypeScript types for library consumers. [1] [2] [3]JSONTextSelectorStreamdocumentation.Testing:
tests/e2e/streaming.test.tsfor clarity. [1] [2]