Skip to content

release/v0.1.0 - #3

Merged
lcweden merged 8 commits into
mainfrom
release/v0.1.0
May 18, 2026
Merged

release/v0.1.0#3
lcweden merged 8 commits into
mainfrom
release/v0.1.0

Conversation

@lcweden

@lcweden lcweden commented May 18, 2026

Copy link
Copy Markdown
Owner

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:

  • Added .github/workflows/publish.yaml to automate publishing to npm and JSR on GitHub release.
  • Updated .github/workflows/ci.yml to only run CI on pull requests, not on every push to main.

Packaging and Distribution:

  • Updated package.json with metadata for npm publication, including exports, files, and repository info. The build script now produces type declarations.
  • Added tsconfig.build.json to generate type declarations in the dist directory.
  • Added vite.config.ts for building the library as an ES module.
  • Updated deno.json to include name, version, license, exports, and publish configuration for Deno compatibility. [1] [2]

Documentation and Changelog:

  • Overhauled README.md with detailed API documentation, usage examples, and installation instructions.
  • Added a CHANGELOG.md pointing to GitHub Releases for change history.

Type Annotations and API Improvements:

  • Improved type annotations for Token and Value class properties and methods, ensuring accurate TypeScript types for library consumers. [1] [2] [3]
  • Clarified supported JSONPath features in the JSONTextSelectorStream documentation.

Testing:

  • Minor test output improvements in tests/e2e/streaming.test.ts for clarity. [1] [2]

@lcweden lcweden self-assigned this May 18, 2026
@lcweden lcweden added documentation Improvements or additions to documentation enhancement New feature or request labels May 18, 2026
@lcweden
lcweden merged commit c373c36 into main May 18, 2026
1 check passed
@lcweden
lcweden deleted the release/v0.1.0 branch May 18, 2026 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant