@tcy/eslint-rules 1.11.0 → 1.12.1

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 (44) hide show
  1. package/README.md +26 -0
  2. package/coverage/clover.xml +203 -4
  3. package/coverage/coverage-final.json +1 -0
  4. package/coverage/lcov-report/index.html +19 -19
  5. package/coverage/lcov-report/src/array-elements-per-line.js.html +1 -1
  6. package/coverage/lcov-report/src/back/back.js.html +1 -1
  7. package/coverage/lcov-report/src/back/http.js.html +1 -1
  8. package/coverage/lcov-report/src/back/index.html +1 -1
  9. package/coverage/lcov-report/src/back/recommended.js.html +1 -1
  10. package/coverage/lcov-report/src/bin/eslint-cache-guard.js.html +1 -1
  11. package/coverage/lcov-report/src/bin/index.html +1 -1
  12. package/coverage/lcov-report/src/client/client.js.html +5 -2
  13. package/coverage/lcov-report/src/client/index.html +1 -1
  14. package/coverage/lcov-report/src/client/recommended.js.html +1 -1
  15. package/coverage/lcov-report/src/consistent-const-scoping.js.html +1 -1
  16. package/coverage/lcov-report/src/decorator-type-enforcement.js.html +1 -1
  17. package/coverage/lcov-report/src/enforce-tailwind-important.js.html +1 -1
  18. package/coverage/lcov-report/src/export-specifiers-per-line.js.html +1 -1
  19. package/coverage/lcov-report/src/import-specifiers-per-line.js.html +1 -1
  20. package/coverage/lcov-report/src/index.html +24 -9
  21. package/coverage/lcov-report/src/index.js.html +1 -1
  22. package/coverage/lcov-report/src/jsx-boolean-shorthand.js.html +1 -1
  23. package/coverage/lcov-report/src/jsx-expression-string-literals.js.html +1 -1
  24. package/coverage/lcov-report/src/jsx-ref-string-exists.js.html +1 -1
  25. package/coverage/lcov-report/src/no-static-key-in-map.js.html +1 -1
  26. package/coverage/lcov-report/src/no-unused-setup-return.js.html +1342 -0
  27. package/coverage/lcov-report/src/no-v-model-on-prop.js.html +1 -1
  28. package/coverage/lcov-report/src/plugin.js.html +8 -2
  29. package/coverage/lcov-report/src/recommended.js.html +1 -1
  30. package/coverage/lcov-report/src/require-fragment-key.js.html +1 -1
  31. package/coverage/lcov-report/src/route-dto-required.js.html +1 -1
  32. package/coverage/lcov-report/src/v-model-name-match.js.html +1 -1
  33. package/coverage/lcov-report/src/vuejs-define-component.js.html +1 -1
  34. package/coverage/lcov-report/src/vuejs-define-workspace.js.html +1 -1
  35. package/coverage/lcov.info +434 -0
  36. package/decl/back/back.d.ts +42 -0
  37. package/decl/client/client.d.ts +43 -0
  38. package/decl/no-unused-setup-return.d.ts +71 -0
  39. package/decl/plugin.d.ts +42 -0
  40. package/package.json +2 -2
  41. package/src/client/client.js +1 -0
  42. package/src/no-unused-setup-return.js +419 -0
  43. package/src/plugin.js +2 -0
  44. package/tests/no-unused-setup-return.spec.js +136 -0
