@zemd/eslint-ts 1.0.4 → 1.0.5

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 +29 -13
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,17 +1,15 @@
1
- # @zemd/eslint-ts
1
+ # Shared ESLint config for typescript projects
2
2
 
3
3
  [![npm](https://img.shields.io/npm/v/@zemd/eslint-ts?color=0000ff&label=npm&labelColor=000)](https://npmjs.com/package/@zemd/eslint-ts)
4
-
5
- > [!NOTE]
6
- > This package comprises `@zemd/eslint-js` and adds its rules by default. However, you can import each set of rules separately.
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)
7
5
 
8
6
  This package includes a set of ESLint configurations for Typescript projects.
9
7
 
10
8
  **The package includes**:
11
9
 
12
- | Package | Description | Rules | License |
13
- | ---------------------------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
14
- | `@typescript-eslint/eslint-plugin` | At the moment the industry standard for enabling typescript support for ESLint | carefully hand-picked rules in conjunction with `strict-type-checked` config. Additionally, there are disabled rules for `@eslint/js` that overlap and can make issues. | MIT |
10
+ | Package | Description | Rules | License |
11
+ | ---------------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
12
+ | `@typescript-eslint/eslint-plugin` | The industry standard for enabling typescript support for ESLint | Carefully hand-picked rules in conjunction with `strict-type-checked` config. Additionally, there are disabled rules for `@eslint/js` that overlap and can make issues. | MIT |
15
13
 
16
14
  ## Installation
17
15
 
@@ -21,22 +19,40 @@ npm install --save-dev @zemd/eslint-ts
21
19
 
22
20
  ## Usage
23
21
 
22
+ ### Basic Setup
23
+
24
24
  ```javascript
25
25
  // eslint.config.js
26
26
 
27
27
  import typescript from "@zemd/eslint-ts";
28
28
  export default [...typescript()];
29
- // import { typescript } from "@zemd/eslint-ts"; // import only typescript config
30
- // export default [...typescript()];
29
+ ```
30
+
31
+ ### More Advanced Setup
32
+
33
+ You can cherry-pick only what you need:
31
34
 
32
- // you can also import any other config from @zemd/eslint-js or @zemd/eslint-common
33
- // import { javascript, json, JS_FILES } from "@zemd/eslint-js";
35
+ ```javascript
36
+ // eslint.config.js
37
+
38
+ import { typescript, javascript, json } from "@zemd/eslint-ts"; // import only typescript config
39
+ export default [...typescript(), ...javascript(), ...json()];
34
40
  ```
35
41
 
42
+ ## You might be also interested in
43
+
44
+ | Package | Version | Description |
45
+ | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
46
+ | [`@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. |
47
+ | [`@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). |
48
+ | [`@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`). |
49
+ | [`@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. |
50
+ | [`@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`). |
51
+
36
52
  ## License
37
53
 
38
- The `@zemd/eslint-ts` is licensed under the Apache-2.0 license.
54
+ The `@zemd/eslint-ts` is licensed under **Apache-2.0 license** 😇.
39
55
 
40
- ## Donate
56
+ ## 💙 💛 Donate
41
57
 
42
58
  [![](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-ts",
3
- "version": "1.0.4",
3
+ "version": "1.0.5",
4
4
  "license": "Apache-2.0",
5
5
  "description": "Shared ESLint config for typescript projects",
6
6
  "keywords": [
@@ -45,8 +45,8 @@
45
45
  "dependencies": {
46
46
  "@typescript-eslint/eslint-plugin": "^8.24.1",
47
47
  "@typescript-eslint/parser": "^8.24.1",
48
- "@zemd/eslint-common": "1.0.1",
49
- "@zemd/eslint-js": "1.0.4"
48
+ "@zemd/eslint-common": "1.0.2",
49
+ "@zemd/eslint-js": "1.0.5"
50
50
  },
51
51
  "devDependencies": {
52
52
  "@types/eslint": "^9.6.1",