Remove unnecessary library export fields from package.json#60
Closed
pullfrog[bot] wants to merge 1 commit intomainfrom
Closed
Remove unnecessary library export fields from package.json#60pullfrog[bot] wants to merge 1 commit intomainfrom
pullfrog[bot] wants to merge 1 commit intomainfrom
Conversation
zshy is a CLI tool that doesn't export a programmatic API, so the module, main, types, and exports fields are unnecessary and misleading. The bin field correctly declares the CLI entry point. Fixes #58
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.
Summary
Removes unnecessary library-specific fields from
package.jsonsince zshy is a CLI tool that doesn't export a programmatic API.Changes
Removed the following fields:
module- ES module entry point for library importsmain- CommonJS entry point for library importstypes- TypeScript type definitions for library importsexports- Conditional exports for library importsThe
binfield remains as the correct way to declare the CLI entry point.Rationale
These fields suggest that zshy can be imported and used as a library (
import zshy from 'zshy'), but the actual code insrc/index.tsonly executes the CLI and doesn't export any programmatic API. Having these fields is misleading and unnecessary.Fixes #58