npm-publish-gradle-plugin/dev.petuska.npm.publish.extension.domain/NpmPackage

NpmPackage

abstract class NpmPackage : WithGradleFactories, NamedInput

The main configuration for a package

Constructors

NpmPackage

fun NpmPackage()

Functions

dependencies

fun dependencies(action: Action<NpmDependencies>)

Convenience DSL to configure package's dependencies

dependency

fun NpmDependencies.dependency( name: String, version: String, type: NpmDependency.Type, action: Action<NpmDependency> = Action { }): NamedDomainObjectProvider<NpmDependency>

Registers an arbitrary npm dependency for the package

dev

fun NpmDependencies.dev( name: String, version: String, action: Action<NpmDependency> = Action { }): NamedDomainObjectProvider<NpmDependency>

Registers a dev npm dependency for the package

files

fun files(action: Action<ConfigurableFileCollection>)

Convenience DSL to configure package's files

getName

@Input

abstract override fun getName(): String

normal

fun NpmDependencies.normal( name: String, version: String, action: Action<NpmDependency> = Action { }): NamedDomainObjectProvider<NpmDependency>

Registers a normal npm dependency for the package

optional

fun NpmDependencies.optional( name: String, version: String, action: Action<NpmDependency> = Action { }): NamedDomainObjectProvider<NpmDependency>

Registers an optional npm dependency for the package

packageJson

fun packageJson(action: Action<PackageJson>)

Convenience DSL to customise package.json

peer

fun NpmDependencies.peer( name: String, version: String, action: Action<NpmDependency> = Action { }): NamedDomainObjectProvider<NpmDependency>

Registers a peer npm dependency for the package

Properties

dependencies

abstract val dependencies: NpmDependencies

Package's npm dependencies.

files

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val files: ConfigurableFileCollection

Files that should be assembled for this package

main

@get:Input

@get:Optional

abstract val main: Property<String>

Main js entry file. Can also be set via packageJsonFile, packageJsonTemplateFile or packageJson

npmIgnore

@get:InputFile

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val npmIgnore: RegularFileProperty

A location of the .npmignore file. Defaults to NpmPublishExtension.npmIgnore

packageJson

@get:Optional

abstract val packageJson: Property<PackageJson>

package.json customisation container.

packageJsonFile

@get:InputFile

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val packageJsonFile: RegularFileProperty

If set, fully disregards main, types&packageJson configurations. Used as-is.

packageJsonTemplateFile

@get:InputFile

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val packageJsonTemplateFile: RegularFileProperty

Similar to packageJsonFile except allows the options to be overridden by the packageJson options.

packageName

@get:Input

abstract val packageName: Property<String>

NPM package name. Defaults to Project.getName.

readme

@get:InputFile

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val readme: RegularFileProperty

A location of the README.md file. If set, the file will be moved to package assembly root and renamed to README.md (regardless of the actual name). Defaults to NpmPublishExtension.readme

scope

@get:Input

@get:Optional

abstract val scope: Property<String>

Optional npm scope. If set, the package name will be constructed as @{scope}/{packageName}. Defaults to NpmPublishExtension.organization.

types

@get:Input

@get:Optional

abstract val types: Property<String>

Main d.ts entry file. Can also be set via packageJsonFile, packageJsonTemplateFile or packageJson

version

@get:Input

abstract val version: Property<String>

NPM package version. Defaults to NpmPublishExtension.version.