Skip to content

Commit

Permalink
Meta tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed May 18, 2020
1 parent a8f45f6 commit 2ba9e26
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 12 deletions.
2 changes: 1 addition & 1 deletion license
@@ -1,6 +1,6 @@
MIT License

Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
3 changes: 2 additions & 1 deletion package.json
Expand Up @@ -4,10 +4,11 @@
"description": "Validate files with ESLint",
"license": "MIT",
"repository": "sindresorhus/grunt-eslint",
"funding": "https://github.com/sponsors/sindresorhus",
"author": {
"name": "Sindre Sorhus",
"email": "sindresorhus@gmail.com",
"url": "sindresorhus.com"
"url": "https://sindresorhus.com"
},
"engines": {
"node": ">=10"
Expand Down
16 changes: 6 additions & 10 deletions readme.md
@@ -1,17 +1,15 @@
# grunt-eslint [![Build Status](https://travis-ci.org/sindresorhus/grunt-eslint.svg?branch=master)](https://travis-ci.org/sindresorhus/grunt-eslint)
# grunt-eslint [![Build Status](https://travis-ci.com/sindresorhus/grunt-eslint.svg?branch=master)](https://travis-ci.com/github/sindresorhus/grunt-eslint)

> Validate files with [ESLint](https://eslint.org)
![](screenshot.png)


## Install

```
$ npm install --save-dev grunt-eslint
```


## Usage

```js
Expand All @@ -26,7 +24,6 @@ grunt.initConfig({
grunt.registerTask('default', ['eslint']);
```


## Examples

### Custom config and rules
Expand Down Expand Up @@ -56,7 +53,6 @@ grunt.initConfig({
});
```


## Options

See the [ESLint options](https://eslint.org/docs/developer-guide/nodejs-api#cliengine).
Expand All @@ -65,7 +61,7 @@ In addition the following options are supported:

### format

Type: `string`<br>
Type: `string`\
Default: `'stylish'`

Name of a [built-in formatter](https://github.com/eslint/eslint/tree/master/lib/cli-engine/formatters) or path to a custom one.
Expand All @@ -74,28 +70,28 @@ Some formatters you might find useful: [eslint-json](https://github.com/sindreso

### outputFile

Type: `string`<br>
Type: `string`\
Default: `''`

Output the report to a file.

### quiet

Type: `boolean`<br>
Type: `boolean`\
Default: `false`

Report errors only.

### maxWarnings

Type: `number`<br>
Type: `number`\
Default: `-1` *(Means no limit)*

Number of warnings to trigger non-zero exit code.

### failOnError

Type: `boolean`<br>
Type: `boolean`\
Default: `true`

Fail the build if ESLint found any errors.

0 comments on commit 2ba9e26

Please sign in to comment.