Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NpmPublishCommand

Hierarchy

Properties

access

access: undefined | string = Option.String(`--access`, {description: `The access for the published package (public or restricted)`,})

cwd

cwd: undefined | string = Option.String(`--cwd`, {hidden: true})

otp

otp: undefined | string = Option.String(`--otp`, {description: `The OTP token to use with the command`,})

tag

tag: string = Option.String(`--tag`, `latest`, {description: `The tag on the registry that the package should be attached to`,})

tolerateRepublish

tolerateRepublish: boolean = Option.Boolean(`--tolerate-republish`, false, {description: `Warn and exit when republishing an already existing version of a package`,})

Static paths

paths: string[][] = [[`npm`, `publish`],]

Static usage

usage: Usage = Command.Usage({category: `Npm-related commands`,description: `publish the active workspace to the npm registry`,details: `This command will pack the active workspace into a fresh archive and upload it to the npm registry.The package will by default be attached to the \`latest\` tag on the registry, but this behavior can be overriden by using the \`--tag\` option.Note that for legacy reasons scoped packages are by default published with an access set to \`restricted\` (aka "private packages"). This requires you to register for a paid npm plan. In case you simply wish to publish a public scoped package to the registry (for free), just add the \`--access public\` flag. This behavior can be enabled by default through the \`npmPublishAccess\` settings.`,examples: [[`Publish the active workspace`,`yarn npm publish`,]],})

Methods

execute

  • execute(): Promise<0 | 1>

Generated using TypeDoc