Task that will sync the project version into the package.json
file.
Modifiers | Name | Description |
---|---|---|
static enum |
SyncProjectToPackageJson.PackageConflict |
Modifiers | Name | Description |
---|---|---|
static SyncProjectToPackageJson.PackageConflict |
GRADLE |
|
static SyncProjectToPackageJson.PackageConflict |
PACKAGE_JSON |
Fields inherited from class | Fields |
---|---|
class org.gradle.api.DefaultTask |
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS |
Type | Name and description |
---|---|
org.gradle.api.provider.Provider<java.util.List<java.lang.String>> |
configurationNames List of configuration names that must be searched for NPM dependencies |
SyncProjectToPackageJson.PackageConflict |
conflictMode If there are version differences between the dependencies specified in package.json and the
dependencies block, specify which system has precedence. |
boolean |
forceSemver Force NPM semantic versioning to be used. |
boolean |
forceTwoSpaceIndent Whether to force a two-space indent when rewriting the file. |
java.lang.Object |
packageJsonFile |
java.lang.Object |
packageJsonName |
java.lang.Object |
packageJsonVersion |
boolean |
sortOutput Sorts the output keys. |
Constructor and description |
---|
SyncProjectToPackageJson
() |
Type Params | Return Type | Name and description |
---|---|---|
|
void |
exec() |
|
org.gradle.api.provider.Provider<java.io.File> |
getPackageJsonFile() Location of the package.json file. |
|
org.gradle.api.provider.Provider<java.lang.String> |
getPackageJsonName() Project name that will be use for package.json |
|
org.gradle.api.provider.Provider<java.lang.String> |
getPackageJsonVersion() Version that will be use for package.json |
|
void |
npmConfigurations(java.lang.Object... configs) Adds configurations which contain NPM dependencies. |
|
void |
setPackageJsonFile(java.lang.Object file) Set the location of the package.json file |
|
void |
setPackageJsonName(java.lang.Object projName) Set the name for package.json file. |
|
void |
setPackageJsonVersion(java.lang.Object ver) Set the version for package.json file. |
Methods inherited from class | Name |
---|---|
class org.gradle.api.DefaultTask |
org.gradle.api.DefaultTask#getTimeout(), org.gradle.api.DefaultTask#getLogger(), org.gradle.api.DefaultTask#getProject(), org.gradle.api.DefaultTask#setDescription(java.lang.String), org.gradle.api.DefaultTask#getIdentityPath(), org.gradle.api.DefaultTask#getStandardOutputCapture(), org.gradle.api.DefaultTask#setGroup(java.lang.String), org.gradle.api.DefaultTask#getAnt(), org.gradle.api.DefaultTask#getConvention(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#getDidWork(), org.gradle.api.DefaultTask#getAsDynamicObject(), org.gradle.api.DefaultTask#getMustRunAfter(), org.gradle.api.DefaultTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.DefaultTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.DefaultTask#getFinalizedBy(), org.gradle.api.DefaultTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getShouldRunAfter(), org.gradle.api.DefaultTask#setActions(java.util.List), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getDependsOn(), org.gradle.api.DefaultTask#setDependsOn(java.lang.Iterable), org.gradle.api.DefaultTask#dependsOn([Ljava.lang.Object;), org.gradle.api.DefaultTask#onlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#doLast(groovy.lang.Closure), org.gradle.api.DefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#doLast(org.gradle.api.Action), org.gradle.api.DefaultTask#getEnabled(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getDestroyables(), org.gradle.api.DefaultTask#getLocalState(), org.gradle.api.DefaultTask#getTemporaryDir(), org.gradle.api.DefaultTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getSharedResources(), org.gradle.api.DefaultTask#setDidWork(boolean), org.gradle.api.DefaultTask#doFirst(groovy.lang.Closure), org.gradle.api.DefaultTask#doFirst(org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#getTaskIdentity(), org.gradle.api.DefaultTask#hasTaskActions(), org.gradle.api.DefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.gradle.api.DefaultTask#getTaskActions(), org.gradle.api.DefaultTask#getOnlyIf(), org.gradle.api.DefaultTask#getImpliesSubProjects(), org.gradle.api.DefaultTask#setImpliesSubProjects(boolean), org.gradle.api.DefaultTask#replaceLogger(org.gradle.api.logging.Logger), org.gradle.api.DefaultTask#getTemporaryDirFactory(), org.gradle.api.DefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#isHasCustomActions(), org.gradle.api.DefaultTask#requiresResource(java.lang.String), org.gradle.api.DefaultTask#requiresResource(java.lang.String, int), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#isEnabled(), org.gradle.api.DefaultTask#getDescription(), org.gradle.api.DefaultTask#setEnabled(boolean), org.gradle.api.DefaultTask#property(java.lang.String), org.gradle.api.DefaultTask#hasProperty(java.lang.String), org.gradle.api.DefaultTask#getGroup(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.DefaultTask#toString(), org.gradle.api.DefaultTask#compareTo(org.gradle.api.Task), org.gradle.api.DefaultTask#compareTo(java.lang.Object), org.gradle.api.DefaultTask#getName(), org.gradle.api.DefaultTask#getActions(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getPath(), org.gradle.api.DefaultTask#getExtensions(), org.gradle.api.DefaultTask#wait(long, int), org.gradle.api.DefaultTask#wait(long), org.gradle.api.DefaultTask#wait(), org.gradle.api.DefaultTask#equals(java.lang.Object), org.gradle.api.DefaultTask#hashCode(), org.gradle.api.DefaultTask#getClass(), org.gradle.api.DefaultTask#notify(), org.gradle.api.DefaultTask#notifyAll() |
List of configuration names that must be searched for NPM dependencies
If there are version differences between the dependencies specified in package.json
and the
dependencies
block, specify which system has precedence. By default is is Gradle.
Force NPM semantic versioning to be used.
If project.version is 1.0
then 1.0.0
will used as the version for package.json
.
Like if the version is 1.0-alpha1
then 1.0.0-alpha1
will be used.
Semantic versioning is forced by default.
Whether to force a two-space indent when rewriting the file.
Sorts the output keys. Mimics the functionality of https://www.npmjs.com/package/sort-package-json. Default is to not sort.
Location of the package.json
file.
package.json
Project name that will be use for package.json
Version that will be use for package.json
Adds configurations which contain NPM dependencies.
These dependencies will added to the correct scope in the package.json
file.
configs
- Configurations instances or anything that can be resolved to a configuration name. Set the location of the package.json
file
file
- Anything convertible to a java.io.File using org.ysb33r.grolifant.api.v4.FileUtils#fileize Set the name for package.json
file. If not set it will default
to a NPM-safe project.name
.
projName
- Anything convertible to a string using org.ysb33r.grolifant.api.v4.StringUtils#stringize. Set the version for package.json
file. If not set, it will default
to project.version
.
ver
- Anything convertible to a string using org.ysb33r.grolifant.api.v4.StringUtils#stringize.Groovy Documentation