id       = "np"
name     = "np"
homepage = "https://github.com/sindresorhus/np"
description = "A better npm publish."
executables   = ["np"]

[dotfiles]

# README (sindresorhus/np), "Config": when using the global np binary, the CLI
# flags can be set in a .np-config.js (as CJS), .np-config.cjs, .np-config.mjs
# or .np-config.json file in the home directory. The project-level copies —
# the same file names beside package.json, or a top-level "np" field in
# package.json — belong to the repository, not to the user, so they are not
# listed here.
paths = [
  "~/.np-config.json",
  "~/.np-config.js",
  "~/.np-config.cjs",
  "~/.np-config.mjs",
]

exclude = []

# The file holds release flags — branch name, test script, dist-tag. npm
# credentials are npm's own (~/.npmrc), not np's.
secret = []

# Read once per `np` run.
side_effect = false

# No machine_lines: every configurable flag is a release preference the user
# wants wherever they publish from.

[commands]
format = 1
label = "Publish package"
description = "Interactive npm publish with version bump, tests and git tag. Only flags in the completion data are offered."
quality = "ai-draft"
base = "fig:np"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = false, short_bundles = false }

[[commands.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/np.ts"
license = "MIT"

[[commands.field]]
id = "version"
label = "Version or bump"
type = "string"
position = 0
suggestions = [{ value = "patch", label = "patch" }, { value = "minor", label = "minor" }, { value = "major", label = "major" }]
sources = ["fig"]

[[commands.field]]
id = "tag"
label = "Dist-tag"
type = "string"
option = ["--tag"]
sources = ["fig"]

[[commands.field]]
id = "branch"
label = "Release branch"
type = "string"
option = ["--branch"]
sources = ["fig"]

[[commands.field]]
id = "any_branch"
label = "Any branch"
type = "boolean"
option = ["--any-branch"]
sources = ["fig"]

[[commands.field]]
id = "no_tests"
label = "Skip tests"
type = "boolean"
option = ["--no-tests"]
sources = ["fig"]

[[commands.field]]
id = "no_cleanup"
label = "Skip cleanup"
type = "boolean"
option = ["--no-cleanup"]
sources = ["fig"]

[[commands.field]]
id = "no_publish"
label = "Skip publishing"
type = "boolean"
option = ["--no-publish"]
sources = ["fig"]

[[commands.field]]
id = "preview"
label = "Preview tasks only"
type = "boolean"
option = ["--preview"]
sources = ["fig"]

[[commands.field]]
id = "contents"
label = "Subdirectory to publish"
type = "path"
option = ["--contents"]
path = { kind = "directory", role = "input" }
sources = ["fig"]

[[commands.field]]
id = "message"
label = "Version commit message"
type = "string"
option = ["--message"]
sources = ["fig"]

[[commands.field]]
id = "no_release_draft"
label = "Skip GitHub release draft"
type = "boolean"
option = ["--no-release-draft"]
sources = ["fig"]

[[commands.field]]
id = "no_2fa"
label = "Do not enable 2FA on new packages"
type = "boolean"
option = ["--no-2fa"]
sources = ["fig"]

[[commands.field]]
id = "test_script"
label = "Test script name"
type = "string"
option = ["--test-script"]
sources = ["fig"]

[[commands.task]]
id = "preview"
label = "Preview release"
fields = ["version", "tag"]
required = []
set = { preview = [true] }

[[commands.task]]
id = "release"
label = "Release"
fields = ["version", "tag", "branch", "no_tests"]
required = []

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["version", "tag", "no_tests", "preview"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["no_cleanup", "no_publish", "contents", "message", "no_release_draft", "no_2fa", "test_script", "any_branch", "branch"]