io.jenkins.plugins.conventionalcommits.utils

Class NpmProjectType

java.lang.Object

io.jenkins.plugins.conventionalcommits.utils.NpmProjectType

public class NpmProjectType
extends Object

Class to interact with a NPM project type.

Constructor Summary

Constructors

Constructor and Description
NpmProjectType()

Method Summary

Modifier and Type	Method and Description
boolean	check(File directory) Check if the project is a NPM project (i.e a package.json is found).
com.github.zafarkhaja.semver.Version	getCurrentVersion(File directory, ProcessHelper processHelper) Return the next version of the version attribute.
void	writeVersion(File directory, com.github.zafarkhaja.semver.Version nextVersion, ProcessHelper processHelper) Write back to the package.json file the next version. Use the npm command version, see : https://docs.npmjs.com/cli/v6/commands/npm-version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NpmProjectType

public NpmProjectType()

Method Detail

check

public boolean check(File directory)

Check if the project is a NPM project (i.e a package.json is found).

Parameters:

directory - The directory of the project.

Returns:

True if a package.json is found.

getCurrentVersion

public com.github.zafarkhaja.semver.Version getCurrentVersion(File directory,
                                                              ProcessHelper processHelper)
                                                       throws IOException

Return the next version of the version attribute.

Parameters:

directory - The project's directory.

processHelper - Not used.

Returns:

The next calculated version (based on Semver).

Throws:

IOException - If an error occur reading files.

writeVersion

public void writeVersion(File directory,
                         com.github.zafarkhaja.semver.Version nextVersion,
                         ProcessHelper processHelper)
                  throws IOException,
                         InterruptedException

Write back to the package.json file the next version.
Use the npm command version, see : https://docs.npmjs.com/cli/v6/commands/npm-version.

Parameters:

directory - The directory where write the file.

nextVersion - The next version to use.

processHelper - The helper to run the command.

Throws:

IOException - If errors occurs when write the file

InterruptedException - It errors occurs with the npm command.