An open API service indexing awesome lists of open source software.

https://github.com/e5r/gulp-dotnet5

Gulp plugin for .NET 5
https://github.com/e5r/gulp-dotnet5

Last synced: 2 months ago
JSON representation

Gulp plugin for .NET 5

Awesome Lists containing this project

README

        

gulp-dotnet5
============

Gulp plugin for .NET 5.

## Wat is new!

See [NEWS.md](NEWS.md) file.

## Installation

```
npm install gulp-dotnet5
```

## Usage

Preferably, save this as dev dependency during installation:

```
npm install gulp-dotnet5 --save-dev
```

```javascript
var gulp = require('gulp'),
dotnet = require('gulp-dotnet5');

gulp.task('build', function() {
return gulp.src('**/project.json')
.pipe(dotnet.dnu('restore', {
verbose: true,
args: [
'<%= file.path %>',
'--no-cache',
'--quiet'
]
}))
.pipe(dotnet.dnu('build', {
outPathBase: './build',
args: [
'<%= file.path %>',
'--out', '<%= outPath %>',
'--configuration', 'Release'
]
}));
});
```

## API

### .dnu(action, options)

Run the DNU (Microsoft .NET Development Utility) tool.

#### action
type: `String`

A action to make up the DNU command.

Eg: action `restore` generate command `dnu restore`.

#### options.env
type: `Object`

default `process.env`.

Environment variables for process. You override the original variables with this option.

#### options.cwd
type: `String`

default: `process.cwd()`

Sets the current working directory for the command.

#### options.verbose
type: `Boolean`

default: `false`

If `true`, it will print the command output and other log messages.

#### options.outPathBase
type: `String`

default: `%FILE.PATH%/bin/artifacts`

Base path to join with the way .NET component and provide the variable `outPath` that can be used in arguments.

Eg:

`outPathBase => './build'` and `component => './src/My.Component/project.json'` creates `outPath => './build/My.Component'`.

#### options.forceContinueIfError
type: `Boolean`

default: `false`

If `true`, not stop task if error.

#### options.args
type: `Array` of `String`

A list of arguments for the command line tool. Use `<%= VarName %>` in the argument string.

##### Possible variables:
* `file.path`: Absolute pathname of `project.json` file.
* `file.relative`: path.relative of `project.json` file.
* `file.dirname`: path.dirname of `project.json` file.
* `file.basename`: path.basename of `project.json` file.
* `file.stem`: (filename without suffix) of `project.json` file.
* `file.extname`: path.extname of `project.json` file.
* `outPath`: Combination of `options.outPathBase` with the .NET component directory name.

### .dnx(command, options)

> TODO: Not implemented!

### .dnvm(command, options)

> TODO: Not implemented!