chore(core): prepare @zipkit/core for npm publication#53
Merged
Conversation
Prepare @zipkit/core for npm publication without actually publishing. - Set version to 0.1.0 (initial unstable release) - Add description, keywords, license, author, repository (with directory), homepage, and bugs fields - Add "sideEffects": false for downstream tree-shaking (publint) - Add publishConfig.access: public so the scoped package publishes publicly once private is lifted - Add package-local README.md and LICENSE so the npm page renders Keep "private": true as the final safety gate; flipping it, owning the @zipkit npm org, and auth/token setup remain before an actual publish. publint: clean. attw: ESM-only (expected CJS dynamic-import note).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Why
PR #52 turned
@zipkit/coreinto a built, ESM-only package consumed byapps/web. The build pipeline is solid, but the package still lacked the metadata and package-local docs npm needs to render a proper page and to publish under a scoped name. This change closes that gap so the package is one step (liftingprivate) away from a clean first publish, without publishing anything yet.What
0.0.0->0.1.0(initial, intentionally pre-1.0 / unstable API).description,keywords,license,author,repository(withdirectory: packages/corefor the monorepo),homepage,bugs.sideEffects: falseso bundlers can tree-shake (resolves the onlypublintsuggestion). The package is pure functions.publishConfig.access: publicso the scoped package publishes publicly onceprivateis lifted.README.md(zh-TW API docs) andLICENSEso the npm page renders. npm only bundles README/LICENSE from the package root, not the repo root.private: trueis intentionally kept as the final safety gate.Verification
publint: All good.attw --pack: green for node10 / node16-ESM / bundler; the single warning is the expected ESM-only "CJS must use dynamic import" note.pnpm pack --dry-run: tarball now containsdist/,README.md,LICENSE,package.json.Still required before an actual publish (out of scope here)
private: true.@zipkitnpm org (own the scope) and set up auth (npm login/ CINPM_TOKEN).