@gem-sdk/eslint-plugin 0.0.2 → 0.0.3

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 (5) hide show
  1. package/README.md +35 -16
  2. package/dist/index.d.ts +25 -25
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +13 -13
  5. package/package.json +3 -3
package/README.md CHANGED
@@ -1,13 +1,15 @@
1
- # eslint-plugin-gem-fe
1
+ # @gem-sdk/eslint-plugin
2
2
 
3
3
  Shared ESLint rules for all GemPages frontend repositories.
4
4
 
5
5
  Consolidates every custom rule from `web-builder-shopify-app`, `web-builder`, and `web-builder-elements` into a single publishable npm package. The architecture rules support both React (`.tsx`) and Vue (`.vue`) files.
6
6
 
7
+ > The package name is `@gem-sdk/eslint-plugin`, so its ESLint plugin prefix is **`@gem-sdk`** (scoped packages drop the `eslint-plugin-` segment). Reference rules as `@gem-sdk/<rule>` and shareable configs as `plugin:@gem-sdk/<config>`.
8
+
7
9
  ## Installation
8
10
 
9
11
  ```bash
10
- yarn add -D eslint-plugin-gem-fe
12
+ yarn add -D @gem-sdk/eslint-plugin
11
13
  ```
12
14
 
13
15
  ## Usage
@@ -18,7 +20,7 @@ Choose the config that matches your tech stack:
18
20
 
19
21
  ```json
20
22
  {
21
- "extends": ["plugin:gem-fe/react"]
23
+ "extends": ["plugin:@gem-sdk/react"]
22
24
  }
23
25
  ```
24
26
 
@@ -26,7 +28,7 @@ Choose the config that matches your tech stack:
26
28
 
27
29
  ```json
28
30
  {
29
- "extends": ["plugin:gem-fe/vue"]
31
+ "extends": ["plugin:@gem-sdk/vue"]
30
32
  }
31
33
  ```
32
34
 
@@ -34,7 +36,7 @@ Choose the config that matches your tech stack:
34
36
 
35
37
  ```json
36
38
  {
37
- "extends": ["plugin:gem-fe/recommended"]
39
+ "extends": ["plugin:@gem-sdk/recommended"]
38
40
  }
39
41
  ```
40
42
 
@@ -42,18 +44,35 @@ Choose the config that matches your tech stack:
42
44
 
43
45
  ```json
44
46
  {
45
- "plugins": ["gem-fe"],
47
+ "plugins": ["@gem-sdk"],
46
48
  "rules": {
47
- "gem-fe/module-structure": "error",
48
- "gem-fe/no-module-barrel": "error",
49
- "gem-fe/module-import-boundary": "error",
50
- "gem-fe/pure-ui-layer": "error",
51
- "gem-fe/module-index-required": "error",
52
- "gem-fe/no-t-for-variable": "error",
53
- "gem-fe/not-use-store-to-refs": "error",
54
- "gem-fe/not-use-custom-color-class": "warn",
55
- "gem-fe/no-export-type-from-tsx": "error",
56
- "gem-fe/no-import-from-package-path": "error"
49
+ "@gem-sdk/module-structure": "error",
50
+ "@gem-sdk/no-module-barrel": "error",
51
+ "@gem-sdk/module-import-boundary": "error",
52
+ "@gem-sdk/pure-ui-layer": "error",
53
+ "@gem-sdk/module-index-required": "error",
54
+ "@gem-sdk/no-t-for-variable": "error",
55
+ "@gem-sdk/not-use-store-to-refs": "error",
56
+ "@gem-sdk/not-use-custom-color-class": "warn",
57
+ "@gem-sdk/no-export-type-from-tsx": "error",
58
+ "@gem-sdk/no-import-from-package-path": "error"
57
59
  }
58
60
  }
59
61
  ```
62
+
63
+ ## What each config enables
64
+
65
+ | Rule | `recommended` | `vue` | `react` |
66
+ | --- | :---: | :---: | :---: |
67
+ | `module-structure` | error | error | error |
68
+ | `no-module-barrel` | error | error | error |
69
+ | `module-import-boundary` | error | error | error |
70
+ | `pure-ui-layer` | error | error | error |
71
+ | `module-index-required` | error | error | error |
72
+ | `no-t-for-variable` | error | error | error |
73
+ | `not-use-store-to-refs` | — | error | — |
74
+ | `not-use-custom-color-class` | — | warn | — |
75
+ | `no-export-type-from-tsx` | — | — | error |
76
+ | `no-import-from-package-path` | — | — | error |
77
+
78
+ `vue` and `react` both extend `recommended`. Vue configs require `vue-eslint-parser`.
package/dist/index.d.ts CHANGED
@@ -12,40 +12,40 @@ export declare const rules: {
12
12
  };
