@enormora/eslint-config-ava 0.0.12 → 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +7 -2
  2. package/readme.md +29 -0
package/package.json CHANGED
@@ -1,17 +1,22 @@
1
1
  {
2
+ "author": "Mathias Schreck <schreck.mathias@gmail.com>",
3
+ "contributors": [
4
+ "Christian Rackerseder <github@echooff.de>"
5
+ ],
2
6
  "dependencies": {
3
7
  "eslint-plugin-ava": "14.0.0"
4
8
  },
9
+ "description": "Enormora’s ESLint ava configuration",
5
10
  "license": "MIT",
6
11
  "main": "ava.js",
7
12
  "name": "@enormora/eslint-config-ava",
8
13
  "peerDependencies": {
9
- "@enormora/eslint-config-base": "0.0.11"
14
+ "@enormora/eslint-config-base": "0.0.12"
10
15
  },
11
16
  "repository": {
12
17
  "type": "git",
13
18
  "url": "git://github.com/enormora/eslint-config.git"
14
19
  },
15
20
  "type": "module",
16
- "version": "0.0.12"
21
+ "version": "0.0.13"
17
22
  }
package/readme.md ADDED
@@ -0,0 +1,29 @@
1
+ # `@enormora/eslint-config-ava`
2
+
3
+ Config preset for ava, enabling specific rules.
4
+
5
+ ## Install & Setup
6
+
7
+ Install the `@enormora/eslint-config-ava` and the base preset package via npm:
8
+
9
+ ```bash
10
+ npm install --save-dev @enormora/eslint-config-base @enormora/eslint-config-ava
11
+ ```
12
+
13
+ Create an ESLint configuration file (e.g., `eslint.config.js`) in your project and add the base and node config to the configuration array:
14
+
15
+ ```javascript
16
+ import { baseConfig } from '@enormora/eslint-config-base';
17
+ import { avaConfig } from '@enormora/eslint-config-ava';
18
+
19
+ export default [
20
+ {
21
+ ignores: ['dist/**/*']
22
+ },
23
+ baseConfig,
24
+ {
25
+ ...avaConfig,
26
+ files: ['**/*.test.js']
27
+ }
28
+ ];
29
+ ```