npm - @smithery/api - Versions diffs - 0.11.0 → 0.13.0 - Mend

@smithery/api 0.11.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2215) hide show

package/oidc/node_modules/npm/docs/content/commands/npm-prune.md DELETED Viewed

@@ -1,199 +0,0 @@
----
-title: npm-prune
-section: 1
-description: Remove extraneous packages
----
-### Synopsis
-```bash
-npm prune [[<@scope>/]<pkg>...]
-```
-### Description
-This command removes "extraneous" packages.
-If a package name is provided, then only packages matching one of the supplied names are removed.
-Extraneous packages are those present in the `node_modules` folder that are not listed as any package's dependency list.
-If the `--omit=dev` flag is specified or the `NODE_ENV` environment variable is set to `production`, this command will remove the packages specified in your `devDependencies`.
-If the `--dry-run` flag is used then no changes will actually be made.
-If the `--json` flag is used, then the changes `npm prune` made (or would have made with `--dry-run`) are printed as a JSON object.
-In normal operation, extraneous modules are pruned automatically, so you'll only need this command with the `--production` flag.
-However, in the real world, operation is not always "normal".  When crashes or mistakes happen, this command can help clean up any resulting garbage.
-### Configuration
-#### `omit`
-* Default: 'dev' if the `NODE_ENV` environment variable is set to
-  'production'; otherwise, empty.
-* Type: "dev", "optional", or "peer" (can be set multiple times)
-Dependency types to omit from the installation tree on disk.
-Note that these dependencies _are_ still resolved and added to the
-`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
-physically installed on disk.
-If a package type appears in both the `--include` and `--omit` lists,
-then it will be included.
-If the resulting omit list includes `'dev'`, then the `NODE_ENV`
-environment variable will be set to `'production'` for all lifecycle
-scripts.
-#### `include`
-* Default:
-* Type: "prod", "dev", "optional", or "peer" (can be set multiple
-  times)
-Option that allows for defining which types of dependencies to
-install.
-This is the inverse of `--omit=<type>`.
-Dependency types specified in `--include` will not be omitted,
-regardless of the order in which omit/include are specified on the
-command-line.
-#### `dry-run`
-* Default: false
-* Type: Boolean
-Indicates that you don't want npm to make any changes and that it
-should only report what it would have done. This can be passed into
-any of the commands that modify your local installation, eg,
-`install`, `update`, `dedupe`, `uninstall`, as well as `pack` and
-`publish`.
-Note: This is NOT honored by other network related commands, eg
-`dist-tags`, `owner`, etc.
-#### `json`
-* Default: false
-* Type: Boolean
-Whether or not to output JSON data, rather than the normal output.
-* In `npm pkg set` it enables parsing set values with JSON.parse()
-  before saving them to your `package.json`.
-Not supported by all npm commands.
-#### `foreground-scripts`
-* Default: `false` unless when using `npm pack` or `npm publish` where
-  it defaults to `true`
-* Type: Boolean
-Run all build scripts (ie, `preinstall`, `install`, and
-`postinstall`) scripts for installed packages in the foreground
-process, sharing standard input, output, and error with the main npm
-process.
-Note that this will generally make installs run slower, and be much
-noisier, but can be useful for debugging.
-#### `ignore-scripts`
-* Default: false
-* Type: Boolean
-If true, npm does not run scripts specified in package.json files.
-Note that commands explicitly intended to run a particular script,
-such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm
-run` will still run their intended script if `ignore-scripts` is set,
-but they will *not* run any pre- or post-scripts.
-#### `workspace`
-* Default:
-* Type: String (can be set multiple times)
-Enable running a command in the context of the configured workspaces
-of the current project while filtering by running only the workspaces
-defined by this configuration option.
-Valid values for the `workspace` config are either:
-* Workspace names
-* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
-  workspaces within that folder)
-When set for the `npm init` command, this may be set to the folder of
-a workspace which does not yet exist, to create the folder and set it
-up as a brand new workspace within the project.
-This value is not exported to the environment for child processes.
-#### `workspaces`
-* Default: null
-* Type: null or Boolean
-Set to true to run the command in the context of **all** configured
-workspaces.
-Explicitly setting this to false will cause commands like `install`
-to ignore workspaces altogether. When not set explicitly:
-- Commands that operate on the `node_modules` tree (install, update,
-etc.) will link workspaces into the `node_modules` folder. - Commands
-that do other things (test, exec, publish, etc.) will operate on the
-root project, _unless_ one or more workspaces are specified in the
-`workspace` config.
-This value is not exported to the environment for child processes.
-#### `include-workspace-root`
-* Default: false
-* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
-When false, specifying individual workspaces via the `workspace`
-config, or all workspaces via the `workspaces` flag, will cause npm
-to operate only on the specified workspaces, and not on the root
-project.
-This value is not exported to the environment for child processes.
-#### `install-links`
-* Default: false
-* Type: Boolean
-When set file: protocol dependencies will be packed and installed as
-regular dependencies instead of creating a symlink. This option has
-no effect on workspaces.
-### See Also
-* [npm uninstall](/commands/npm-uninstall)
-* [npm folders](/configuring-npm/folders)
-* [npm ls](/commands/npm-ls)

