This repository was archived by the owner on Oct 28, 2026. It is now read-only.
Repository navigation
chore: add the MIT license and fix gaps in the docs - #4
Merged
Merged
Conversation
The steps below the excerpt ask you to check control-01 and control-02, and plumb demo prints a Control line for each.
~/.config/plumb/config.json is only the default. XDG_CONFIG_HOME and PLUMB_CONFIG change it, as the CLI reference explains.
oxlint.config.ts and oxfmt.config.ts use import syntax, so Node warned with MODULE_TYPELESS_PACKAGE_JSON on every check and fix.
|
|
Security review: nothing to raise. Reviewed at |
Add the LICENSE file that apps/cli/package.json already points to, set the same license on the root package, and ship LICENSE in every release archive.
PunGrumpy
force-pushed
the
chore/license-and-doc-fixes
branch
from
September 29, 2026 10:10
a558d11 to
0fd81e6
Compare
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
Follow-ups from #3.
LICENSE(MIT).apps/cli/package.jsonalready said MIT, so the rootpackage.jsonnow says the same, the README has a License section, and GoReleaser shipsLICENSEin every archive next toREADME.md."type": "module"in the rootpackage.json.oxlint.config.tsandoxfmt.config.tsuseimport, so Node printedMODULE_TYPELESS_PACKAGE_JSONon everycheckandfix.quickstart.md: the excerpt now shows thecontrol-02line, which the steps below it ask you to check.run-against-a-lab.md:~/.config/plumb/config.jsonis described as the default path, with a link to the CLI reference forXDG_CONFIG_HOMEandPLUMB_CONFIG.Testing Instructions
Compare the excerpt in
docs/quickstart.mdwith thePortsection ofplumb demo.