npm-publish-gradle-plugin/dev.petuska.npm.publish.extension.domain.json/PackageJson

PackageJson

abstract class PackageJson : GenericJsonObject

A class representing package.json schema. Custom fields can be added as regular map entries.

Constructors

PackageJson

fun PackageJson()

Functions

author

fun author(action: Action<Person>)

Override and configure the author field

bin

fun bin(action: Action<JsonObject<String>>)

Override and configure the bin field

bugs

fun bugs(action: Action<Bugs>)

Override and configure the bugs field

infix fun String.by(value: GenericJsonObject.() -> Unit)

infix fun String.by(value: Action<GenericJsonObject>)

Set a custom object value for this JsonObject

infix fun String.by(value: Any)

Set a custom value for this JsonObject

config

fun config(action: Action<GenericJsonObject>)

Override and configure the config field

dependencies

fun dependencies(action: Action<JsonObject<String>>)

Override and configure the dependencies field

devDependencies

fun devDependencies(action: Action<JsonObject<String>>)

Override and configure the devDependencies field

directories

fun directories(action: Action<Directories>)

Override and configure the directories field

engines

fun engines(action: Action<JsonObject<String>>)

Override and configure the engines field

finalise

open override fun finalise(): MutableMap<String, Any>

Resolves the underlying json value to a MutableMap instance, recursively merging known and custom properties and resolving all Provider values

json

fun json(value: GenericJsonObject.() -> Unit): GenericJsonObject

fun json(value: Action<GenericJsonObject>): GenericJsonObject

Build a custom object value

man

fun man(action: Action<JsonObject<String>>)

Override and configure the man field

optionalDependencies

fun optionalDependencies(action: Action<JsonObject<String>>)

Override and configure the optionalDependencies field

peerDependencies

fun peerDependencies(action: Action<JsonObject<String>>)

Override and configure the peerDependencies field

Person

fun Person(action: Action<Person>): Person

Create and configure an instance of Person

publishConfig

fun publishConfig(action: Action<PublishConfig>)

Override and configure the publishConfig field

repository

fun repository(action: Action<Repository>)

Override and configure the repository field

scripts

fun scripts(action: Action<JsonObject<String>>)

Override and configure the scripts field

set

operator fun set(key: String, value: Any)

Set a custom value

operator fun set(key: String, value: Provider<Any>)

Set a custom value provider to be resolved when finalise is invoked

Properties

author

@get:Optional

abstract val author: Property<Person>

author

bin

@get:Optional

abstract val bin: Property<JsonObject<String>>

bin

browser

@get:Input

@get:Optional

abstract val browser: Property<String>

browser

bugs

@get:Optional

abstract val bugs: Property<Bugs>

bugs

bundledDependencies

@get:Input

@get:Optional

abstract val bundledDependencies: SetProperty<String>

bundledDependencies Top priority if set, disregards all the other configurations

config

@get:Optional

abstract val config: Property<GenericJsonObject>

config

contributors

@get:Optional

abstract val contributors: SetProperty<Person>

contributors

cpu

@get:Input

@get:Optional

abstract val cpu: ListProperty<String>

cpu

dependencies

@get:Optional

abstract val dependencies: Property<JsonObject<String>>

dependencies

description

@get:Input

@get:Optional

abstract val description: Property<String>

description

devDependencies

@get:Optional

abstract val devDependencies: Property<JsonObject<String>>

devDependencies

directories

@get:Optional

abstract val directories: Property<Directories>

directories

engines

@get:Optional

abstract val engines: Property<JsonObject<String>>

engines

files

@get:Input

@get:Optional

abstract val files: SetProperty<String>

files

homepage

@get:Input

@get:Optional

abstract val homepage: Property<String>

homepage

keywords

@get:Input

@get:Optional

abstract val keywords: SetProperty<String>

keywords

license

@get:Input

@get:Optional

abstract val license: Property<String>

license

main

@get:Input

@get:Optional

abstract val main: Property<String>

main

man

@get:Optional

abstract val man: Property<JsonObject<String>>

man

name

@get:Input

@get:Optional

abstract val name: Property<String>

name

optionalDependencies

@get:Optional

abstract val optionalDependencies: Property<JsonObject<String>>

optionalDependencies

@get:Input

@get:Optional

abstract val os: ListProperty<String>

peerDependencies

@get:Optional

abstract val peerDependencies: Property<JsonObject<String>>

peerDependencies

private

@get:Input

@get:Optional

abstract val private: Property<Boolean>

private

publishConfig

@get:Optional

abstract val publishConfig: Property<PublishConfig>

publishConfig

repository

@get:Optional

abstract val repository: Property<Repository>

repository

scripts

@get:Optional

abstract val scripts: Property<JsonObject<String>>

scripts

types

@get:Input

@get:Optional

abstract val types: Property<String>

types

version

@get:Input

@get:Optional

abstract val version: Property<String>

version