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.
| Modifiers | Name | Description |
|---|---|---|
static class |
PackageJson.Element |
|
static enum |
PackageJson.Indentation |
Identation to use when writing files. |
| Modifiers | Name | Description |
|---|---|---|
static java.lang.String |
PACKAGE_JSON |
| Type Params | Return Type | Name and description |
|---|---|---|
|
java.util.Map<java.lang.String, ?> |
asMap()Returns all properties as map which will be suitable for writing out as JSON again. |
|
static java.lang.String |
formatName(java.lang.String name)Formats a name suitable for package.json. |
|
static java.lang.String |
formatVersion(java.lang.String ver, boolean forceSemver)Formats a supplied version into a NPM-safe version |
|
java.lang.Iterable<java.lang.String> |
getBundledDependencies() |
|
java.util.Map<java.lang.String, java.lang.String> |
getDependencies() |
|
java.lang.String |
getDescription() |
|
java.util.Map<java.lang.String, java.lang.String> |
getDevDependencies() |
|
java.lang.String |
getHomepage() |
|
java.util.List<java.lang.String> |
getKeywords() |
|
java.lang.String |
getLicense() |
|
java.lang.String |
getName() |
|
java.util.Map<java.lang.String, java.lang.String> |
getOptionalDependencies() |
|
java.util.Map<java.lang.String, java.lang.String> |
getPeerDependencies() |
|
java.util.Map<java.lang.String, java.lang.String> |
getScripts() |
|
java.lang.String |
getVersion() |
|
static java.lang.String |
loadVersionFromPackageJson(java.io.File packageJson)Loads the version string. |
|
static PackageJson |
of(java.lang.String ver, java.lang.String name)Creates a base object consisting only of a name and version. |
|
static PackageJson |
parsePackageJson(java.io.File packageJson)Parses a package.json file. |
|
static java.lang.Object |
parsePackageJsonToGPath(java.io.File packageJson)Parses a package.json file. |
|
static java.util.Map<java.lang.String, ?> |
parsePackageJsonToMap(java.io.File packageJson)Parses a package.json file. |
|
void |
setName(java.lang.String nm) |
|
void |
setVersion(java.lang.String ver) |
|
void |
writeToFile(java.io.File destFile, PackageJson.Indentation indent, boolean sortElements)Writes the contents to a package.json file |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Returns all properties as map which will be suitable for writing out as JSON again.
Formats a name suitable for package.json.
name - Proposed nameFormats a supplied version into a NPM-safe version
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.Loads the version string.
packageJson - packageJson Location of file.Creates a base object consisting only of a name and version.
ver - Versionname - Project name Parses a package.json file.
packageJson - Location of file. Parses a package.json file.
packageJson - Location of file. Parses a package.json file.
packageJson - Location of file. Writes the contents to a package.json file
destFile - File path of which the filename should be package.json.indent - Whether to use two-space or four-space indentationsortElements - Whether to sort elements by the rules of
https.