@homestuck/eslint-config 1.5.2 → 1.6.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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.6.0](https://github.com/homestuck/configs/compare/eslint-config@v1.5.2...eslint-config@v1.6.0) (2026-01-20)
4
+
5
+
6
+ ### Features
7
+
8
+ * Adding README documents for all packages ([#50](https://github.com/homestuck/configs/issues/50)) ([71534f9](https://github.com/homestuck/configs/commit/71534f94200c6a908bd31ca1c3b9526e975124ad))
9
+
3
10
  ## [1.5.2](https://github.com/homestuck/configs/compare/eslint-config@v1.5.1...eslint-config@v1.5.2) (2026-01-20)
4
11
 
5
12
 
package/README.md ADDED
@@ -0,0 +1,60 @@
1
+ <div align="center">
2
+ <h1>@homestuck/eslint-config</h1>
3
+
4
+ Baseline ESLint configurations used and maintained by members of [@homestuck](https://github.com/homestuck).
5
+
6
+ [![NPM Version](https://img.shields.io/npm/v/%40homestuck%2Feslint-config?style=for-the-badge)](https://www.npmjs.com/package/@homestuck/eslint-config)
7
+ [![License: MIT](https://img.shields.io/github/license/homestuck/configs?style=for-the-badge)](https://opensource.org/licenses/MIT)
8
+
9
+ </div>
10
+
11
+ ## 🚀 Quick Start
12
+
13
+ ### 1. Install the package:
14
+
15
+ ```bash
16
+ npm install --save-dev @homestuck/eslint-config
17
+ # or
18
+ pnpm add -D @homestuck/eslint-config
19
+ ```
20
+
21
+ ### 2. Add the most applicable config to your project's ESLint configuration file:
22
+
23
+ #### Javascript/Typescript:
24
+
25
+ ```js
26
+ import baseConfig from '@homestuck/eslint-config'
27
+
28
+ const config = [
29
+ ...baseConfig,
30
+ // Additional configs can optionally be set here.
31
+ ]
32
+
33
+ export default config
34
+ ```
35
+
36
+ #### React:
37
+
38
+ ```js
39
+ import reactConfig from '@homestuck/eslint-config/react'
40
+
41
+ const config = [
42
+ ...reactConfig,
43
+ // Additional configs can optionally be set here.
44
+ ]
45
+
46
+ export default config
47
+ ```
48
+
49
+ #### NextJS:
50
+
51
+ ```js
52
+ import nextConfig from '@homestuck/eslint-config/next'
53
+
54
+ const config = [
55
+ ...nextConfig,
56
+ // Additional configs can optionally be set here.
57
+ ]
58
+
59
+ export default config
60
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@homestuck/eslint-config",
3
- "version": "1.5.2",
3
+ "version": "1.6.0",
4
4
  "private": false,
5
5
  "description": "Baseline ESLint configs used and maintained by Homestuck Inc., et al.",
6
6
  "repository": {
@@ -67,8 +67,8 @@
67
67
  "@types/eslint__js": "^9.14.0",
68
68
  "@types/node": "^25.0.9",
69
69
  "prettier": "^3.8.0",
70
- "@homestuck/prettier-config": "1.5.2",
71
- "@homestuck/tsconfig": "1.5.2"
70
+ "@homestuck/tsconfig": "1.6.0",
71
+ "@homestuck/prettier-config": "1.6.0"
72
72
  },
73
73
  "scripts": {
74
74
  "clean": "rm -rf .turbo node_modules",