@rebeccastevens/eslint-config 2.0.10 → 2.1.0

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 (17) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +18 -89
  3. package/dist/index.cjs +3778 -0
  4. package/dist/index.d.cts +13751 -0
  5. package/dist/index.d.mts +13751 -0
  6. package/dist/index.mjs +3690 -0
  7. package/package.json +227 -88
  8. package/dist/common-overrides.cjs +0 -39
  9. package/dist/common-overrides.mjs +0 -37
  10. package/dist/modern.cjs +0 -1229
  11. package/dist/modern.mjs +0 -1227
  12. package/dist/script.cjs +0 -22
  13. package/dist/script.mjs +0 -20
  14. package/dist/test.cjs +0 -31
  15. package/dist/test.mjs +0 -29
  16. package/dist/typescript.cjs +0 -442
  17. package/dist/typescript.mjs +0 -440
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  BSD 3-Clause License
2
2
 
3
- Copyright (c) 2019, Rebecca Stevens
3
+ Copyright (c) 2024, Rebecca Stevens
4
4
  All rights reserved.
5
5
 
6
6
  Redistribution and use in source and binary forms, with or without
package/README.md CHANGED
@@ -5,16 +5,19 @@
5
5
  An [ESLint Shareable Config](https://eslint.org/docs/developer-guide/shareable-configs.html).
6
6
 
7
7
  [![npm version](https://img.shields.io/npm/v/@rebeccastevens/eslint-config.svg)](https://www.npmjs.com/package/@rebeccastevens/eslint-config)
8
- [![CI](https://github.com/RebeccaStevens/template-typescript-node-package/actions/workflows/release.yml/badge.svg)](https://github.com/RebeccaStevens/template-typescript-node-package/actions/workflows/release.yml)
8
+ [![CI](https://github.com/RebeccaStevens/eslint-config-rebeccastevens/actions/workflows/release.yml/badge.svg)](https://github.com/RebeccaStevens/eslint-config-rebeccastevens/actions/workflows/release.yml)
9
+ [![Coverage Status](https://codecov.io/gh/RebeccaStevens/eslint-config-rebeccastevens/branch/main/graph/badge.svg?token=MVpR1oAbIT)](https://codecov.io/gh/RebeccaStevens/eslint-config-rebeccastevens)\
9
10
  [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
10
- [![GitHub Discussions](https://img.shields.io/github/discussions/RebeccaStevens/template-typescript-node-package?style=flat-square)](https://github.com/RebeccaStevens/template-typescript-node-package/discussions)
11
- [![BSD 3 Clause license](https://img.shields.io/github/license/RebeccaStevens/template-typescript-node-package.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause)
11
+ [![GitHub Discussions](https://img.shields.io/github/discussions/RebeccaStevens/eslint-config-rebeccastevens?style=flat-square)](https://github.com/RebeccaStevens/eslint-config-rebeccastevens/discussions)
12
+ [![BSD 3 Clause license](https://img.shields.io/github/license/RebeccaStevens/eslint-config-rebeccastevens.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause)
12
13
  [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
13
14
  [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
14
15
 
15
16
  </div>
16
17
 
17
- <br>
18
+ ## Donate
19
+
20
+ [Any donations would be much appreciated](./DONATIONS.md). 😄
18
21
 
19
22
  ## Installation
20
23
 
@@ -32,95 +35,21 @@ Note: This project doesn't strictly follow semantic versioning so be sure to pin
32
35
 
33
36
  ## Usage
34
37
 
35
- ### Language
36
-
37
- <details>
38
- <summary>JavaScript (Modern)</summary>
39
-
40
- Install Peer Dependencies:
38
+ ```js
39
+ // eslint.config.js
40
+ import rsEslint from "@rebeccastevens/eslint-config";
41
41
 
42
- ```sh
43
- pnpm add -D \
44
- babel-eslint \
45
- eslint-plugin-eslint-comments \
46
- eslint-plugin-functional \
47
- eslint-plugin-import \
48
- eslint-import-resolver-typescript \
49
- eslint-plugin-jsdoc \
50
- eslint-plugin-markdown \
51
- eslint-plugin-n \
52
- eslint-plugin-optimize-regex \
53
- eslint-plugin-promise \
54
- eslint-plugin-sonarjs \
55
- eslint-plugin-unicorn
56
- ```
57
-
58
- Configure your project's `.eslintrc.json` file.
59
-
60
- ```jsonc
61
- {
62
- "root": true,
63
- "extends": ["@rebeccastevens/eslint-config/modern"],
64
- "rules": {
65
- // Additional, per-project rules...
42
+ export default rsEslint(
43
+ {
44
+ // general config.
66
45
  },
67
- "overrides": [
68
- {
69
- "files": ["**/*.test.ts"],
70
- "rules": {}
71
- }
72
- ]
73
- }
74
- ```
75
-
76
- </details>
77
-
78
- <details>
79
- <summary>TypeScript</summary>
80
-
81
- Install Peer Dependencies:
82
-
83
- ```sh
84
- pnpm add -D \
85
- @typescript-eslint/parser \
86
- @typescript-eslint/eslint-plugin \
87
- eslint-plugin-eslint-comments \
88
- eslint-plugin-functional \
89
- eslint-plugin-import \
90
- eslint-import-resolver-typescript \
91
- eslint-plugin-jsdoc \
92
- eslint-plugin-markdown \
93
- eslint-plugin-n \
94
- eslint-plugin-optimize-regex \
95
- eslint-plugin-promise \
96
- eslint-plugin-sonarjs \
97
- eslint-plugin-unicorn
98
- ```
99
-
100
- Configure your project's `.eslintrc.json` file.
101
-
102
- ```jsonc
103
- {
104
- "root": true,
105
- "parserOptions": {
106
- "project": "tsconfig.json"
46
+ {
47
+ // project specific config.
107
48
  },
108
- "extends": [
109
- "@rebeccastevens/eslint-config/modern",
110
- "@rebeccastevens/eslint-config/typescript"
111
- ],
112
- "rules": {
113
- // Additional, per-project rules...
49
+ {
50
+ // another project specific config.
114
51
  },
115
- "overrides": [
116
- {
117
- "files": ["**/*.test.ts"],
118
- "rules": {}
119
- }
120
- ]
121
- }
52
+ );
122
53
  ```
123
54
 
124
- </details>
125
-
126
55
  See [ESLint configuration](http://eslint.org/docs/user-guide/configuring) for more information.