docs(publishing): scaffold a package with npm create malloy-package#332
Open
mlennie wants to merge 1 commit into
Open
docs(publishing): scaffold a package with npm create malloy-package#332mlennie wants to merge 1 commit into
npm create malloy-package#332mlennie wants to merge 1 commit into
Conversation
The Quick Start opened by asking the reader to hand-build a package directory and a manifest. The scaffolder does that for them, registers the package so the server actually serves it, and sets up the workspace around it, so it belongs first, with the by-hand layout kept underneath for anyone who wants it. Both the `npm create` and `npx` forms are shown, because they parse options differently and getting it wrong fails in a way a reader cannot reason about: `npm create` treats anything before a `--` as one of its own options, so the separator is required, while `npx` forwards flags untouched and counts a `--` as an extra argument. Verified against both entry points rather than assumed. Both require Node, which is worth stating plainly on a page a non-developer may land on. Do not merge before `create-malloy-package` is published to npm: it is unregistered today, so this page would tell readers to run a name anyone can take. Signed-off-by: Monty Lennie <[email protected]>
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.
The Quick Start opened by asking the reader to hand-build a package directory and a manifest. The scaffolder does that for them, registers the package so the server actually serves it, and sets up the workspace around it, so it belongs first, with the by-hand layout kept underneath for anyone who wants it.
Both the
npm createandnpxforms are shown, because they parse options differently and getting it wrong fails in a way a reader cannot reason about:npm createtreats anything before a--as one of its own options, so the separator is required, whilenpxforwards flags untouched and counts a--as an extra argument. Verified against both entry points rather than assumed.Both require Node, which is worth stating plainly on a page a non-developer may land on.
Do not merge before
create-malloy-packageis published to npm: it is unregistered today, so this page would tell readers to run a name anyone can take.