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-05-06feat(config): add workspaces boolean to user-agentnlf
PR-URL: https://github.com/npm/cli/pull/3187 Credit: @nlf Close: #3187 Reviewed-by: @wraithgar
2021-05-06fix(docs): fix broken linkswangsai
PR-URL: https://github.com/npm/cli/pull/3182 Credit: @wangsai Close: #3182 Reviewed-by: @wraithgar
2021-05-06feat(cache): Allow `add` to accept multiple specsMarco Sirabella
This is a backwards incompatible change to the undocumented `cache add pkg version`, but Motivations for this can be found here: https://github.com/npm/cli/pull/2976#issuecomment-811511134 Signed-off-by: Marco Sirabella <marco@sirabella.org> PR-URL: https://github.com/npm/cli/pull/3098 Credit: @mjsir911 Close: #3098 Reviewed-by: @wraithgar
2021-04-29docs: mention `directories.bin` in `bin`Felipe Santos
PR-URL: https://github.com/npm/cli/pull/3146 Credit: @felipecrs Close: #3146 Reviewed-by: @wraithgar
2021-04-24Remove --always-auth config definitionisaacs
As of the recent updates to npm-registry-fetch and @npmcli/config, this config field is no longer used anywhere. Prior to those changes, it was used, but not in the manner documented.
2021-04-22feat: add init workspacesRuy Adorno
Add workspaces support to `npm init` - Fixes `npm exec` respecting `script-shell` option value - Refactored `lib/exec.js` into `libnpmexec` - Updates init-package-json@2.0.3 - Added ability to create a new workspace using the -w config PR-URL: https://github.com/npm/cli/pull/3095 Credit: @ruyadorno Close: #3095 Reviewed-by: @wraithgar
2021-04-22docs: fix refs to ws shorthandRuy Adorno
Normalizes usage of `--ws` in docs. Fixes: https://github.com/npm/statusboard/issues/313 PR-URL: https://github.com/npm/cli/pull/3109 Credit: @ruyadorno Close: #3109 Reviewed-by: @wraithgar
2021-04-22chore(docs): update view docsGar
Adds workspace/json config PR-URL: https://github.com/npm/cli/pull/3101 Credit: @wraithgar Close: #3101 Reviewed-by: @ruyadorno
2021-04-15feat(version): add workspace supportGar
PR-URL: https://github.com/npm/cli/pull/3055 Credit: @wraithgar Close: #3055 Reviewed-by: @darcyclarke
2021-04-14feat(bugs): fall back to email if providedYash Singh
If a bugs url is not provided, but a `mailto` is, then that is used. PR-URL: https://github.com/npm/cli/pull/3052 Credit: @Yash-Singh1 Close: #3052 Reviewed-by: @wraithgar
2021-04-08feat(pack): add workspace supportGar
PR-URL: https://github.com/npm/cli/pull/3033 Credit: @wraithgar Close: #3033 Reviewed-by: @darcyclarke
2021-04-08feat(workspaces): implement workspace support for dist-tagnlf
PR-URL: https://github.com/npm/cli/pull/3032 Credit: @nlf Close: #3032 Reviewed-by: @wraithgar
2021-04-01fix(docs): add workspaces configurationGar
Adds workspaces configuration to `docs`, `repo`, and `set-script`. PR-URL: https://github.com/npm/cli/pull/3013 Credit: @wraithgar Close: #3013 Reviewed-by: @darcyclarke
2021-04-01usage: specify the key each time for multiplesisaacs
If a user runs 'npm install -w foo bar baz', that won't set 'bar' and 'baz' as workspace names. The correct incantation is 'npm install -w foo -w bar -w baz'. PR-URL: https://github.com/npm/cli/pull/3016 Credit: @isaacs Close: #3016 Reviewed-by: @wraithgar
2021-04-01Add a 'envExport' flag for config definitionsisaacs/add-env-export-false-flag-for-config-defsisaacs
It defaults to true, but setting it to any falsey value will tell `@npmcli/config` not to export it into the environment, and will also put a remark in the documentation that it is not exported. PR-URL: https://github.com/npm/cli/pull/3014 Credit: @isaacs Close: #3014 Reviewed-by: @nlf
2021-04-01feat(view): add workspace supportGar
PR-URL: https://github.com/npm/cli/pull/3001 Credit: @wraithgar Close: #3001 Reviewed-by: @nlf
2021-03-29change 'maxsockets' default value back to 15Andreas
The default value for 'maxsockets' was changed during the refactoring in #2878 from 50 to 'Inifinity', this PR changes it to the more accurate value of 15, which was the default used in: https://github.com/npm/make-fetch-happen/blob/785af652ec0c8f108a43004903afd2183af93904/agent.js#L15 Fixes #2978 PR-URL: https://github.com/npm/cli/pull/2979 Credit: @wallrat Close: #2979 Reviewed-by: @ruyadorno Co-authored-by: Gar <gar+gh@danger.computer>
2021-03-29docs: fix spelling in workspaces.md fileSeth Thomas
PR-URL: https://github.com/npm/cli/pull/2973 Credit: @sethomas Close: #2973 Reviewed-by: @wraithgar, @nosisky
2021-03-25chore(docs): update prod configRuy Adorno
2021-03-24config: Restore --dev flag, unify --omit flattenersisaacs
This consolidates all the various --include and --omit configuration flatteners into a single function, since they have to be interdependent in order to function properly. Fix: #2936 PR-URL: https://github.com/npm/cli/pull/2942 Credit: @isaacs Close: #2942 Reviewed-by: @wraithgar
2021-03-23fix docs generation for yes configRuy Adorno
2021-03-22feat: add exec workspacesRuy Adorno
Add workspaces support to `npm exec` - Refactored logic to read and filter workspaces into `lib/workspaces/get-workspaces.js` - Added location context message when entering interactive shell using `npm exec` (with no args) - Add ability to execute a package in the context of each configured workspace Fixes: https://github.com/npm/statusboard/issues/288 PR-URL: https://github.com/npm/cli/pull/2886 Credit: @ruyadorno Close: #2886 Reviewed-by: @wraithgar
2021-03-22fix(usage): tie usage to configGar
This starts us down the path of tying the params our commands accept to their config items. For now it is optional, and not every current config item would cleanly render if we added them today. The ones that are added here DO render nicely, and we can iterate from here. We can also at a later date do the same kind of appraoch with our positional args. PR-URL: https://github.com/npm/cli/pull/2908 Credit: @wraithgar Close: #2908 Reviewed-by: @nlf, @isaacs
2021-03-19feat: add run-script workspacesRuy Adorno
- Add workspaces-related configs: - workspace: list of workspaces names/dir to filter for - workspaces: boolean value to enable/disable workspaces awareness - adds the proposed note in the docs of each of the commands that are not affected by these configs. - Add workspaces support to `npm run-script` - add ability to serially run lifecycle scripts in workspaces - add ability to list scripts for all workspaces - add colors to `npm run` (no args) output Relates to: https://github.com/npm/rfcs/pull/117 Fixes: https://github.com/npm/statusboard/issues/276 Fixes: https://github.com/npm/statusboard/issues/283 Fixes: https://github.com/npm/statusboard/issues/284 Fixes: https://github.com/npm/statusboard/issues/285 Fixes: https://github.com/npm/statusboard/issues/286 PR-URL: https://github.com/npm/cli/pull/2864 Credit: @ruyadorno Close: #2864 Reviewed-by: @wraithgar
2021-03-18docs(package-json): document default main behaviorkbayrhammer
PR-URL: https://github.com/npm/cli/pull/2881 Credit: @klausbayrhammer Close: #2881 Reviewed-by: @wraithgar
2021-03-18docs(configuring-npm): Fix broken linkKarthik Sundari
PR-URL: https://github.com/npm/cli/pull/2860 Credit: @varmakarthik12 Close: #2860 Reviewed-by: @wraithgar
2021-03-18feat(help): refactor npm help/help-searchGar
Lots of dead code removed thanks to streamlining of logic. `npm help` `npm <command>` and `npm help-search` are all now separated concerns, handling their own use cases. `help` calls `help-search` as a last resort, but `npm <command>` no longer tries to wind its way through to `help-search` just to get the basic npm usage displayed. The `did you mean` output has been expanded. It now always suggests top level commands, scripts, and bins, and suggests them in the way they should be called. PR-URL: https://github.com/npm/cli/pull/2859 Credit: @wraithgar Close: #2859 Reviewed-by: @ruyadorno
2021-03-18Auto-generate 'npm help 7 config' from actual definitionsisaacs
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