Skip to content

Commit

Permalink
Prepare for release of v5.0.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin P. Jung committed May 20, 2020
1 parent 36fdda1 commit 955ee5d
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 5 deletions.
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This file lists all of the people that contributed to this project so far.
* Åsmund Grammeltvedt <asgramme@microsoft.com>
* Christian Budde Christensen <budde377@gmail.com>
* Dmitry Broznich <xmbroz@gmail.com>
* Kaustubh Gadre <kaustubh.gadre@cerner.com>
* Olivier Lemasle <o.lemasle@gmail.com>
* Ruben <rr@headwire.com>
* Søren Jepsen <soren.jepsen@se.com>
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,24 @@ Suppress the transfer progress when downloading/uploading in interactive mode if
#### `batchMode` (default: ```false```)
Run in non-interactive (batch) mode (disables output color) if set to ```true```.

#### `alsoMake` (default: ```false```)
If project list is specified, also build projects required by the list

#### `logFile` (default: ```undefined```)
Log file where all build output will go (disables output color).

## Executing Maven commands

Executing Maven commands is simple, too:

```javascript
mvn.execute(commands, defines);
```

You can optionally specify a list of projects to be build:

```javascript
mvn.execute(commands, defines);
mvn.execute(commands, defines, projects)
```

`commands` is just a list of lifecycle phases and/or goals, e.g. ```'compile'```, ```[ 'clean', 'install' ]``` or ```[ 'release:prepare', 'release:perform' ]```.
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json.schemastore.org/package#",
"name": "maven",
"version": "4.7.0",
"version": "5.0.0",
"description": "Maven wrapper for Node.js",
"main": "index.js",
"preferGlobal": false,
Expand All @@ -24,6 +24,7 @@
"Åsmund Grammeltvedt <asgramme@microsoft.com>",
"Christian Budde Christensen <budde377@gmail.com>",
"Dmitry Broznich <xmbroz@gmail.com>",
"Kaustubh Gadre <kaustubh.gadre@cerner.com>",
"Olivier Lemasle <o.lemasle@gmail.com>",
"Ruben <rr@headwire.com>",
"Søren Jepsen <soren.jepsen@se.com>",
Expand All @@ -36,7 +37,7 @@
},
"homepage": "https://github.com/headcr4sh/node-maven",
"engines": {
"node": ">=4.0.0"
"node": ">=12.0.0"
},
"typings": "./typings.d.ts"
}
6 changes: 5 additions & 1 deletion typings.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ export type MavenOptions = {
threads?: number
/** Suppress the transfer progress when downloading/uploading in interactive mode if set to <code>true</code> */
noTransferProgress?: boolean,
/** Builds the specific list of projects and any that depend on them, if set to <code>true</code>. */
alsoMake?: boolean
/** Run in non-interactive (batch) mode (disables output color) if set to <code>true</code> */
batchMode?: boolean
/** Log file where all build output will go (disables output color) (Results in <code>-l ${file}</code>) */
Expand Down Expand Up @@ -70,8 +72,10 @@ interface Maven {
* @param defines
* List of defines that will be passed to the Java VM via
* <code>-Dkey=value</code>
* @param projects
* List of projects to be build.
*/
execute(commands: string | string[], defines?: { [name: string]: string }): Promise<void>;
execute(commands: string | string[], defines?: { [name: string]: string }, projects?: string[]): Promise<void>;

}

Expand Down

0 comments on commit 955ee5d

Please sign in to comment.