13
13
  export declare const configs: {
14
14
  recommended: {
15
- readonly plugins: readonly ['gem-fe'];
15
+ readonly plugins: readonly ['@gem-sdk'];
16
16
  readonly rules: {
17
- readonly 'gem-fe/module-structure': 'error';
18
- readonly 'gem-fe/no-module-barrel': 'error';
19
- readonly 'gem-fe/module-import-boundary': 'error';
20
- readonly 'gem-fe/pure-ui-layer': 'error';
21
- readonly 'gem-fe/module-index-required': 'error';
22
- readonly 'gem-fe/no-t-for-variable': 'error';
17
+ readonly '@gem-sdk/module-structure': 'error';
18
+ readonly '@gem-sdk/no-module-barrel': 'error';
19
+ readonly '@gem-sdk/module-import-boundary': 'error';
20
+ readonly '@gem-sdk/pure-ui-layer': 'error';
21
+ readonly '@gem-sdk/module-index-required': 'error';
22
+ readonly '@gem-sdk/no-t-for-variable': 'error';
23
23
  };
24
24
  };
25
25
  vue: {
26
- readonly plugins: readonly ['gem-fe'];
26
+ readonly plugins: readonly ['@gem-sdk'];
27
27
  readonly rules: {
28
- readonly 'gem-fe/module-structure': 'error';
29
- readonly 'gem-fe/no-module-barrel': 'error';
30
- readonly 'gem-fe/module-import-boundary': 'error';
31
- readonly 'gem-fe/pure-ui-layer': 'error';
32
- readonly 'gem-fe/module-index-required': 'error';
33
- readonly 'gem-fe/no-t-for-variable': 'error';
34
- readonly 'gem-fe/not-use-store-to-refs': 'error';
35
- readonly 'gem-fe/not-use-custom-color-class': 'warn';
28
+ readonly '@gem-sdk/module-structure': 'error';
29
+ readonly '@gem-sdk/no-module-barrel': 'error';
30
+ readonly '@gem-sdk/module-import-boundary': 'error';
31
+ readonly '@gem-sdk/pure-ui-layer': 'error';
32
+ readonly '@gem-sdk/module-index-required': 'error';
33
+ readonly '@gem-sdk/no-t-for-variable': 'error';
34
+ readonly '@gem-sdk/not-use-store-to-refs': 'error';
35
+ readonly '@gem-sdk/not-use-custom-color-class': 'warn';
36
36
  };
37
37
  };
38
38
  react: {
39
- readonly plugins: readonly ['gem-fe'];
39
+ readonly plugins: readonly ['@gem-sdk'];
40
40
  readonly rules: {
41
- readonly 'gem-fe/module-structure': 'error';
42
- readonly 'gem-fe/no-module-barrel': 'error';
43
- readonly 'gem-fe/module-import-boundary': 'error';
44
- readonly 'gem-fe/pure-ui-layer': 'error';
45
- readonly 'gem-fe/module-index-required': 'error';
46
- readonly 'gem-fe/no-t-for-variable': 'error';
47
- readonly 'gem-fe/no-export-type-from-tsx': 'error';
48
- readonly 'gem-fe/no-import-from-package-path': 'error';
41
+ readonly '@gem-sdk/module-structure': 'error';
42
+ readonly '@gem-sdk/no-module-barrel': 'error';
43
+ readonly '@gem-sdk/module-import-boundary': 'error';
44
+ readonly '@gem-sdk/pure-ui-layer': 'error';
45
+ readonly '@gem-sdk/module-index-required': 'error';
46
+ readonly '@gem-sdk/no-t-for-variable': 'error';
47
+ readonly '@gem-sdk/no-export-type-from-tsx': 'error';
48
+ readonly '@gem-sdk/no-import-from-package-path': 'error';
49
49
  };
50
50
  };
51
51
  };
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,KAAK;;;;;;;;;;;CAegB,CAAC;AAyCnC,eAAO,MAAM,OAAO;;oCAnCR,QAAQ;;qBAEhB,yBAAyB,EAAE,OAAO;qBAClC,yBAAyB,EAAE,OAAO;qBAClC,+BAA+B,EAAE,OAAO;qBACxC,sBAAsB,EAAE,OAAO;qBAC/B,8BAA8B,EAAE,OAAO;qBACvC,0BAA0B,EAAE,OAAO;;;;oCAQ3B,QAAQ;;gDAbW,OAAO;gDACP,OAAO;sDACD,OAAO;6CAChB,OAAO;qDACC,OAAO;iDACX,OAAO;qDAWH,OAAO;0DACF,MAAM;;;;oCAQnC,QAAQ;;gDAzBW,OAAO;gDACP,OAAO;sDACD,OAAO;6CAChB,OAAO;qDACC,OAAO;iDACX,OAAO;uDAuBD,OAAO;2DACH,OAAO;;;CAIC,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,KAAK;;;;;;;;;;;CAegB,CAAC;AAyCnC,eAAO,MAAM,OAAO;;oCAnCR,UAAU;;qBAElB,2BAA2B,EAAE,OAAO;qBACpC,2BAA2B,EAAE,OAAO;qBACpC,iCAAiC,EAAE,OAAO;qBAC1C,wBAAwB,EAAE,OAAO;qBACjC,gCAAgC,EAAE,OAAO;qBACzC,4BAA4B,EAAE,OAAO;;;;oCAQ7B,UAAU;;kDAbW,OAAO;kDACP,OAAO;wDACD,OAAO;+CAChB,OAAO;uDACC,OAAO;mDACX,OAAO;uDAWH,OAAO;4DACF,MAAM;;;;oCAQrC,UAAU;;kDAzBW,OAAO;kDACP,OAAO;wDACD,OAAO;+CAChB,OAAO;uDACC,OAAO;mDACX,OAAO;yDAuBD,OAAO;6DACH,OAAO;;;CAID,CAAC"}
package/dist/index.js CHANGED
@@ -34,36 +34,36 @@ exports.rules = {
34
34
  * Shared architecture + i18n rules for both React and Vue repos.
35
35
  */
36
36
  const recommended = {
37
- plugins: ['gem-fe'],
37
+ plugins: ['@gem-sdk'],
38
38
  rules: {
39
- 'gem-fe/module-structure': 'error',
40
- 'gem-fe/no-module-barrel': 'error',
41
- 'gem-fe/module-import-boundary': 'error',
42
- 'gem-fe/pure-ui-layer': 'error',
43
- 'gem-fe/module-index-required': 'error',
44
- 'gem-fe/no-t-for-variable': 'error',
39
+ '@gem-sdk/module-structure': 'error',
40
+ '@gem-sdk/no-module-barrel': 'error',
41
+ '@gem-sdk/module-import-boundary': 'error',
42
+ '@gem-sdk/pure-ui-layer': 'error',
43
+ '@gem-sdk/module-index-required': 'error',
44
+ '@gem-sdk/no-t-for-variable': 'error',
45
45
  },
46
46
  };
47
47
  /**
48
48
  * `recommended` + Vue-specific rules. Use with vue-eslint-parser.
49
49
  */
50
50
  const vue = {
51
- plugins: ['gem-fe'],
51
+ plugins: ['@gem-sdk'],
52
52
  rules: {
53
53
  ...recommended.rules,
54
- 'gem-fe/not-use-store-to-refs': 'error',
55
- 'gem-fe/not-use-custom-color-class': 'warn',
54
+ '@gem-sdk/not-use-store-to-refs': 'error',
55
+ '@gem-sdk/not-use-custom-color-class': 'warn',
56
56
  },
57
57
  };
58
58
  /**
59
59
  * `recommended` + React/TypeScript-specific rules.
60
60
  */
61
61
  const react = {
62
- plugins: ['gem-fe'],
62
+ plugins: ['@gem-sdk'],
63
63
  rules: {
64
64
  ...recommended.rules,
65
- 'gem-fe/no-export-type-from-tsx': 'error',
66
- 'gem-fe/no-import-from-package-path': 'error',
65
+ '@gem-sdk/no-export-type-from-tsx': 'error',
66
+ '@gem-sdk/no-import-from-package-path': 'error',
67
67
  },
68
68
  };
69
69
  exports.configs = { recommended, vue, react };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gem-sdk/eslint-plugin",
3
- "version": "0.0.2",
3
+ "version": "0.0.3",
4
4
  "description": "Shared ESLint rules for GemPages frontend repos (React + Vue)",
5
5
  "license": "MIT",
6
6
  "main": "./dist/index.js",
@@ -13,8 +13,8 @@
13
13
  "test": "vitest run",
14
14
  "type-check": "tsc --noEmit",
15
15
  "lint": "eslint src --ext .ts",
16
- "release": "changeset publish",
17
- "release-packages": "yarn build && changeset publish"
16
+ "release": "set -a && . ./.env && set +a && env npm_config_//registry.npmjs.org/:_authToken=\"$NPM_TOKEN\" changeset publish",
17
+ "release-packages": "set -a && . ./.env && set +a && yarn build && env npm_config_//registry.npmjs.org/:_authToken=\"$NPM_TOKEN\" changeset publish"
18
18
  },
19
19
  "peerDependencies": {
20
20
  "eslint": ">=8.0.0"