eslint-plugin-esm 0.4.0 → 0.5.0

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 (60) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/common.d.ts +2 -2
  3. package/dist/common.d.ts.map +1 -1
  4. package/dist/common.js +5 -5
  5. package/dist/index.d.ts.map +1 -1
  6. package/dist/index.js +5 -3
  7. package/dist/rules/no-declaration-file-imports.d.ts +5 -0
  8. package/dist/rules/no-declaration-file-imports.d.ts.map +1 -0
  9. package/dist/rules/no-declaration-file-imports.js +11 -0
  10. package/dist/rules/no-directory-imports.js +1 -1
  11. package/dist/rules/no-dynamic-imports.js +1 -1
  12. package/dist/rules/no-empty-exports.js +1 -1
  13. package/dist/rules/no-git-ignored-imports.js +1 -1
  14. package/dist/rules/no-inexistent-relative-imports.d.ts +5 -0
  15. package/dist/rules/no-inexistent-relative-imports.d.ts.map +1 -0
  16. package/dist/rules/no-inexistent-relative-imports.js +64 -0
  17. package/dist/rules/no-phantom-dep-imports.js +1 -1
  18. package/dist/rules/no-relative-parent-imports.js +1 -1
  19. package/dist/rules/no-rename-exports.js +1 -1
  20. package/dist/rules/no-rename-imports.js +1 -1
  21. package/dist/rules/no-side-effect-imports.js +1 -1
  22. package/dist/rules/no-useless-path-segments.js +1 -1
  23. package/dist/rules/required-exports.js +1 -1
  24. package/doc/rules/{no-ts-file-imports.md → no-declaration-file-imports.md} +7 -7
  25. package/doc/rules/no-inexistent-relative-imports.md +28 -0
  26. package/doc/rules/no-phantom-dep-imports.md +1 -1
  27. package/package.json +4 -6
  28. package/src/common.ts +5 -5
  29. package/src/index.ts +15 -13
  30. package/src/rules/{no-ts-file-imports.spec.ts → no-declaration-file-imports.spec.ts} +13 -10
  31. package/src/rules/no-declaration-file-imports.ts +12 -0
  32. package/src/rules/no-directory-imports.spec.ts +2 -2
  33. package/src/rules/no-directory-imports.ts +2 -2
  34. package/src/rules/no-dynamic-imports.spec.ts +2 -2
  35. package/src/rules/no-dynamic-imports.ts +1 -1
  36. package/src/rules/no-empty-exports.spec.ts +2 -2
  37. package/src/rules/no-empty-exports.ts +1 -1
  38. package/src/rules/no-git-ignored-imports.spec.ts +2 -2
  39. package/src/rules/no-git-ignored-imports.ts +2 -2
  40. package/src/rules/no-inexistent-relative-imports.spec.ts +27 -0
  41. package/src/rules/no-inexistent-relative-imports.ts +72 -0
  42. package/src/rules/no-phantom-dep-imports.spec.ts +3 -3
  43. package/src/rules/no-phantom-dep-imports.ts +1 -1
  44. package/src/rules/no-relative-parent-imports.spec.ts +2 -2
  45. package/src/rules/no-relative-parent-imports.ts +1 -1
  46. package/src/rules/no-rename-exports.spec.ts +2 -2
  47. package/src/rules/no-rename-exports.ts +1 -1
  48. package/src/rules/no-rename-imports.spec.ts +2 -2
  49. package/src/rules/no-rename-imports.ts +1 -1
  50. package/src/rules/no-side-effect-imports.spec.ts +2 -2
  51. package/src/rules/no-side-effect-imports.ts +1 -1
  52. package/src/rules/no-useless-path-segments.spec.ts +2 -2
  53. package/src/rules/no-useless-path-segments.ts +1 -1
  54. package/src/rules/required-exports.spec.ts +2 -2
  55. package/src/rules/required-exports.ts +1 -1
  56. package/dist/rules/no-ts-file-imports.d.ts +0 -5
  57. package/dist/rules/no-ts-file-imports.d.ts.map +0 -1
  58. package/dist/rules/no-ts-file-imports.js +0 -14
  59. package/src/rules/no-ts-file-imports.ts +0 -15
  60. package/src/test.spec.ts +0 -123
