@zemd/eslint-rock-stack 1.1.4 → 1.1.6

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/README.md +37 -16
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,21 +1,22 @@
1
- # @zemd/eslint-rock-stack
1
+ # Shared ESLint config for modern projects
2
2
 
3
3
  [![npm](https://img.shields.io/npm/v/@zemd/eslint-rock-stack?color=0000ff&label=npm&labelColor=000)](https://npmjs.com/package/@zemd/eslint-rock-stack)
4
+ [![Static Badge](https://img.shields.io/badge/%40zemd%2Feslint--config--flat-gray?style=social&logo=github&label=GitHub&labelColor=blue)](https://github.com/zemd/eslint-flat-config)
4
5
 
5
6
  This package includes a set of ESLint configurations for modern fullstack projects that rock.
6
7
 
7
8
  **The package includes**:
8
9
 
9
- | Package | Description | Rules | License |
10
- | ------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------- |
11
- | `@zemd/eslint-js` | A bundle that comprises rules for javascript | | Apache 2.0 |
12
- | `@zemd/eslint-ts` | A bundle that comprises rules for typescript | | Apache 2.0 |
13
- | `@zemd/eslint-react` | A bundle that comprises rules for react | | Apache 2.0 |
14
- | `@graphql-eslint/eslint-plugin` | GraphQL ESLint rules | `schema-recommended` and `operations-recommended` | MIT |
15
- | `eslint-plugin-tailwindcss` | since v1.1.0 the config is **optional** due to Tailwind v4 release, which is not supported by the config | `recommended` excluding **classnames-order** | MIT |
16
- | `eslint-plugin-turbo` | | `recommended` | MIT |
17
- | `@vitest/eslint-plugin` | | `recommended` | MIT |
18
- | `eslint-plugin-storybook` | | `recommended`, `csf-strict`. The rules are available but not included by default | MIT |
10
+ | Package | Description | Rules | License |
11
+ | ------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------- |
12
+ | `@zemd/eslint-js` | Shared ESLint config for JavaScript projects | | Apache 2.0 |
13
+ | `@zemd/eslint-ts` | Shared ESLint config for TypeScript projects | | Apache 2.0 |
14
+ | `@zemd/eslint-react` | Shared ESLint config for React.js projects | | Apache 2.0 |
15
+ | `@graphql-eslint/eslint-plugin` | GraphQL ESLint rules | `schema-recommended` and `operations-recommended` | MIT |
16
+ | `eslint-plugin-tailwindcss` | Starting from v1.1.0 the config is **optional** due to Tailwind v4 release, which is not supported by the config | `recommended` excluding **classnames-order** | MIT |
17
+ | `eslint-plugin-turbo` | | `recommended` | MIT |
18
+ | `@vitest/eslint-plugin` | | `recommended` | MIT |
19
+ | `eslint-plugin-storybook` | | `recommended`, `csf-strict`. The rules are available but not included by default | MIT |
19
20
 
20
21
  ## Installation
21
22
 
@@ -25,16 +26,17 @@ npm install --save-dev @zemd/eslint-rock-stack
25
26
 
26
27
  ## Usage
27
28
 
29
+ ### Basic Setup
30
+
28
31
  ```javascript
29
32
  // eslint.config.js
30
-
31
33
  import rock, { storybook } from "@zemd/eslint-rock-stack";
32
- // if you do not want to use default bundle, you can import each configuration separately
33
- // import { react, graphql, playwright, tailwind, turbo, vitest } from "@zemd/eslint-rock-stack";
34
34
 
35
35
  export default [...rock(), ...storybook()];
36
36
  ```
37
37
 
38
+ ### Tailwind v3 support
39
+
38
40
  if you want to use Tailwind config for Tailwind v3, install optional dependency:
39
41
 
40
42
  ```bash
@@ -50,10 +52,29 @@ import tailwind from "@zemd/eslint-rock-stack/tailwind";
50
52
  export default [...rock(), ...tailwind()];
51
53
  ```
52
54
 
55
+ ### More Advanced Setup
56
+
57
+ ```javascript
58
+ // eslint.config.js
59
+ import { react, graphql, playwright, turbo, vitest, typescript, javascript } from "@zemd/eslint-rock-stack";
60
+
61
+ export default [...typescript(), javascript(), ...react(), ...graphql(), ...playwright(), ...turbo(), ...vitest()];
62
+ ```
63
+
64
+ ## You might be also interested in
65
+
66
+ | Package | Version | Description |
67
+ | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
68
+ | [`@zemd/eslint-js`](../js/README.md) | [![npm](https://img.shields.io/npm/v/@zemd/eslint-js?color=0000ff&label=npm&labelColor=000)](https://npmjs.com/package/@zemd/eslint-js) | JavaScript-only rules. |
69
+ | [`@zemd/eslint-ts`](../ts/README.md) | [![npm](https://img.shields.io/npm/v/@zemd/eslint-ts?color=0000ff&label=npm&labelColor=000)](https://npmjs.com/package/@zemd/eslint-ts) | TypeScript rules (includes JS rules from @zemd/eslint-js). |
70
+ | [`@zemd/eslint-react`](../react/README.md) | [![npm](https://img.shields.io/npm/v/@zemd/eslint-react?color=0000ff&label=npm&labelColor=000)](https://npmjs.com/package/@zemd/eslint-react) | React rules (includes TS rules from `@zemd/eslint-ts` and JS rules from `@zemd/eslint-js`). |
71
+ | [`@zemd/eslint-rock-stack`](../rock-stack/README.md) | [![npm](https://img.shields.io/npm/v/@zemd/eslint-rock-stack?color=0000ff&label=npm&labelColor=000)](https://npmjs.com/package/@zemd/eslint-rock-stack) | Rules for Fullstack projects that include React.js, GraphQL, Playwright, Tailwind(optional), Turbo, Vitest, and Storybook. |
72
+ | [`@zemd/eslint-next`](../next/README.md) | [![npm](https://img.shields.io/npm/v/@zemd/eslint-next?color=0000ff&label=npm&labelColor=000)](https://npmjs.com/package/@zemd/eslint-next) | Rules for Next.js projects (inherits from `@zemd/eslint-rock-stack`). |
73
+
53
74
  ## License
54
75
 
55
- The `@zemd/eslint-rock-stack` is licensed under the Apache-2.0 license.
76
+ The `@zemd/eslint-rock-stack` is licensed under **Apache-2.0 license** 😇.
56
77
 
57
- ## Donate
78
+ ## 💙 💛 Donate
58
79
 
59
80
  [![](https://img.shields.io/static/v1?label=UNITED24&message=support%20Ukraine&color=blue)](https://u24.gov.ua/)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zemd/eslint-rock-stack",
3
- "version": "1.1.4",
3
+ "version": "1.1.6",
4
4
  "license": "Apache-2.0",
5
5
  "description": "Shared ESLint config for modern projects",
6
6
  "keywords": [
@@ -59,10 +59,10 @@
59
59
  "@graphql-eslint/eslint-plugin": "^4.3.0",
60
60
  "@vitest/eslint-plugin": "^1.1.31",
61
61
  "eslint-plugin-playwright": "^2.2.0",
62
- "eslint-plugin-storybook": "^0.11.2",
62
+ "eslint-plugin-storybook": "^0.11.3",
63
63
  "eslint-plugin-turbo": "^2.4.2",
64
- "@zemd/eslint-react": "1.0.3",
65
- "@zemd/eslint-common": "1.0.1"
64
+ "@zemd/eslint-react": "1.0.5",
65
+ "@zemd/eslint-common": "1.0.2"
66
66
  },
67
67
  "devDependencies": {
68
68
  "@types/eslint": "^9.6.1",