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

NpmPublishExtension

abstract class NpmPublishExtension : WithGradleFactories, ExtensionAware, NpmAccessScope
Content copied to clipboard

An extension for npm-publish plugin configuration

See also

Constructors

Link copied to clipboard
fun NpmPublishExtension()
Content copied to clipboard

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
@Internal
abstract fun getExtensions(): ExtensionContainer
Content copied to clipboard
Link copied to clipboard
fun NpmRegistries.github(action: Action<NpmRegistry>): NamedDomainObjectProvider<NpmRegistry>
Content copied to clipboard

Registers GitHub Packages registry. More info

Link copied to clipboard
fun NpmRegistries.npmjs(action: Action<NpmRegistry>): NamedDomainObjectProvider<NpmRegistry>
Content copied to clipboard

Registers npmjs.com registry. More info

Link copied to clipboard
fun packages(action: Action<NpmPackages>)
Content copied to clipboard

Convenience DSL to configure npm packages

Link copied to clipboard
fun registries(action: Action<NpmRegistries>)
Content copied to clipboard

Convenience DSL to configure npm registries

Properties

Link copied to clipboard
abstract val access: Property<NpmAccess>
Content copied to clipboard

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

Link copied to clipboard
abstract val dry: Property<Boolean>
Content copied to clipboard

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.

Link copied to clipboard
abstract val nodeHome: DirectoryProperty
Content copied to clipboard

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

Link copied to clipboard
abstract val npmIgnore: RegularFileProperty
Content copied to clipboard

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.

Link copied to clipboard
abstract val organization: Property<String>
Content copied to clipboard

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

Link copied to clipboard
abstract val packages: NpmPackages
Content copied to clipboard

A container for npm package configurations

Link copied to clipboard
open val PUBLIC: NpmAccess
Content copied to clipboard
Link copied to clipboard
abstract val readme: RegularFileProperty
Content copied to clipboard

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.

Link copied to clipboard
abstract val registries: NpmRegistries
Content copied to clipboard

A container for npm registry configurations

Link copied to clipboard
open val RESTRICTED: NpmAccess
Content copied to clipboard
Link copied to clipboard
abstract val version: Property<String>
Content copied to clipboard

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.