Interface Options

The level of messages to log (default: 'suggestion').

• suggestion: logs all messages
• warning: logs only warning and error messages
• error: logs only error messages

The package manager to use for packing the pkgDir. The list of packed files is used in certain linting rules, e.g. files marked as entrypoints but not published.

• 'auto': Automatically detects the package manager using package-manager-detector.
• 'npm'/'yarn'/'pnpm'/'bun': Uses the respective package manager to pack.
• { tarball }: The packed tarball represented as an ArrayBuffer or a ReadableStream.
• { files }: The manually-unpacked files from a tarball.
• false: Skips packing the package. This should only be used if all the files in pkgDir are assumed to be published, e.g. in node_modules.

::: info Environment notes

• Node.js: Defaults to 'auto'. All options above are supported. When using a package manager to pack, lifecycle scripts like prepack and postpack are ignored (except for yarn as it does not allow ignoring lifecycle scripts).
• Browser: Only { tarball } and { files } are supported and either must be passed to work, as the browser does not have access to the file system. :::

Path to your package that contains a package.json file.

::: info Environment notes

• Node.js: Defaults to process.cwd().
• Browser: Automatically inferred from { tarball: ArrayBuffer | ReadableStream }. If { files: PackFile[] } is used, this must be the shared directory of all files in files. e.g. if name has "package/src/index.js", the pkgDir should be "package". :::

Report warnings as errors. This runs before level filters the result, which means that if level is set to 'error', all warnings (elevated as errors) will still be reported.