package/oidc/node_modules/npm/docs/content/commands/npm-publish.md DELETED Viewed

@@ -1,222 +0,0 @@
----
-title: npm-publish
-section: 1
-description: Publish a package
----
-### Synopsis
-```bash
-npm publish <package-spec>
-```
-### Description
-Publishes a package to the registry so that it can be installed by name.
-By default npm will publish to the public registry.
-This can be overridden by specifying a different default registry or using a [`scope`](/using-npm/scope) in the name, combined with a scope-configured registry (see [`package.json`](/configuring-npm/package-json)).
-A `package` is interpreted the same way as other commands (like `npm install`) and can be:
-* a) a folder containing a program described by a [`package.json`](/configuring-npm/package-json) file
-* b) a gzipped tarball containing (a)
-* c) a url that resolves to (b)
-* d) a `<name>@<version>` that is published on the registry (see [`registry`](/using-npm/registry)) with (c)
-* e) a `<name>@<tag>` (see [`npm dist-tag`](/commands/npm-dist-tag)) that points to (d)
-* f) a `<name>` that has a "latest" tag satisfying (e)
-* g) a `<git remote url>` that resolves to (a)
-The publish will fail if the package name and version combination already exists in the specified registry.
-Once a package is published with a given name and version, that specific name and version combination can never be used again, even if it is removed with [`npm unpublish`](/commands/npm-unpublish).
-As of `npm@5`, both a sha1sum and an integrity field with a sha512sum of the tarball will be submitted to the registry during publication.
-Subsequent installs will use the strongest supported algorithm to verify downloads.
-Similar to `--dry-run` see [`npm pack`](/commands/npm-pack), which figures out the files to be included and packs them into a tarball to be uploaded to the registry.
-### Files included in package
-To see what will be included in your package, run `npm pack --dry-run`.
-All files are included by default, with the following exceptions:
-- Certain files that are relevant to package installation and distribution are always included.
-For example, `package.json`, `README.md`,
-  `LICENSE`, and so on.
-- If there is a "files" list in [`package.json`](/configuring-npm/package-json), then only the files specified will be included.
- (If directories are specified, then they will be walked recursively and their contents included, subject to the same ignore rules.)
-- If there is a `.gitignore` or `.npmignore` file, then ignored files in that and all child directories will be excluded from the package.
-  If _both_ files exist, then the `.gitignore` is ignored, and only the
-  `.npmignore` is used.
-  `.npmignore` files follow the [same pattern rules](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) as `.gitignore` files
-- If the file matches certain patterns, then it will _never_ be included, unless explicitly added to the `"files"` list in `package.json`, or un-ignored with a `!` rule in a `.npmignore` or `.gitignore` file.
-- Symbolic links are never included in npm packages.
-See [`developers`](/using-npm/developers) for full details on what's included in the published package, as well as details on how the package is built.
-See [`package.json`](/configuring-npm/package-json) for more info on what can and can't be ignored.
-### Configuration
-#### `tag`
-* Default: "latest"
-* Type: String
-If you ask npm to install a package and don't tell it a specific
-version, then it will install the specified tag.
-It is the tag added to the package@version specified in the `npm
-dist-tag add` command, if no explicit tag is given.
-When used by the `npm diff` command, this is the tag used to fetch
-the tarball that will be compared with the local files by default.
-If used in the `npm publish` command, this is the tag that will be
-added to the package submitted to the registry.
-#### `access`
-* Default: 'public' for new packages, existing packages it will not
-  change the current level
-* Type: null, "restricted", or "public"
-If you do not want your scoped package to be publicly viewable (and
-installable) set `--access=restricted`.
-Unscoped packages cannot be set to `restricted`.
-Note: This defaults to not changing the current access level for
-existing packages. Specifying a value of `restricted` or `public`
-during publish will change the access for an existing package the
-same way that `npm access set status` would.
-#### `dry-run`
-* Default: false
-* Type: Boolean
-Indicates that you don't want npm to make any changes and that it
-should only report what it would have done. This can be passed into
-any of the commands that modify your local installation, eg,
-`install`, `update`, `dedupe`, `uninstall`, as well as `pack` and
-`publish`.
-Note: This is NOT honored by other network related commands, eg
-`dist-tags`, `owner`, etc.
-#### `otp`
-* Default: null
-* Type: null or String
-This is a one-time password from a two-factor authenticator. It's
-needed when publishing or changing package permissions with `npm
-access`.
-If not set, and a registry response fails with a challenge for a
-one-time password, npm will prompt on the command line for one.
-#### `workspace`
-* Default:
-* Type: String (can be set multiple times)
-Enable running a command in the context of the configured workspaces
-of the current project while filtering by running only the workspaces
-defined by this configuration option.
-Valid values for the `workspace` config are either:
-* Workspace names
-* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
-  workspaces within that folder)
-When set for the `npm init` command, this may be set to the folder of
-a workspace which does not yet exist, to create the folder and set it
-up as a brand new workspace within the project.
-This value is not exported to the environment for child processes.
-#### `workspaces`
-* Default: null
-* Type: null or Boolean
-Set to true to run the command in the context of **all** configured
-workspaces.
-Explicitly setting this to false will cause commands like `install`
-to ignore workspaces altogether. When not set explicitly:
-- Commands that operate on the `node_modules` tree (install, update,
-etc.) will link workspaces into the `node_modules` folder. - Commands
-that do other things (test, exec, publish, etc.) will operate on the
-root project, _unless_ one or more workspaces are specified in the
-`workspace` config.
-This value is not exported to the environment for child processes.
-#### `include-workspace-root`
-* Default: false
-* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
-When false, specifying individual workspaces via the `workspace`
-config, or all workspaces via the `workspaces` flag, will cause npm
-to operate only on the specified workspaces, and not on the root
-project.
-This value is not exported to the environment for child processes.
-#### `provenance`
-* Default: false
-* Type: Boolean
-When publishing from a supported cloud CI/CD system, the package will
-be publicly linked to where it was built and published from.
-This config cannot be used with: `provenance-file`
-#### `provenance-file`
-* Default: null
-* Type: Path
-When publishing, the provenance bundle at the given path will be
-used.
-This config cannot be used with: `provenance`
-### See Also
-* [package spec](/using-npm/package-spec)
-* [npm-packlist package](http://npm.im/npm-packlist)
-* [npm registry](/using-npm/registry)
-* [npm scope](/using-npm/scope)
-* [npm adduser](/commands/npm-adduser)
-* [npm owner](/commands/npm-owner)
-* [npm deprecate](/commands/npm-deprecate)
-* [npm dist-tag](/commands/npm-dist-tag)
-* [npm pack](/commands/npm-pack)
-* [npm profile](/commands/npm-profile)

package/oidc/node_modules/npm/docs/content/commands/npm-query.md DELETED Viewed

@@ -1,272 +0,0 @@
----
-title: npm-query
-section: 1
-description: Dependency selector query
----
-### Synopsis
-```bash
-npm query <selector>
-```
-### Description
-The `npm query` command allows for usage of css selectors in order to retrieve an array of dependency objects.
-### Piping npm query to other commands
-```bash
-# find all dependencies with postinstall scripts & uninstall them
-npm query ":attr(scripts, [postinstall])" | jq 'map(.name)|join("\n")' -r | xargs -I {} npm uninstall {}
-# find all git dependencies & explain who requires them
-npm query ":type(git)" | jq 'map(.name)' | xargs -I {} npm why {}
-```
-### Extended Use Cases & Queries
-```stylus
-// all deps
-*
-// all direct deps
-:root > *
-// direct production deps
-:root > .prod
-// direct development deps
-:root > .dev
-// any peer dep of a direct deps
-:root > * > .peer
-// any workspace dep
-.workspace
-// all workspaces that depend on another workspace
-.workspace > .workspace
-// all workspaces that have peer deps
-.workspace:has(.peer)
-// any dep named "lodash"
-// equivalent to [name="lodash"]
-#lodash
-// any deps named "lodash" & within semver range ^"1.2.3"
-#lodash@^1.2.3
-// equivalent to...
-[name="lodash"]:semver(^1.2.3)
-// get the hoisted node for a given semver range
-#lodash@^1.2.3:not(:deduped)
-// querying deps with a specific version
-#lodash@2.1.5
-// equivalent to...
-[name="lodash"][version="2.1.5"]
-// has any deps
-:has(*)
-// deps with no other deps (ie. "leaf" nodes)
-:empty
-// manually querying git dependencies
-[repository^=github:],
-[repository^=git:],
-[repository^=https://github.com],
-[repository^=http://github.com],
-[repository^=https://github.com],
-[repository^=+git:...]
-// querying for all git dependencies
-:type(git)
-// get production dependencies that aren't also dev deps
-.prod:not(.dev)
-// get dependencies with specific licenses
-[license=MIT], [license=ISC]
-// find all packages that have @ruyadorno as a contributor
-:attr(contributors, [email=ruyadorno@github.com])
-```
-### Example Response Output
-- an array of dependency objects is returned which can contain multiple copies of the same package which may or may not have been linked or deduped
-```json
-[
-  {
-    "name": "",
-    "version": "",
-    "description": "",
-    "homepage": "",
-    "bugs": {},
-    "author": {},
-    "license": {},
-    "funding": {},
-    "files": [],
-    "main": "",
-    "browser": "",
-    "bin": {},
-    "man": [],
-    "directories": {},
-    "repository": {},
-    "scripts": {},
-    "config": {},
-    "dependencies": {},
-    "devDependencies": {},
-    "optionalDependencies": {},
-    "bundledDependencies": {},
-    "peerDependencies": {},
-    "peerDependenciesMeta": {},
-    "engines": {},
-    "os": [],
-    "cpu": [],
-    "workspaces": {},
-    "keywords": [],
-    ...
-  },
-  ...
-```
-### Expecting a certain number of results
-One common use of `npm query` is to make sure there is only one version of a certain dependency in your tree.
-This is especially common for ecosystems like that rely on `typescript` where having state split across two different but identically-named packages causes bugs.
-You can use the `--expect-results` or `--expect-result-count` in your setup to ensure that npm will exit with an exit code if your tree doesn't look like you want it to.
-```sh
-$ npm query '#react' --expect-result-count=1
-```
-Perhaps you want to quickly check if there are any production dependencies that could be updated:
-```sh
-$ npm query ':root>:outdated(in-range).prod' --no-expect-results
-```
-### Package lock only mode
-If package-lock-only is enabled, only the information in the package lock (or shrinkwrap) is loaded.
-This means that information from the package.json files of your dependencies will not be included in the result set (e.g. description, homepage, engines).
-### Configuration
-#### `global`
-* Default: false
-* Type: Boolean
-Operates in "global" mode, so that packages are installed into the
-`prefix` folder instead of the current working directory. See
-[folders](/configuring-npm/folders) for more on the differences in
-behavior.
-* packages are installed into the `{prefix}/lib/node_modules` folder,
-  instead of the current working directory.
-* bin files are linked to `{prefix}/bin`
-* man pages are linked to `{prefix}/share/man`
-#### `workspace`
-* Default:
-* Type: String (can be set multiple times)
-Enable running a command in the context of the configured workspaces
-of the current project while filtering by running only the workspaces
-defined by this configuration option.
-Valid values for the `workspace` config are either:
-* Workspace names
-* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
-  workspaces within that folder)
-When set for the `npm init` command, this may be set to the folder of
-a workspace which does not yet exist, to create the folder and set it
-up as a brand new workspace within the project.
-This value is not exported to the environment for child processes.
-#### `workspaces`
-* Default: null
-* Type: null or Boolean
-Set to true to run the command in the context of **all** configured
-workspaces.
-Explicitly setting this to false will cause commands like `install`
-to ignore workspaces altogether. When not set explicitly:
-- Commands that operate on the `node_modules` tree (install, update,
-etc.) will link workspaces into the `node_modules` folder. - Commands
-that do other things (test, exec, publish, etc.) will operate on the
-root project, _unless_ one or more workspaces are specified in the
-`workspace` config.
-This value is not exported to the environment for child processes.
-#### `include-workspace-root`
-* Default: false
-* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
-When false, specifying individual workspaces via the `workspace`
-config, or all workspaces via the `workspaces` flag, will cause npm
-to operate only on the specified workspaces, and not on the root
-project.
-This value is not exported to the environment for child processes.
-#### `package-lock-only`
-* Default: false
-* Type: Boolean
-If set to true, the current operation will only use the
-`package-lock.json`, ignoring `node_modules`.
-For `update` this means only the `package-lock.json` will be updated,
-instead of checking `node_modules` and downloading dependencies.
-For `list` this means the output will be based on the tree described
-by the `package-lock.json`, rather than the contents of
-`node_modules`.
-#### `expect-results`
-* Default: null
-* Type: null or Boolean
-Tells npm whether or not to expect results from the command. Can be
-either true (expect some results) or false (expect no results).
-This config cannot be used with: `expect-result-count`
-#### `expect-result-count`
-* Default: null
-* Type: null or Number
-Tells to expect a specific number of results from the command.
-This config cannot be used with: `expect-results`
-## See Also
-* [dependency selectors](/using-npm/dependency-selectors)