npm-publish-gradle-plugin/dev.petuska.npm.publish.extension/NpmPublishExtension

NpmPublishExtension

abstract class NpmPublishExtension : WithGradleFactories, ExtensionAware, NpmAccessScope

An extension for npm-publish plugin configuration

Constructors

NpmPublishExtension

constructor()

Types

Companion

object Companion

Properties

access

abstract val access: Property<NpmAccess>

Default package access when publishing to npm registries. Defaults to NpmAccess.PUBLIC

dry

abstract val dry: Property<Boolean>

Specifies if a dry-run should be added to the npm command arguments by default. Dry run does all the normal run des except actual file uploading. Defaults to false.

nodeBin

abstract val nodeBin: RegularFileProperty

Path to node executable. If not set, defaults to [nodeHome]/bin/node.

nodeHome

abstract val nodeHome: DirectoryProperty

Base NodeJS directory to be used when executing npm commands. Defaults to NODE_HOME env variable.

npmBin

abstract val npmBin: RegularFileProperty

Path to npm executable. If not set, defaults to [nodeHome]/bin/npm.

npmIgnore

abstract val npmIgnore: RegularFileProperty

A location of the default .npmignore file. If set, it will be used as a default for all packages that do not have one set explicitly.

npmrc

abstract val npmrc: RegularFileProperty

A location of the default .npmrc file. If set, it will be used as a default for all registries that do not have one set explicitly.

organization

abstract val organization: Property<String>

Default package scope. If set, it will be used as a default for all packages that do not have one set explicitly.

packages

abstract val packages: NpmPackages

A container for npm package configurations

PUBLIC

open val PUBLIC: NpmAccess

readme

abstract val readme: RegularFileProperty

A location of the default README.md file. If set, it will be used as a default for all packages that do not have one set explicitly.

registries

abstract val registries: NpmRegistries

A container for npm registry configurations

RESTRICTED

open val RESTRICTED: NpmAccess

version

abstract val version: Property<String>

Default package version. Defaults to Project.getVersion or rootProject.version. If set, it will be used as a default for all packages that do not have one set explicitly.