From 2ba9e262c20b7cf854679b0f41797f732c6968fc Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Mon, 18 May 2020 14:38:50 +0800 Subject: [PATCH] Meta tweaks --- license | 2 +- package.json | 3 ++- readme.md | 16 ++++++---------- 3 files changed, 9 insertions(+), 12 deletions(-) diff --git a/license b/license index e7af2f77..fa7ceba3 100644 --- a/license +++ b/license @@ -1,6 +1,6 @@ MIT License -Copyright (c) Sindre Sorhus (sindresorhus.com) +Copyright (c) Sindre Sorhus (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: diff --git a/package.json b/package.json index 5d0a36b4..c8ee95cb 100644 --- a/package.json +++ b/package.json @@ -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" diff --git a/readme.md b/readme.md index e446209d..852ea01f 100644 --- a/readme.md +++ b/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 @@ -26,7 +24,6 @@ grunt.initConfig({ grunt.registerTask('default', ['eslint']); ``` - ## Examples ### Custom config and rules @@ -56,7 +53,6 @@ grunt.initConfig({ }); ``` - ## Options See the [ESLint options](https://eslint.org/docs/developer-guide/nodejs-api#cliengine). @@ -65,7 +61,7 @@ In addition the following options are supported: ### format -Type: `string`
+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. @@ -74,28 +70,28 @@ Some formatters you might find useful: [eslint-json](https://github.com/sindreso ### outputFile -Type: `string`
+Type: `string`\ Default: `''` Output the report to a file. ### quiet -Type: `boolean`
+Type: `boolean`\ Default: `false` Report errors only. ### maxWarnings -Type: `number`
+Type: `number`\ Default: `-1` *(Means no limit)* Number of warnings to trigger non-zero exit code. ### failOnError -Type: `boolean`
+Type: `boolean`\ Default: `true` Fail the build if ESLint found any errors.