package/src/common.ts CHANGED
@@ -17,7 +17,7 @@ export function createRule({
17
17
  schema,
18
18
  fixable,
19
19
  type = "suggestion",
20
- create,
20
+ create: createFn,
21
21
  }: {
22
22
  name: string;
23
23
  message: string;
@@ -39,7 +39,7 @@ export function createRule({
39
39
  description: message,
40
40
  },
41
41
  },
42
- create,
42
+ create: createFn,
43
43
  };
44
44
  return { name, rule };
45
45
  }
@@ -61,10 +61,10 @@ export type ImportationNode =
61
61
  * @param check the check logic
62
62
  * @returns ESLint RuleListener
63
63
  */
64
- export const create = (
64
+ export function create(
65
65
  context: Rule.RuleContext,
66
66
  check: (filename: string, source: string, node: ImportationNode) => boolean,
67
- ): Rule.RuleListener => {
67
+ ): Rule.RuleListener {
68
68
  const handle = (node: ImportationNode) => {
69
69
  if (!node.source) return;
70
70
  if (!("value" in node.source)) return;
@@ -78,7 +78,7 @@ export const create = (
78
78
  ExportAllDeclaration: handle,
79
79
  ExportNamedDeclaration: handle,
80
80
  };
81
- };
81
+ }
82
82
 
83
83
  export function getSourceType(source: string) {
84
84
  if (
package/src/index.ts CHANGED
@@ -1,27 +1,29 @@
1
- import { noDirectoryImports } from "./rules/no-directory-imports.js";
2
- import { noDynamicImports } from "./rules/no-dynamic-imports.js";
3
- import { noEmptyExports } from "./rules/no-empty-exports.js";
4
- import { noGitIgnoredImports } from "./rules/no-git-ignored-imports.js";
5
- import { noPhantomDepImports } from "./rules/no-phantom-dep-imports.js";
6
- import { noRelativeParentImports } from "./rules/no-relative-parent-imports.js";
7
- import { noRenameExports } from "./rules/no-rename-exports.js";
8
- import { noRenameImports } from "./rules/no-rename-imports.js";
9
- import { noSideEffectImports } from "./rules/no-side-effect-imports.js";
10
- import { noTsFileImports } from "./rules/no-ts-file-imports.js";
11
- import { noUselessPathSegments } from "./rules/no-useless-path-segments.js";
12
- import { requiredExports } from "./rules/required-exports.js";
1
+ import { noDeclarationFileImports } from "./rules/no-declaration-file-imports.ts";
2
+ import { noDirectoryImports } from "./rules/no-directory-imports.ts";
3
+ import { noDynamicImports } from "./rules/no-dynamic-imports.ts";
4
+ import { noEmptyExports } from "./rules/no-empty-exports.ts";
5
+ import { noGitIgnoredImports } from "./rules/no-git-ignored-imports.ts";
6
+ import { noInexistentRelativeImports } from "./rules/no-inexistent-relative-imports.ts";
7
+ import { noPhantomDepImports } from "./rules/no-phantom-dep-imports.ts";
8
+ import { noRelativeParentImports } from "./rules/no-relative-parent-imports.ts";
9
+ import { noRenameExports } from "./rules/no-rename-exports.ts";
10
+ import { noRenameImports } from "./rules/no-rename-imports.ts";
11
+ import { noSideEffectImports } from "./rules/no-side-effect-imports.ts";
12
+ import { noUselessPathSegments } from "./rules/no-useless-path-segments.ts";
13
+ import { requiredExports } from "./rules/required-exports.ts";
13
14
 
14
15
  export const rules = {
16
+ [noDeclarationFileImports.name]: noDeclarationFileImports.rule,
15
17
  [noDirectoryImports.name]: noDirectoryImports.rule,
16
18
  [noDynamicImports.name]: noDynamicImports.rule,
17
19
  [noEmptyExports.name]: noEmptyExports.rule,
18
20
  [noGitIgnoredImports.name]: noGitIgnoredImports.rule,
21
+ [noInexistentRelativeImports.name]: noInexistentRelativeImports.rule,
19
22
  [noPhantomDepImports.name]: noPhantomDepImports.rule,
20
23
  [noRelativeParentImports.name]: noRelativeParentImports.rule,
21
24
  [noRenameExports.name]: noRenameExports.rule,
22
25
  [noRenameImports.name]: noRenameImports.rule,
23
26
  [noSideEffectImports.name]: noSideEffectImports.rule,
24
- [noTsFileImports.name]: noTsFileImports.rule,
25
27
  [noUselessPathSegments.name]: noUselessPathSegments.rule,
26
28
  [requiredExports.name]: requiredExports.rule,
27
29
  };
@@ -1,12 +1,7 @@
1
- import { test } from "../test.spec.js";
2
- import { noTsFileImports } from "./no-ts-file-imports.js";
1
+ import { test } from "@fenge/dev-utils";
2
+ import { noDeclarationFileImports } from "./no-declaration-file-imports.ts";
3
3
 
4
4
  const invalid = [
5
- "import foo from './foo.ts'",
6
- "import foo from './foo.cts'",
7
- "import foo from './foo.mts'",
8
- "import foo from './foo.tsx'",
9
-
10
5
  "import foo from 'foo.d.bar'",
11
6
  "import foo from './foo.d.bar'",
12
7
  "import foo from './foo/foo.d.bar'",
@@ -21,10 +16,18 @@ const invalid = [
21
16
  "import foo from './foo.d.mjs'",
22
17
  "import foo from './foo.d.jsx'",
23
18
 
24
- "import foo from '/foo.ts'",
25
19
  "import foo from '/foo.d.js'",
26
20
  ];
27
21
 
28
- const valid = ["import foo from 'foo'"];
22
+ const valid = [
23
+ "import foo from 'foo'",
24
+
25
+ "import foo from './foo.ts'",
26
+ "import foo from './foo.cts'",
27
+ "import foo from './foo.mts'",
28
+ "import foo from './foo.tsx'",
29
+
30
+ "import foo from '/foo.ts'",
31
+ ];
29
32
 
30
- test({ valid, invalid, ...noTsFileImports });
33
+ test({ valid, invalid, ...noDeclarationFileImports });
@@ -0,0 +1,12 @@
1
+ import { create, createRule, getRuleName } from "../common.ts";
2
+
3
+ export const noDeclarationFileImports = createRule({
4
+ name: getRuleName(import.meta.url),
5
+ message: "Disallow importing from a declaration style file.",
6
+ create: (context) => create(context, check),
7
+ });
8
+
9
+ function check(_filename: string, source: string) {
10
+ const file = source.split("/").at(-1);
11
+ return !file || file.includes(".d.");
12
+ }
@@ -1,7 +1,7 @@
1
1
  import process from "node:process";
2
2
  import { fileURLToPath } from "node:url";
3
- import { test } from "../test.spec.js";
4
- import { noDirectoryImports } from "./no-directory-imports.js";
3
+ import { test } from "@fenge/dev-utils";
4
+ import { noDirectoryImports } from "./no-directory-imports.ts";
5
5
 
6
6
  const valid = [
7
7
  "import foo from 'foo'",
@@ -1,7 +1,7 @@
1
1
  import fs from "node:fs";
2
2
  import path from "node:path";
3
- import { create, createRule, getRuleName, getSourceType } from "../common.js";
4
- import { memoize } from "../utils.js";
3
+ import { create, createRule, getRuleName, getSourceType } from "../common.ts";
4
+ import { memoize } from "../utils.ts";
5
5
 
6
6
  export const noDirectoryImports = createRule({
7
7
  name: getRuleName(import.meta.url),
@@ -1,5 +1,5 @@
1
- import { test } from "../test.spec.js";
2
- import { noDynamicImports } from "./no-dynamic-imports.js";
1
+ import { test } from "@fenge/dev-utils";
2
+ import { noDynamicImports } from "./no-dynamic-imports.ts";
3
3
 
4
4
  const valid = [
5
5
  "import('foo')",
@@ -1,5 +1,5 @@
1
1
  import type { Node } from "estree";
2
- import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.js";
2
+ import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.ts";
3
3
 
4
4
  export const noDynamicImports = createRule({
5
5
  name: getRuleName(import.meta.url),
@@ -1,5 +1,5 @@
1
- import { test } from "../test.spec.js";
2
- import { noEmptyExports } from "./no-empty-exports.js";
1
+ import { test } from "@fenge/dev-utils";
2
+ import { noEmptyExports } from "./no-empty-exports.ts";
3
3
 
4
4
  const valid = [
5
5
  "var name = 123; export {name as age};",
@@ -1,5 +1,5 @@
1
1
  import type { Node } from "estree";
2
- import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.js";
2
+ import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.ts";
3
3
 
4
4
  export const noEmptyExports = createRule({
5
5
  name: getRuleName(import.meta.url),
@@ -1,7 +1,7 @@
1
1
  import process from "node:process";
2
2
  import { fileURLToPath } from "node:url";
3
- import { test } from "../test.spec.js";
4
- import { noGitIgnoredImports } from "./no-git-ignored-imports.js";
3
+ import { test } from "@fenge/dev-utils";
4
+ import { noGitIgnoredImports } from "./no-git-ignored-imports.ts";
5
5
 
6
6
  const valid = [
7
7
  "import foo from 'foo'",
@@ -2,8 +2,8 @@ import childProcess from "node:child_process";
2
2
  import path from "node:path";
3
3
  import process from "node:process";
4
4
  import { isNativeError } from "node:util/types";
5
- import { create, createRule, getRuleName, getSourceType } from "../common.js";
6
- import { memoize } from "../utils.js";
5
+ import { create, createRule, getRuleName, getSourceType } from "../common.ts";
6
+ import { memoize } from "../utils.ts";
7
7
 
8
8
  export const noGitIgnoredImports = createRule({
9
9
  name: getRuleName(import.meta.url),
@@ -0,0 +1,27 @@
1
+ import { fileURLToPath } from "node:url";
2
+ import { test } from "@fenge/dev-utils";
3
+ import { noInexistentRelativeImports } from "./no-inexistent-relative-imports.ts";
4
+
5
+ const filename = fileURLToPath(import.meta.url);
6
+
7
+ const valid = [
8
+ "import foo from 'foo'",
9
+
10
+ // with ext
11
+ "import foo from './no-inexistent-relative-imports.spec.ts'",
12
+ // without ext
13
+ "import foo from './no-inexistent-relative-imports.spec'",
14
+ "import foo from '../rules'",
15
+ "import foo from '.'",
16
+ "import foo from './'",
17
+ "import foo from '..'",
18
+ "import foo from '../'",
19
+ ].map((code) => ({ code, filename }));
20
+
21
+ const invalid = [
22
+ "import foo from './no-inexistent-relative-imports.spec.js'",
23
+ "import foo from './inexistent-file'",
24
+ "import foo from '../inexistent-file'",
25
+ ].map((code) => ({ code, filename }));
26
+
27
+ test({ valid, invalid, ...noInexistentRelativeImports });
@@ -0,0 +1,72 @@
1
+ import fs from "node:fs";
2
+ import path from "node:path";
3
+ import { create, createRule, getRuleName, getSourceType } from "../common.ts";
4
+ import { memoize } from "../utils.ts";
5
+
6
+ export const noInexistentRelativeImports = createRule({
7
+ name: getRuleName(import.meta.url),
8
+ message: "Disallow importing from a relative file which is inexistent.",
9
+ create: (context) => create(context, check),
10
+ });
11
+
12
+ function check(filename: string, source: string) {
13
+ if (getSourceType(source) !== "local") {
14
+ return false;
15
+ }
16
+ return !isExisting(path.resolve(path.dirname(filename), source));
17
+ }
18
+
19
+ const isExisting = memoize((filepath: string): boolean =>
20
+ endsWithExtension(filepath)
21
+ ? isFile(filepath)
22
+ : isDirectory(filepath) ||
23
+ isFile(`${filepath}.js`) ||
24
+ isFile(`${filepath}.cjs`) ||
25
+ isFile(`${filepath}.mjs`) ||
26
+ isFile(`${filepath}.jsx`) ||
27
+ isFile(`${filepath}.ts`) ||
28
+ isFile(`${filepath}.cts`) ||
29
+ isFile(`${filepath}.mts`) ||
30
+ isFile(`${filepath}.tsx`) ||
31
+ isFile(`${filepath}.json`) ||
32
+ isFile(`${filepath}.node`),
33
+ );
34
+
35
+ function isFile(filepath: string) {
36
+ try {
37
+ return fs.statSync(filepath).isFile();
38
+ } catch {
39
+ return false;
40
+ }
41
+ }
42
+
43
+ function isDirectory(filepath: string) {
44
+ try {
45
+ return fs.statSync(filepath).isDirectory();
46
+ } catch {
47
+ return false;
48
+ }
49
+ }
50
+
51
+ function endsWithExtension(filepath: string) {
52
+ const extensions = [
53
+ "js",
54
+ "cjs",
55
+ "mjs",
56
+ "jsx",
57
+
58
+ "ts",
59
+ "cts",
60
+ "mts",
61
+ "tsx",
62
+
63
+ "json",
64
+ "node",
65
+
66
+ "css",
67
+ "scss",
68
+ "sass",
69
+ "less",
70
+ ];
71
+ return extensions.some((ext) => filepath.endsWith(`.${ext}`));
72
+ }
@@ -1,5 +1,5 @@
1
- import { test } from "../test.spec.js";
2
- import { noPhantomDepImports } from "./no-phantom-dep-imports.js";
1
+ import { test } from "@fenge/dev-utils";
2
+ import { noPhantomDepImports } from "./no-phantom-dep-imports.ts";
3
3
 
4
4
  const valid = [
5
5
  { code: "import foo from '/foo'" },
@@ -10,7 +10,7 @@ const valid = [
10
10
  { code: "import type Foo from 'estree'" },
11
11
  { code: "import type {Foo} from 'eslint'" },
12
12
  {
13
- code: "import eslint from 'eslint'",
13
+ code: "import foo from '@fenge/dev-utils'",
14
14
  options: [{ allowDevDependencies: true }],
15
15
  },
16
16
  ];
@@ -1,7 +1,7 @@
1
1
  import fs from "node:fs";
2
2
  import path from "node:path";
3
3
  import process from "node:process";
4
- import { create, createRule, getRuleName, getSourceType } from "../common.js";
4
+ import { create, createRule, getRuleName, getSourceType } from "../common.ts";
5
5
 
6
6
  function isObject(value: unknown) {
7
7
  return value !== null && typeof value === "object";
@@ -1,5 +1,5 @@
1
- import { test } from "../test.spec.js";
2
- import { noRelativeParentImports } from "./no-relative-parent-imports.js";
1
+ import { test } from "@fenge/dev-utils";
2
+ import { noRelativeParentImports } from "./no-relative-parent-imports.ts";
3
3
 
4
4
  const valid = [
5
5
  "import foo from 'foo'",
@@ -1,4 +1,4 @@
1
- import { create, createRule, getRuleName } from "../common.js";
1
+ import { create, createRule, getRuleName } from "../common.ts";
2
2
 
3
3
  const depth = 3;
4
4
 
@@ -1,5 +1,5 @@
1
- import { test } from "../test.spec.js";
2
- import { noRenameExports } from "./no-rename-exports.js";
1
+ import { test } from "@fenge/dev-utils";
2
+ import { noRenameExports } from "./no-rename-exports.ts";
3
3
 
4
4
  const valid = [
5
5
  "let foo=1; export {foo}",
@@ -1,4 +1,4 @@
1
- import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.js";
1
+ import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.ts";
2
2
 
3
3
  export const noRenameExports = createRule({
4
4
  name: getRuleName(import.meta.url),
@@ -1,5 +1,5 @@
1
- import { test } from "../test.spec.js";
2
- import { noRenameImports } from "./no-rename-imports.js";
1
+ import { test } from "@fenge/dev-utils";
2
+ import { noRenameImports } from "./no-rename-imports.ts";
3
3
 
4
4
  const valid = [
5
5
  "import Foo from 'foo'",
@@ -1,4 +1,4 @@
1
- import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.js";
1
+ import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.ts";
2
2
 
3
3
  export const noRenameImports = createRule({
4
4
  name: getRuleName(import.meta.url),
@@ -1,5 +1,5 @@
1
- import { test } from "../test.spec.js";
2
- import { noSideEffectImports } from "./no-side-effect-imports.js";
1
+ import { test } from "@fenge/dev-utils";
2
+ import { noSideEffectImports } from "./no-side-effect-imports.ts";
3
3
 
4
4
  const valid = [
5
5
  "import 'reflect-metadata'",
@@ -1,5 +1,5 @@
1
1
  import type { ImportDeclaration } from "estree";
2
- import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.js";
2
+ import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.ts";
3
3
 
4
4
  const ignores = [
5
5
  "^reflect-metadata$",
@@ -1,5 +1,5 @@
1
- import { test } from "../test.spec.js";
2
- import { noUselessPathSegments } from "./no-useless-path-segments.js";
1
+ import { test } from "@fenge/dev-utils";
2
+ import { noUselessPathSegments } from "./no-useless-path-segments.ts";
3
3
 
4
4
  const valid = [
5
5
  'import xxx from "../a"',
@@ -1,5 +1,5 @@
1
1
  import path from "node:path";
2
- import { create, createRule, getRuleName, getSourceType } from "../common.js";
2
+ import { create, createRule, getRuleName, getSourceType } from "../common.ts";
3
3
 
4
4
  export const noUselessPathSegments = createRule({
5
5
  name: getRuleName(import.meta.url),
@@ -1,5 +1,5 @@
1
- import { test } from "../test.spec.js";
2
- import { requiredExports } from "./required-exports.js";
1
+ import { test } from "@fenge/dev-utils";
2
+ import { requiredExports } from "./required-exports.ts";
3
3
 
4
4
  const valid = [
5
5
  "export {}",
@@ -1,4 +1,4 @@
1
- import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.js";
1
+ import { createRule, DEFAULT_MESSAGE_ID, getRuleName } from "../common.ts";
2
2
 
3
3
  export const requiredExports = createRule({
4
4
  name: getRuleName(import.meta.url),
@@ -1,5 +0,0 @@
1
- export declare const noTsFileImports: {
2
- name: string;
3
- rule: import("eslint").Rule.RuleModule;
4
- };
5
- //# sourceMappingURL=no-ts-file-imports.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"no-ts-file-imports.d.ts","sourceRoot":"","sources":["../../src/rules/no-ts-file-imports.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe;;;CAI1B,CAAC"}
@@ -1,14 +0,0 @@
1
- import { create, createRule, getRuleName } from "../common.js";
2
- export const noTsFileImports = createRule({
3
- name: getRuleName(import.meta.url),
4
- message: "Disallow importing from a declaration style file or a ts file",
5
- create: (context) => create(context, check),
6
- });
7
- function check(_filename, source) {
8
- const file = source.split("/").at(-1);
9
- if (!file || file.includes(".d.")) {
10
- return true;
11
- }
12
- return [".ts", ".cts", ".mts", ".tsx"].some((ext) => file.endsWith(ext));
13
- }
14
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm8tdHMtZmlsZS1pbXBvcnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3J1bGVzL25vLXRzLWZpbGUtaW1wb3J0cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsTUFBTSxFQUFFLFVBQVUsRUFBRSxXQUFXLEVBQUUsTUFBTSxjQUFjLENBQUM7QUFFL0QsTUFBTSxDQUFDLE1BQU0sZUFBZSxHQUFHLFVBQVUsQ0FBQztJQUN4QyxJQUFJLEVBQUUsV0FBVyxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDO0lBQ2xDLE9BQU8sRUFBRSwrREFBK0Q7SUFDeEUsTUFBTSxFQUFFLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxNQUFNLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQztDQUM1QyxDQUFDLENBQUM7QUFFSCxTQUFTLEtBQUssQ0FBQyxTQUFpQixFQUFFLE1BQWM7SUFDOUMsTUFBTSxJQUFJLEdBQUcsTUFBTSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN0QyxJQUFJLENBQUMsSUFBSSxJQUFJLElBQUksQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUNsQyxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFDRCxPQUFPLENBQUMsS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsTUFBTSxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsR0FBRyxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7QUFDM0UsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IGNyZWF0ZSwgY3JlYXRlUnVsZSwgZ2V0UnVsZU5hbWUgfSBmcm9tIFwiLi4vY29tbW9uLmpzXCI7XG5cbmV4cG9ydCBjb25zdCBub1RzRmlsZUltcG9ydHMgPSBjcmVhdGVSdWxlKHtcbiAgbmFtZTogZ2V0UnVsZU5hbWUoaW1wb3J0Lm1ldGEudXJsKSxcbiAgbWVzc2FnZTogXCJEaXNhbGxvdyBpbXBvcnRpbmcgZnJvbSBhIGRlY2xhcmF0aW9uIHN0eWxlIGZpbGUgb3IgYSB0cyBmaWxlXCIsXG4gIGNyZWF0ZTogKGNvbnRleHQpID0+IGNyZWF0ZShjb250ZXh0LCBjaGVjayksXG59KTtcblxuZnVuY3Rpb24gY2hlY2soX2ZpbGVuYW1lOiBzdHJpbmcsIHNvdXJjZTogc3RyaW5nKSB7XG4gIGNvbnN0IGZpbGUgPSBzb3VyY2Uuc3BsaXQoXCIvXCIpLmF0KC0xKTtcbiAgaWYgKCFmaWxlIHx8IGZpbGUuaW5jbHVkZXMoXCIuZC5cIikpIHtcbiAgICByZXR1cm4gdHJ1ZTtcbiAgfVxuICByZXR1cm4gW1wiLnRzXCIsIFwiLmN0c1wiLCBcIi5tdHNcIiwgXCIudHN4XCJdLnNvbWUoKGV4dCkgPT4gZmlsZS5lbmRzV2l0aChleHQpKTtcbn1cbiJdfQ==
@@ -1,15 +0,0 @@
1
- import { create, createRule, getRuleName } from "../common.js";
2
-
3
- export const noTsFileImports = createRule({
4
- name: getRuleName(import.meta.url),
5
- message: "Disallow importing from a declaration style file or a ts file",
6
- create: (context) => create(context, check),
7
- });
8
-
9
- function check(_filename: string, source: string) {
10
- const file = source.split("/").at(-1);
11
- if (!file || file.includes(".d.")) {
12
- return true;
13
- }
14
- return [".ts", ".cts", ".mts", ".tsx"].some((ext) => file.endsWith(ext));
15
- }
package/src/test.spec.ts DELETED
@@ -1,123 +0,0 @@
1
- import fs from "node:fs/promises";
2
- import { createRequire } from "node:module";
3
- import path from "node:path";
4
- import process from "node:process";
5
- import { describe, it } from "node:test";
6
- import { fileURLToPath } from "node:url";
7
- import { RuleTester, type Rule } from "eslint";
8
- import { outdent } from "outdent";
9
-
10
- export type TestCase =
11
- | string
12
- | { code: string; filename?: string; options?: unknown };
13
-
14
- const tester = new RuleTester({
15
- parser: createRequire(import.meta.url).resolve("@typescript-eslint/parser"),
16
- parserOptions: { ecmaVersion: "latest", sourceType: "module" },
17
- });
18
-
19
- export async function test({
20
- name,
21
- rule,
22
- valid,
23
- invalid,
24
- errors = 1,
25
- }: {
26
- name: string;
27
- rule: Rule.RuleModule;
28
- valid: TestCase[];
29
- invalid: TestCase[];
30
- errors?: number;
31
- }) {
32
- await describe(name, async () => {
33
- await Promise.all(
34
- valid.map(async (testCase) => {
35
- await it(JSON.stringify(testCase), () => {
36
- tester.run(name, rule, {
37
- valid: [testCase],
38
- invalid: [],
39
- ...(typeof testCase === "object" && testCase.options
40
- ? { options: testCase.options }
41
- : {}),
42
- });
43
- });
44
- }),
45
- );
46
-
47
- await Promise.all(
48
- invalid.map(async (testCase) => {
49
- await it(JSON.stringify(testCase), () => {
50
- const code = typeof testCase === "string" ? testCase : testCase.code;
51
- const filename =
52
- typeof testCase === "string" ? undefined : testCase.filename;
53
- tester.run(name, rule, {
54
- valid: [],
55
- invalid: [{ code, errors, filename }],
56
- ...(typeof testCase === "object" && testCase.options
57
- ? { options: testCase.options }
58
- : {}),
59
- });
60
- });
61
- }),
62
- );
63
-
64
- await genDoc({ name, rule, valid, invalid });
65
- });
66
- }
67
-
68
- async function genDoc({
69
- name,
70
- rule,
71
- valid,
72
- invalid,
73
- }: {
74
- name: string;
75
- rule: Rule.RuleModule;
76
- valid: TestCase[];
77
- invalid: TestCase[];
78
- }) {
79
- const handle = (testCases: TestCase[]) =>
80
- testCases
81
- .map((testCase) =>
82
- typeof testCase === "string" ? { code: testCase } : testCase,
83
- )
84
- .map((testCase) => {
85
- if (!testCase.filename && !testCase.options) {
86
- return testCase.code;
87
- }
88
- const filename = testCase.filename && `filename: ${testCase.filename}`;
89
- const options =
90
- testCase.options && `options: ${JSON.stringify(testCase.options)}`;
91
- const comment = [filename, options].filter((i) => !!i).join(", ");
92
- return `${testCase.code} // ${comment}`;
93
- })
94
- .join("\n");
95
- const mdContent = outdent`
96
- <!-- prettier-ignore-start -->
97
- # ${name}
98
-
99
- ${rule.meta?.docs?.description}
100
-
101
- ## Rule Details
102
-
103
- ### Fail
104
-
105
- \`\`\`ts
106
- ${handle(invalid)}
107
- \`\`\`
108
-
109
- ### Pass
110
-
111
- \`\`\`ts
112
- ${handle(valid)}
113
- \`\`\`
114
- <!-- prettier-ignore-end -->
115
-
116
- `.replaceAll(process.cwd(), "/foo");
117
-
118
- const currentDir = path.dirname(fileURLToPath(import.meta.url));
119
- await fs.writeFile(
120
- path.join(currentDir, "..", "doc", "rules", `${name}.md`),
121
- mdContent,
122
- );
123
- }