@@ -0,0 +1,136 @@
1
+ import fs from 'node:fs';
2
+ import os from 'node:os';
3
+ import path from 'node:path';
4
+ import {
5
+ getKeyName, getWholeContextUsage, isComponentFileName, isComposableFile, isImportedElsewhere, readImportedRenders, isUsed, stripComments, usesWholeContext,
6
+ } from '../src/no-unused-setup-return';
7
+
8
+ describe('GIVEN "no-unused-setup-return" / isComposableFile', () => {
9
+ it.each([
10
+ ['/a/useFoo.ts', true],
11
+ ['/a/useFoo2.ts', true],
12
+ ['/a/useRender.tsx', false],
13
+ ['/a/useFoo.spec.ts', false],
14
+ ['/a/Foo.ts', false],
15
+ ['/a/user.ts', false],
16
+ ])('THEN %s → %s', (file, expected) => {
17
+ expect(isComposableFile(file)).toBe(expected);
18
+ });
19
+ });
20
+
21
+ describe('GIVEN "no-unused-setup-return" / isUsed', () => {
22
+ it.each([
23
+ ['series', 'c.series.value', true],
24
+ ['series', 'const { series } = c;', true],
25
+ ['series', 'c.seriesCount', false],
26
+ ['series', 'c.allseries', false],
27
+ ['series', 'c.$series', false],
28
+ ['grid', '<GGrid ref="grid" />', true],
29
+ ['a.b', 'axb', false],
30
+ ])('THEN %s in %s → %s', (name, text, expected) => {
31
+ expect(isUsed(name, [text])).toBe(expected);
32
+ });
33
+ });
34
+
35
+ describe('GIVEN "no-unused-setup-return" / stripComments', () => {
36
+ it('THEN a commented use does not count', () => {
37
+ const text = stripComments('// c.foo\n/* c.bar */\nc.baz; const u = "http://x";');
38
+ expect(isUsed('foo', [text])).toBe(false);
39
+ expect(isUsed('bar', [text])).toBe(false);
40
+ expect(isUsed('baz', [text])).toBe(true);
41
+ expect(text).toContain('http://x');
42
+ });
43
+ });
44
+
45
+ describe('GIVEN "no-unused-setup-return" / usesWholeContext', () => {
46
+ it.each([
47
+ ['export default function (c: Foo) { return <A {...c} />; }', true],
48
+ ['export default function (c: Foo) { return <A>{render(c)}</A>; }', true],
49
+ ['export default function (c: Foo) { return <A>{render(a, c)}</A>; }', true],
50
+ ['export default function (c: Foo) { return <A v={c.a} />; }', false],
51
+ ['export default function (c: Foo) { return <A v={fn(c.a, c.b)} />; }', false],
52
+ ['export default function ({ a }: Foo) { return <A v={a} />; }', false],
53
+ ])('THEN %s → %s', (text, expected) => {
54
+ expect(usesWholeContext(text)).toBe(expected);
55
+ });
56
+ });
57
+
58
+ describe('GIVEN "no-unused-setup-return" / getKeyName', () => {
59
+ it.each([
60
+ [{ type: 'Property', computed: false, key: { type: 'Identifier', name: 'a' } }, 'a'],
61
+ [{ type: 'Property', computed: false, key: { type: 'Literal', value: 'b' } }, 'b'],
62
+ [{ type: 'Property', computed: true, key: { type: 'Identifier', name: 'c' } }, null],
63
+ [{ type: 'SpreadElement' }, null],
64
+ ])('THEN %j → %s', (prop, expected) => {
65
+ expect(getKeyName(prop)).toBe(expected);
66
+ });
67
+ });
68
+
69
+ describe('GIVEN "no-unused-setup-return" / getWholeContextUsage', () => {
70
+ it.each([
71
+ ['export default function (c: Foo) { return <A {...c} />; }', { spread: true, callees: [] }],
72
+ ['export default function (c: Foo) { return <A>{render(c)}</A>; }', { spread: false, callees: ['render'] }],
73
+ ['export default function (c: Foo) { return <A>{f(value, row, c)}</A>; }', { spread: false, callees: ['f'] }],
74
+ ['export default function (c: Foo) { return <A v={c.a} />; }', { spread: false, callees: [] }],
75
+ ['export default function (c: Foo) { return <A {...c.$attrs} {...c?.b} {...c[k]} />; }', { spread: false, callees: [] }],
76
+ ])('THEN %s → %j', (text, expected) => {
77
+ expect(getWholeContextUsage(text)).toEqual(expected);
78
+ });
79
+ });
80
+
81
+ describe('GIVEN "no-unused-setup-return" / isComponentFileName', () => {
82
+ it.each([
83
+ ['/a/DailyPL.ts', true],
84
+ ['/a/WorkspaceFoo.ts', true],
85
+ ['/a/useDailyPL.ts', false],
86
+ ['/a/useRender.tsx', false],
87
+ ['/a/DailyPL.spec.ts', false],
88
+ ['/a/types.d.ts', false],
89
+ ])('THEN %s → %s', (file, expected) => {
90
+ expect(isComponentFileName(file)).toBe(expected);
91
+ });
92
+ });
93
+
94
+ describe('GIVEN "no-unused-setup-return" / isImportedElsewhere', () => {
95
+ let dir;
96
+ beforeAll(() => {
97
+ dir = fs.mkdtempSync(path.join(os.tmpdir(), 'nusr-'));
98
+ const w = (f, t) => { fs.mkdirSync(path.dirname(path.join(dir, f)), { recursive: true }); fs.writeFileSync(path.join(dir, f), t); };
99
+ w('package.json', '{}');
100
+ w('src/a/useA.ts', 'export default () => ({})');
101
+ w('src/a/A.ts', "import setup from './useA';");
102
+ w('src/b/B.ts', "import useA from '../a/useA';");
103
+ w('src/c/useC.ts', 'export default () => ({})');
104
+ w('src/c/C.ts', "import setup from './useC';");
105
+ w('src/d/useD.ts', 'export default () => ({})');
106
+ w('src/e/E.ts', "import useD from '../x/useD';");
107
+ });
108
+ afterAll(() => fs.rmSync(dir, { recursive: true, force: true }));
109
+
110
+ it('THEN imported by another directory → true', () => {
111
+ expect(isImportedElsewhere(path.join(dir, 'src/a/useA.ts'))).toBe(true);
112
+ });
113
+ it('THEN imported only by its own directory → false', () => {
114
+ expect(isImportedElsewhere(path.join(dir, 'src/c/useC.ts'))).toBe(false);
115
+ });
116
+ it('THEN a relative import resolving elsewhere is ignored → false', () => {
117
+ expect(isImportedElsewhere(path.join(dir, 'src/d/useD.ts'))).toBe(false);
118
+ });
119
+ });
120
+
121
+ describe('GIVEN "no-unused-setup-return" / readImportedRenders', () => {
122
+ it('THEN reads a shared render of the parent directory', () => {
123
+ const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'nusr-r-'));
124
+ fs.mkdirSync(path.join(dir, 'child'));
125
+ fs.writeFileSync(path.join(dir, 'useShared.tsx'), '// c.nope\nexport default (c) => c.formTitle;');
126
+ const texts = readImportedRenders("import render from '../useShared';\nimport other from './x';", path.join(dir, 'child'));
127
+ expect(texts).toHaveLength(1);
128
+ expect(isUsed('formTitle', texts)).toBe(true);
129
+ expect(isUsed('nope', texts)).toBe(false);
130
+ fs.rmSync(dir, { recursive: true, force: true });
131
+ });
132
+
133
+ it('THEN an alias import is ignored', () => {
134
+ expect(readImportedRenders("import render from '@/x/render';", '/tmp')).toEqual([]);
135
+ });
136
+ });