com.github.ug_dbg

Class CleanMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.ug_dbg.AbstractMojo

com.github.ug_dbg.CleanMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="clean",
      threadSafe=true,
      defaultPhase=CLEAN)
public class CleanMojo
extends AbstractMojo

Goal to clean an npm workspace. Delete :

• dist
• node-modules
• package-lock

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	deleteNodeModules If 'true', delete the node-modules directory.
private boolean	deletePackageLock If 'true', delete the package-lock file.
private String	distDir The npm dist directory name.
private String	nodeModulesDir The node modules dir.
private String	packageLockFile The package-lock.
private File	workingDir The working directory.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
CleanMojo()

Method Summary

Modifier and Type	Method and Description
private void	delete(File file) Delete a file and log the deletion status.
void	execute()

Methods inherited from class com.github.ug_dbg.AbstractMojo

getCommand, isWindows, logLevel, parseArgument, useLogHandler

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

workingDir

@Parameter(property="npm.workingDir",
           defaultValue="${basedir}")
private File workingDir

The working directory. Optional. If not specified, basedir will be used.

distDir

@Parameter(property="npm.distDir",
           defaultValue="dist")
private String distDir

The npm dist directory name. Optional. If not specified, 'dist' will be used.

nodeModulesDir

@Parameter(property="npm.nodeModulesDir",
           defaultValue="node_modules")
private String nodeModulesDir

The node modules dir. Optional. If not specified, 'node_modules' will be used.

packageLockFile

@Parameter(property="npm.packageLockFile",
           defaultValue="package-lock.json")
private String packageLockFile

The package-lock. Optional. If not specified, 'package-lock.json' will be used.

deleteNodeModules

@Parameter(property="npm.deleteNodeModules",
           defaultValue="false")
private boolean deleteNodeModules

If 'true', delete the node-modules directory. Default is 'false'.

deletePackageLock

@Parameter(property="npm.deletePackageLock",
           defaultValue="false")
private boolean deletePackageLock

If 'true', delete the package-lock file. Default is 'false'.

Constructor Detail

CleanMojo

public CleanMojo()

Method Detail

execute

public void execute()

delete

private void delete(File file)

Delete a file and log the deletion status. Do not throw any exception.

Parameters:

file - the file to delete.