feat(packaging): configure for bunx compatibility#1
Open
imsakg wants to merge 3 commits into
Open
Conversation
Adds the necessary fields to `package.json` to allow the project to be executed with `bunx`. - Adds the `bin` field to define the executable command. - Sets `preferGlobal` to `true` as is common for CLI tools. - Populates the `files` array to ensure the `dist` directory is included when publishing. - Adds standard package metadata including `keywords`, `license`, and `repository` to improve package discoverability.
- Change executable in package.json bin from dist/index.js to src/index.ts - Update shebang in src/index.ts from node to bun for runtime compatibility - Clean up trailing whitespace and improve formatting in source code
- Include `src/**/*` and `tsconfig.json` in published files for proper source inclusion. - Change moduleResolution to "bundler" and enable importing TypeScript extensions in tsconfig for improved compatibility. - Set noEmit to true to prevent output emission during compilation. - Fix import paths in source code to use `.ts` extensions.
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
1 participant
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.
Adds the necessary fields to
package.jsonto allow the project to be executed withbunx.binfield to define the executable command.preferGlobaltotrueas is common for CLI tools.filesarray to ensure thedistdirectory is included when publishing.keywords,license, andrepositoryto improve package discoverability.