Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-03-05fix: markdown error on using-npm/scripts docsrelease/v7.6.1Ruy Adorno
2021-03-05chore: update republish timeout after unpublishbaj-/update-unpublish-docsBjørn Johansen
PR-URL: https://github.com/npm/cli/pull/2809 Credit: @BAJ- Close: #2809 Reviewed-by: @christoflemke, @sarin1234, @darcyclarke
2021-03-04fix(docs): update scripts docsGar
The lifecycle events section was very out of date, and lots of other cleanup needed to happen too PR-URL: https://github.com/npm/cli/pull/2690 Credit: @wraithgar Close: #2690 Reviewed-by: @ruyadorno
2021-02-25chore(docs):update unpublish cooldownChristof Lemke
PR-URL: https://github.com/npm/cli/pull/2778 Credit: @christoflemke Close: #2778 Reviewed-by: @wraithgar, @ethomson
2021-02-25chore(docs): add navigation configurationEdward Thomson
The documentation in this repository is added to the overall npm documentation at https://docs.npmjs.com/, which includes both the documentation for the public registry and the CLI. The documentation site itself also has a navigational hierarchy; since the content is included from the CLI, we also want to ensure that the navigation for that content lives in this repository. This means that this repository is the source of truth for all of the CLI documentation, and we do not need to update two places when we add, edit, or remove CLI documentation. It all lives here. This also teaches the documentation rendering script to identify when the navigation configuration (nav.yml) is missing new pages that were recently added or retains old pages that have recently been deleted. PR-URL: https://github.com/npm/cli/pull/2775 Credit: @ethomson Close: #2775 Reviewed-by: @wraithgar
2021-02-25chore(docs): capitalize all Instaces of "package"MrBrain295
To make the headings consistent. PR-URL: https://github.com/npm/cli/pull/2760 Credit: @MrBrain295 Close: #2760 Reviewed-by: @wraithgar
2021-02-22Capitalize Package in a HeadingMrBrain295
The third heading needed “package” capitalized. PR-URL: https://github.com/npm/cli/pull/2749 Credit: @MrBrain295 Close: #2749 Reviewed-by: @isaacs
2021-02-18docs: validate that the docs can be parsed by mdxEdward Thomson
Although our documentation is rendered for the "in the box" docs by cmark-gfm, the upstream docs site (docs.npmjs.com) uses mdx, which is a much stricter parser. Update our docs generator site to ensure that mdx can parse our documentation as well, to ensure that we get fast feedback when it would fail. PR-URL: https://github.com/npm/cli/pull/2711 Credit: @ethomson Close: #2711 Reviewed-by: @darcyclarke
2021-02-11fix(docs): fix angle brackets in npm diff docsEdward Thomson
Emphasizing them like we do everywhere else to fix encoding errors and for consistency. Also removed the `<String>` from the type definition as we don't do that anywhere else. PR-URL: https://github.com/npm/cli/pull/2662 Credit: @ethomson Close: #2662 Reviewed-by: @wraithgar
2021-02-01doc: add note about --force overriding peer dependenciesisaacs/doc-config-force-peer-deps-overrideisaacs
PR-URL: https://github.com/npm/cli/pull/2572 Credit: @isaacs Close: #2572 Reviewed-by: @nlf
2021-02-01docs: npm team revampRuy Adorno
- Added more examples - Removed references to removed `npm team edit` subcommand - Grammar and spell check PR-URL: https://github.com/npm/cli/pull/2557 Credit: @ruyadorno Close: #2557 Reviewed-by: @wraithgar, @nlf
2021-01-28feat: add npm diffruyadorno/npm-diffRuy Adorno
- As proposed in RFC: https://github.com/npm/rfcs/pull/144 PR-URL: https://github.com/npm/cli/pull/1319 Credit: @ruyadorno Close: #1319 Reviewed-by: @isaacs
2021-01-28docs: refresh npm run-script docsRuy Adorno
- Added configuration section - Documented a few more relevant config options PR-URL: https://github.com/npm/cli/pull/2566 Credit: @ruyadorno Close: #2566 Reviewed-by: @nlf
2021-01-28docs(npm): update npm command docsGar
These are the base docs for the npm cli itself that populates `man npm`, Mostly grammar fixes, some additions and clarifications in places, new links to some appropriate other docs PR-URL: https://github.com/npm/cli/pull/2565 Credit: @wraithgar Close: #2565 Reviewed-by: @nlf
2021-01-28docs: refreshed npm updated docsRuy Adorno
PR-URL: https://github.com/npm/cli/pull/2558 Credit: @ruyadorno Close: #2558 Reviewed-by: @wraithgar
2021-01-28fix(docs): add caching docs to exec, initGar
fix grammar on caching docs for search PR-URL: https://github.com/npm/cli/pull/2542 Credit: @wraithgar Close: #2542 Reviewed-by: @ruyadorno
2021-01-28docs: updates to readme, removal, contributing & many more...darcyclarke/update-docsDarcy Clarke
- update `README.md` - update `CONTRIBUTING.md` - update `./docs/using-npm/removal.md` - update `./docs/content/commands/npm-view.md` - update `./docs/content/commands/npm-owner.md` - update `./docs/content/commands/npm-version.md` - update `./docs/content/configuring-npm/package-json.md` - update `./docs/content/using-npm/registry.md` - remove `./docs/content/using-npm/disputes.md` - remove `./docs/content/using-npm/semver.md` PR-URL: https://github.com/npm/cli/pull/2559 Credit: @darcyclarke Close: #2559 Reviewed-by: @nlf
2021-01-21docs(npm): update `npm` docsdarcyclarke-patch-npm-docsDarcy Clarke
- fix reference to issue tracker (ie. fixes #1507) - collapse contributing guideline ref - remove author-specific information (still exists in `package.json`) PR-URL: https://github.com/npm/cli/pull/2498 Credit: @darcyclarke Close: #2498 Reviewed-by: @ruyadorno
2021-01-15fix(docs): clean up `npm search` docsMichael Garvin
In which the "note on caching" is finally populated after all these years PR-URL: https://github.com/npm/cli/pull/2487 Credit: @wraithgar Close: #2487 Reviewed-by: @darcyclarke
2021-01-15fix(docs): clean up `npm token` docsMichael Garvin
grammar fixes, notes on authentication tokens, match usage output with readme PR-URL: https://github.com/npm/cli/pull/2482 Credit: @wraithgar Close: #2482 Reviewed-by: @darcyclarke
2021-01-15fix(docs): update package-lock.json docsisaacs
PR-URL: https://github.com/npm/cli/pull/2475 Credit: @isaacs Close: #2475 Reviewed-by: @wraithgar
2021-01-15fix(docs): clean up `npm unpublish` docsMichael Garvin
Mostly grammar fixes, also adds not about needing to be logged in, as per comment in https://github.com/npm/cli/issues/1880 PR-URL: https://github.com/npm/cli/pull/2474 Credit: @wraithgar Close: #2474 Reviewed-by: @darcyclarke
2021-01-15fix(docs): delineate package nameGar
Co-authored-by: Darcy Clarke <darcy@darcyclarke.me> PR-URL: https://github.com/npm/cli/pull/2464 Credit: @wraithgar Close: #2464 Reviewed-by: @darcyclarke
2021-01-15fix(docs): delineate package nameGar
Co-authored-by: Darcy Clarke <darcy@darcyclarke.me>
2021-01-15Update docs/content/commands/npm-uninstall.mdGar
Co-authored-by: Jordan Harband <ljharb@gmail.com>
2021-01-15fix(docs): re-add `-S`Michael Garvin
2021-01-15fix(docs): re-add `--save` and explanation of when it is usefulMichael Garvin
2021-01-15fix(docs): clean up `npm uninstall` docsMichael Garvin
Lots of flags removed, clarification on what `--no-save` does, consolidated examples into a separate section
2021-01-15fix(docs): clean up `npm prefix` docsMichael Garvin
Adds an example and slightly changes wording PR-URL: https://github.com/npm/cli/pull/2463 Credit: @wraithgar Close: #2463 Reviewed-by: @darcyclarke
2021-01-15fix(docs): clean up `npm test` docsMichael Garvin
Adds an example and standardizes the language w/ start and stop PR-URL: https://github.com/npm/cli/pull/2462 Credit: @wraithgar Close: #2462 Reviewed-by: @darcyclarke
2021-01-15fix(docs): clean up `npm stop` docsMichael Garvin
Adds an example and outlines differences with `npm start` PR-URL: https://github.com/npm/cli/pull/2460 Credit: @wraithgar Close: #2460 Reviewed-by: @darcyclarke
2021-01-15fix(docs): clean up `npm start` docsMichael Garvin
Adds an example, and a note about how this differs than node's default behavior PR-URL: https://github.com/npm/cli/pull/2459 Credit: @wraithgar Close: #2459 Reviewed-by: @darcyclarke
2021-01-07add foreground-scripts optionisaacs/foreground-scriptsisaacs
PR-URL: https://github.com/npm/cli/pull/2456 Credit: @isaacs Close: #2456 Reviewed-by: @ruyadorno
2021-01-07Grammatical Fix in npm-ls Documentationmarsonya
'Therefore' is spelled 'Therefor' PR-URL: https://github.com/npm/cli/pull/2436 Credit: @marsonya Close: #2436 Reviewed-by: @isaacs
2020-12-18update npm command doc feature request linksisaacs
2020-12-18Revert bug-reporting links to GH.Tieg Zaharia
Re: https://blog.npmjs.org/post/188841555980/updates-to-community-docs-more PR-URL: https://github.com/npm/cli/pull/2368 Credit: @tiegz Close: #2368 Reviewed-by: @isaacs
2020-12-18remove the metrics sendernlf/remove-metricsnlf
PR-URL: https://github.com/npm/cli/pull/2382 Credit: @nlf Close: #2382 Reviewed-by: @isaacs
2020-12-18(docs,test): assorted typo fixesXhmikosR
PR-URL: https://github.com/npm/cli/pull/2381 Credit: @XhmikosR Close: #2381 Reviewed-by: @isaacs
2020-12-18Include prerelease versions when deprecatingTieg Zaharia
PR-URL: https://github.com/npm/cli/pull/2366 Credit: @tiegz Close: #2366 Reviewed-by: @isaacs EDIT(@isaacs): updated to make _all_ deprecation ranges include prereleases. If `foo@*` would be expected to deprecate `foo@1.0.0-beta`, then presumably `foo@1.x` has the same expectation.
2020-12-18Support multiple set/get/deletes in npm configisaacs/config-set-multiisaacs
While digging into #2300, I realized it would be a lot easier if we could do this: npm config set email=me@example.com _auth=xxxx and avoid the whole issue of what gets set first. Also, why not let `npm config get foo bar baz` return just the keys specified? Also updates the docs, including the statement that `npm config set foo` with no value sets it to `true`, when as far as I can tell, that has never been the case. PR-URL: https://github.com/npm/cli/pull/2362 Credit: @isaacs Close: #2362 Reviewed-by: @nlf
2020-12-18docs: add note about INIT_CWD to run-script docisaacs
2020-12-11docs: explain through run-scriptisaacs
PR-URL: https://github.com/npm/cli/pull/2330 Credit: @isaacs Close: #2330
2020-12-04docs: don't wrap code blockEdward Thomson
Some markdown parsers don't like this. PR-URL: https://github.com/npm/cli/pull/2271 Credit: @ethomson Close: #2271 Reviewed-by: @darcyclarke
2020-12-04feat: add npm set-scriptYash-Singh1
Introduces the set-script command. It accepts two arguments, the script name and the command ref: https://github.com/npm/rfcs/blob/latest/accepted/0016-set-script-command.md PR-URL: https://github.com/npm/cli/pull/2237 Credit: @Yash-Singh1 Close: #2237 Reviewed-by: @ruyadorno
2020-12-04Do not run interactive exec in CI when a TTYisaacs
Credit: @isaacs PR-URL: https://github.com/npm/cli/pull/2202 Close: #2202 Reviewed-by: @darcyclarke
2020-12-03Use @npmcli/run-script for exec, explore; add interactive execisaacs
This removes all other arg/shell escaping mechanisms, as they are no longer needed, and will be un-done by puka in @npmcli/run-script anyway. Adds an interactive shell mode when `npm exec` is run without any arguments, allowing users to interactively test out commands in an npm script environment. Previously, this would do nothing, and just exit. Prevent weird behavior from `npm explore ../blah`. `explore` now can _only_ be used to explore packages that are actually found in the relevant `node_modules` folder.
2020-11-27docs: npm star cleanupRuy Adorno
Fix: https://github.com/npm/statusboard/issues/245 Fix: https://github.com/npm/statusboard/issues/246 PR-URL: https://github.com/npm/cli/pull/2241 Credit: @ruyadorno Close: #2241 Reviewed-by: @darcyclarke
2020-11-27Fix broken link to package.json documentationDaniel Fischer
PR-URL: https://github.com/npm/cli/pull/2238 Credit: @d-fischer Close: #2238 Reviewed-by: @ruyadorno
2020-11-27Update config.mdAlex Woollam
line 435: aknowledging->acknowledging line 1099: overwhich -> over which PR-URL: https://github.com/npm/cli/pull/2200 Credit: @alexwoollam Close: #2200 Reviewed-by: @darcyclarke
2020-11-27doc: remove doc on obsolete `unsafe-perm` flagkai zhu
replace obsolete doc about root-privilege with changelog notes @ https://github.com/npm/cli/blob/e1a2837809a76896523cdfcbce7537e46f71d67e/CHANGELOG.md#v700-beta0-2020-08-04 PR-URL: https://github.com/npm/cli/pull/2196 Credit: @kaizhu256 Close: #2196 Reviewed-by: @darcyclarke