@plumile/eslint-config-typescript 0.1.42 → 0.1.44

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 (4) hide show
  1. package/README.md +23 -0
  2. package/index.js +1251 -1233
  3. package/package.json +11 -8
  4. package/relay.js +24 -0
package/README.md CHANGED
@@ -31,6 +31,28 @@ export default [
31
31
  ];
32
32
  ```
33
33
 
34
+ If you need a custom TypeScript project reference:
35
+
36
+ ```ts
37
+ import plumileTs, { createConfig } from '@plumile/eslint-config-typescript';
38
+
39
+ const base = createConfig({ project: './tsconfig.eslint.json' });
40
+
41
+ export default [
42
+ ...base,
43
+ // overrides...
44
+ ];
45
+ ```
46
+
47
+ Relay preset (requires `eslint-plugin-relay`):
48
+
49
+ ```ts
50
+ import plumileTs from '@plumile/eslint-config-typescript';
51
+ import relayPreset from '@plumile/eslint-config-typescript/relay.js';
52
+
53
+ export default [...plumileTs, ...relayPreset];
54
+ ```
55
+
34
56
  ### Legacy `.eslintrc`
35
57
 
36
58
  ```json
@@ -58,6 +80,7 @@ Because the package exports an array of config objects, you can spread it and ap
58
80
  - Disable costly rules in generated code directories via `ignores`.
59
81
  - Relax naming conventions for GraphQL fragments or relay artifacts.
60
82
  - Add custom plugins (e.g., router DX rule `@plumile-router/dx/no-direct-window-location-search`).
83
+ - Use the Relay preset: `import relayPreset from '@plumile/eslint-config-typescript/relay.js';`
61
84
 
62
85
  ## Related Tooling
63
86