PackageJson (nodejs-gradle-plugin 4.0.4 API)

org.ysb33r.gradle.nodejs.PackageJson

```
@groovy.transform.CompileStatic
@SuppressWarnings(value: [DuplicateStringLiteral])
class PackageJson
extends Object
```
Parses a package.json file.
This is not a complete representation. It is only meant to provide enough information for the plugin to make reasonable decisions about packages.
Authors:
Schalk W. Cronjé
Since:
0.13

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`PackageJson.Element`
`static enum`	`PackageJson.Indentation`	Indentation to use when writing files.

Field Summary

Fields
Modifiers	Name	Description
`static String`	`PACKAGE_JSON`

Properties Summary

Properties
Type	Name and description
`String`	`name`
`String`	`version`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.Map<String, ?>`	`asMap()` Returns all properties as map which will be suitable for writing out as JSON again.
	`static String`	`formatName(String name)` Formats a name suitable for `package.json`.
	`static String`	`formatVersion(String ver, boolean forceSemver)` Formats a supplied version into a NPM-safe version
	`Iterable<String>`	`getBundledDependencies()`
	`java.util.Map<String, String>`	`getDependencies()`
	`String`	`getDescription()`
	`java.util.Map<String, String>`	`getDevDependencies()`
	`String`	`getHomepage()`
	`java.util.List<String>`	`getKeywords()`
	`String`	`getLicense()`
	`String`	`getName()`
	`java.util.Map<String, String>`	`getOptionalDependencies()`
	`java.util.Map<String, String>`	`getPeerDependencies()`
	`java.util.Map<String, String>`	`getScripts()`
	`String`	`getVersion()`
	`static String`	`loadVersionFromPackageJson(File packageJson)` Loads the version string.
	`static PackageJson`	`of(String ver, String name)` Creates a base object consisting only of a name and version.
	`static PackageJson`	`parsePackageJson(File packageJson)` Parses a `package.json` file.
	`static Object`	`parsePackageJsonToGPath(File packageJson)` Parses a `package.json` file.
	`static java.util.Map<String, ?>`	`parsePackageJsonToMap(File packageJson)` Parses a `package.json` file.
	`void`	`setName(String nm)`
	`void`	`setVersion(String ver)`
	`void`	`writeToFile(File destFile, PackageJson.Indentation indent, boolean sortElements)` Writes the contents to a `package.json` file

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Field Detail
  - public static final String PACKAGE_JSON
- Property Detail
  - String name
  - String version
- Method Detail
  - java.util.Map<String, ?> asMap()
    
    Returns all properties as map which will be suitable for writing out as JSON again. @return
  - static String formatName(String name)
    
    Formats a name suitable for package.json.
    Parameters:
    name - Proposed name
    Returns:
    Package name
    See Also:
    https
  - @SuppressWarnings(value: DuplicateStringLiteral) static String formatVersion(String ver, boolean forceSemver)
    
    Formats a supplied version into a NPM-safe version
    Parameters:
    ver - Version. When the version is unspecified or null, it uses 0.0.0-alpha.0 as the version.
    forceSemver - Whether semantiv versioning should be enforced.
    Returns:
    A version string
  - Iterable<String> getBundledDependencies()
  - java.util.Map<String, String> getDependencies()
  - String getDescription()
  - java.util.Map<String, String> getDevDependencies()
  - String getHomepage()
  - java.util.List<String> getKeywords()
  - String getLicense()
  - String getName()
  - java.util.Map<String, String> getOptionalDependencies()
  - java.util.Map<String, String> getPeerDependencies()
  - java.util.Map<String, String> getScripts()
  - String getVersion()
  - static String loadVersionFromPackageJson(File packageJson)
    
    Loads the version string.
    Parameters:
    packageJson - packageJson Location of file.
    Returns:
    Version string.
    Since:
    2.0
  - static PackageJson of(String ver, String name)
    
    Creates a base object consisting only of a name and version.
    Parameters:
    ver - Version
    name - Project name
    Returns:
    Instance with version and name set.
  - static PackageJson parsePackageJson(File packageJson)
    
    Parses a package.json file.
    Parameters:
    packageJson - Location of file.
    Returns:
    Reasonable representation.
  - static Object parsePackageJsonToGPath(File packageJson)
    
    Parses a package.json file.
    Parameters:
    packageJson - Location of file.
    Returns:
    Groovy GPath-based representation.
  - static java.util.Map<String, ?> parsePackageJsonToMap(File packageJson)
    
    Parses a package.json file.
    Parameters:
    packageJson - Location of file.
    Returns:
    Map-based representation.
  - void setName(String nm)
  - void setVersion(String ver)
  - void writeToFile(File destFile, PackageJson.Indentation indent, boolean sortElements)
    
    Writes the contents to a package.json file
    Parameters:
    destFile - File path of which the filename should be package.json.
    indent - Whether to use two-space or four-space indentation
    sortElements - Whether to sort elements by the rules of https.

Summary:
Nested
Field
Property
Method

| Detail:
Field
Property
Method

Groovy Documentation

[Groovy] Class PackageJson

Nested Class Summary

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String PACKAGE_JSON

Property Detail

String name

String version

Method Detail

java.util.Map<String, ?> asMap()

static String formatName(String name)

@SuppressWarnings(value: DuplicateStringLiteral) static String formatVersion(String ver, boolean forceSemver)

Iterable<String> getBundledDependencies()

java.util.Map<String, String> getDependencies()

String getDescription()

java.util.Map<String, String> getDevDependencies()

String getHomepage()

java.util.List<String> getKeywords()

String getLicense()

String getName()

java.util.Map<String, String> getOptionalDependencies()

java.util.Map<String, String> getPeerDependencies()

java.util.Map<String, String> getScripts()

String getVersion()

static String loadVersionFromPackageJson(File packageJson)

static PackageJson of(String ver, String name)

static PackageJson parsePackageJson(File packageJson)

static Object parsePackageJsonToGPath(File packageJson)

static java.util.Map<String, ?> parsePackageJsonToMap(File packageJson)

void setName(String nm)

void setVersion(String ver)

void writeToFile(File destFile, PackageJson.Indentation indent, boolean sortElements)