eslint-plugin-esm 0.8.1 → 0.8.3

package/doc/rules/no-dynamic-imports.md

@@ -1,30 +0,0 @@
-<!-- prettier-ignore-start -->
-# no-dynamic-imports
-
-`import()` should be called with string literal.
-
-## Rule Details
-
-### Fail
-
-```ts
-import(false)
-import(123)
-await import(123)
-import(`foo`)
-import(foo)
-import({})
-import([])
-const foo = await import(foo)
-```
-
-### Pass
-
-```ts
-import('foo')
-import("foo")
-import("./foo")
-await import("foo")
-const foo = await import("foo")
-```
-<!-- prettier-ignore-end -->

package/doc/rules/no-empty-exports.md

@@ -1,29 +0,0 @@
-<!-- prettier-ignore-start -->
-# no-empty-exports
-
-Disallow `export {}`.
-
-## Rule Details
-
-### Fail
-
-```ts
-export {};
-console.log(123); export {};
-export default {}; export {};
-export {} from 'foo';
-export {} from './foo';
-```
-
-### Pass
-
-```ts
-var name = 123; export {name as age};
-const name = {}; export {name};
-export const name = {};
-export default {};
-var foo = 213; export {foo as default};
-export {default} from 'foo';
-export * as foo from 'foo';
-```
-<!-- prettier-ignore-end -->

package/doc/rules/no-git-ignored-imports.md

@@ -1,36 +0,0 @@
-<!-- prettier-ignore-start -->
-# no-git-ignored-imports
-
-Disallow to import module from a git-ignored path.
-
-## Rule Details
-
-### Fail
-
-```ts
-import foo from './dist/foo' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import './dist/foo' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import('./dist/foo') // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-export * from './dist/foo' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-export {name} from './dist/foo' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import foo from '../dist/index.js' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import foo from '../../node_modules/foo/bar.js' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import foo from '/foo/tmp' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import foo from '/foo/tmp' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import foo from '../../test/for-test' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import foo from '../../../../../for-test' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-```
-
-### Pass
-
-```ts
-import foo from 'foo' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import 'foo' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-require('foo') // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import('foo') // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-export * from 'foo' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-export {name} from 'foo' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import foo from '.foo' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-import foo from '../../../../for-test' // filename: /foo/src/rules/no-git-ignored-imports.test.ts
-```
-<!-- prettier-ignore-end -->

package/doc/rules/no-phantom-dep-imports.md

@@ -1,31 +0,0 @@
-<!-- prettier-ignore-start -->
-# no-phantom-dep-imports
-
-Disallow importing from a module which the nearest `package.json` doesn't include it.
-
-## Rule Details
-
-### Fail
-
-```ts
-import type foo from 'foo' // options: [{"allowDevDependencies":true}]
-import type foo from 'foo' // options: [{"allowDevDependencies":false}]
-import {type Foo} from 'foo'
-import foo from 'foo'
-import {type Foo} from 'eslint'
-import {Foo} from 'eslint'
-import eslint from 'eslint'
-```
-
-### Pass
-
-```ts
-import foo from '/foo'
-import foo from './foo'
-import foo from '../foo'
-import foo from 'node:foo'
-import type Foo from 'estree'
-import type {Foo} from 'eslint'
-import foo from '@fenge/dev-utils' // options: [{"allowDevDependencies":true}]
-```
-<!-- prettier-ignore-end -->

package/doc/rules/no-relative-parent-imports.md

@@ -1,33 +0,0 @@
-<!-- prettier-ignore-start -->
-# no-relative-parent-imports
-
-Disallow importing module from a relative parent path too deeply.
-
-## Rule Details
-
-### Fail
-
-```ts
-import foo from '../../../foo'
-import '../../../foo'
-import('../../../foo')
-export * from '../../../foo'
-export {name} from '../../../foo'
-import foo from '../../../../foo'
-```
-
-### Pass
-
-```ts
-import foo from 'foo'
-import 'foo'
-require('foo')
-import('foo')
-export * from 'foo'
-export {name} from 'foo'
-import foo from '.foo'
-import foo from './foo'
-import foo from '../foo'
-import foo from '../../foo'
-```
-<!-- prettier-ignore-end -->

package/doc/rules/no-rename-exports.md

@@ -1,29 +0,0 @@
-<!-- prettier-ignore-start -->
-# no-rename-exports
-
-Disallow renaming the named-exports.
-
-## Rule Details
-
-### Fail
-
-```ts
-let foo=1; export {foo as bar}
-let foo=1; export {foo as default}
-export {foo as bar} from './foo'
-export {default as foo} from './foo'
-export {type Foo as Bar}
-export type {Foo as Bar}
-```
-
-### Pass
-
-```ts
-let foo=1; export {foo}
-export let foo
-export const foo = bar
-export default foo
-export default {}
-export {}
-```
-<!-- prettier-ignore-end -->

package/doc/rules/no-rename-imports.md

@@ -1,28 +0,0 @@
-<!-- prettier-ignore-start -->
-# no-rename-imports
-
-Disallow renaming the named-imports.
-
-## Rule Details
-
-### Fail
-
-```ts
-import {foo as bar} from 'foo'
-import {default as foo} from 'foo'
-import type {foo as bar} from 'foo'
-import {type foo as bar} from 'foo'
-import type {default as foo} from 'foo'
-import {type default as foo} from 'foo'
-```
-
-### Pass
-
-```ts
-import Foo from 'foo'
-import {foo, bar} from 'foo'
-import {type foo} from 'foo'
-import type {foo} from 'foo'
-import type Foo from 'foo'
-```
-<!-- prettier-ignore-end -->

package/doc/rules/no-side-effect-imports.md

@@ -1,30 +0,0 @@
-<!-- prettier-ignore-start -->
-# no-side-effect-imports
-
-Side effect import is often used for polyfills and css. It's unsafe to use it.
-
-## Rule Details
-
-### Fail
-
-```ts
-import 'foo'
-import './foo'
-import {} from 'foo'
-import {} from './foo'
-import './reflect-metadata'
-import './foo.module.css'
-import 'foo.module.css'
-import 'foo.css'
-import './foo.css'
-import 'module.css'
-```
-
-### Pass
-
-```ts
-import 'reflect-metadata'
-import {} from 'reflect-metadata'
-import {foo} from 'foo'
-```
-<!-- prettier-ignore-end -->

package/doc/rules/no-useless-path-segments.md

@@ -1,54 +0,0 @@
-<!-- prettier-ignore-start -->
-# no-useless-path-segments
-
-The relative source path should be a nearest relative path.
-
-## Rule Details
-
-### Fail
-
-```ts
-import xxx from ".././../a" // filename: /a/b/c/d/e.js
-import ".././../a" // filename: /a/b/c/d/e.js
-import(".././../a") // filename: /a/b/c/d/e.js
-export * from ".././../a" // filename: /a/b/c/d/e.js
-export {a} from ".././../a" // filename: /a/b/c/d/e.js
-import xxx from "./../a" // filename: /a/b/c/d/e.js
-import "./../a" // filename: /a/b/c/d/e.js
-import("./../a") // filename: /a/b/c/d/e.js
-export * from "./../a" // filename: /a/b/c/d/e.js
-export {a} from "./../a" // filename: /a/b/c/d/e.js
-import "././foo" // filename: /a/b/c/d/e.js
-import "./../.././foo" // filename: /a/b/c/d/e.js
-import("./../.././foo") // filename: /a/b/c/d/e.js
-export * from "./../.././foo" // filename: /a/b/c/d/e.js
-export {a} from "./../.././foo" // filename: /a/b/c/d/e.js
-import "./../foo" // filename: /a/b/c/d/e.js
-import("./../foo") // filename: /a/b/c/d/e.js
-export * from "./../foo" // filename: /a/b/c/d/e.js
-export {a} from "./../foo" // filename: /a/b/c/d/e.js
-import foo from "./" // filename: /a/b/c/d/e.js
-import foo from '../' // filename: /a/b/c/d/e.js
-import foo from '../../' // filename: /a/b/c/d/e.js
-import foo from './..' // filename: /a/b/c/d/e.js
-```
-
-### Pass
-
-```ts
-import xxx from "../a" // filename: /a/b/c/d/e.js
-import "../a" // filename: /a/b/c/d/e.js
-import("../a") // filename: /a/b/c/d/e.js
-require("../a") // filename: /a/b/c/d/e.js
-import xxx from "./a" // filename: /a/b/c/d/e.js
-import xxx from "a" // filename: /a/b/c/d/e.js
-import xxx from ".a" // filename: /a/b/c/d/e.js
-export * from "a" // filename: /a/b/c/d/e.js
-export * from "./a" // filename: /a/b/c/d/e.js
-export {a} from "a" // filename: /a/b/c/d/e.js
-export {a} from "./a" // filename: /a/b/c/d/e.js
-import foo from "." // filename: /a/b/c/d/e.js
-import foo from '..' // filename: /a/b/c/d/e.js
-import foo from '../..' // filename: /a/b/c/d/e.js
-```
-<!-- prettier-ignore-end -->

package/doc/rules/required-exports.md

@@ -1,31 +0,0 @@
-<!-- prettier-ignore-start -->
-# required-exports
-
-It's required at least one `export` statement in a file.
-
-## Rule Details
-
-### Fail
-
-```ts
-// This rule will also report on empty files
-
-console.log()
-import foo from 'foo'
-exports.foo = {}
-module.exports = {}
-```
-
-### Pass
-
-```ts
-export {}
-const foo = 'foo'; export {foo}
-export const foo = {}
-export default {}
-export {foo} from 'foo'
-export {} from 'foo'
-export * as foo from 'foo'
-export {}; let foo = ''
-```
-<!-- prettier-ignore-end -->

package/doc/rules/top-side-effect-imports.md

@@ -1,31 +0,0 @@
-<!-- prettier-ignore-start -->
-# top-side-effect-imports
-
-Side effect imports must be placed before other import statements.
-
-## Rule Details
-
-### Fail
-
-```ts
-import {foo} from 'foo'; import 'reflect-metadata'
-import {bar} from 'bar'; import 'foo.css'
-import {foo} from 'foo'; import {} from 'bar'
-import {foo} from 'foo'; import 'bar'; import * as foo from 'reflect-metadata'
-import {foo} from 'foo'; import {} from 'reflect-metadata'; import * as bar from 'bar'
-import 'bar'; import r from 'reflect-metadata'; import {} from 'foo'
-```
-
-### Pass
-
-```ts
-import 'reflect-metadata'; import {foo} from 'foo'
-import 'foo.css'; import {bar} from 'bar'
-import 'reflect-metadata'; import 'foo.css'
-import 'foo.css'; import 'bar'
-import 'reflect-metadata'; import {foo} from 'foo'; import {bar} from 'bar'
-import 'foo.css'; import {foo} from 'foo'; import {bar} from 'bar'
-import 'reflect-metadata'
-import {foo} from 'foo'
-```
-<!-- prettier-ignore-end -->

package/src/common.ts

@@ -1,97 +0,0 @@
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import type { Rule } from "eslint";
-import type {
-  ExportAllDeclaration,
-  ExportNamedDeclaration,
-  ImportDeclaration,
-  ImportExpression,
-} from "estree";
-import type { JSONSchema4 } from "json-schema";
-
-export const DEFAULT_MESSAGE_ID = "default";
-
-export function createRule({
-  name,
-  message,
-  schema,
-  fixable,
-  type = "suggestion",
-  create: createFn,
-}: {
-  name: string;
-  message: string;
-  schema?: JSONSchema4[];
-  fixable?: Rule.RuleMetaData["fixable"];
-  type?: Rule.RuleMetaData["type"];
-  create: (context: Rule.RuleContext) => Rule.RuleListener;
-}): { name: string; rule: Rule.RuleModule } {
-  const rule: Rule.RuleModule = {
-    meta: {
-      ...(schema && { schema }),
-      ...(fixable && { fixable }),
-      messages: {
-        [DEFAULT_MESSAGE_ID]: message,
-      },
-      type,
-      docs: {
-        url: `https://github.com/zanminkian/fenge/blob/main/packages/eslint-plugin-esm/doc/rules/${name}.md`,
-        description: message,
-      },
-    },
-    create: createFn,
-  };
-  return { name, rule };
-}
-
-export function getRuleName(importMetaUrl: string) {
-  // remove '.js' extension
-  return path.parse(fileURLToPath(importMetaUrl)).name;
-}
-
-export type ImportationNode =
-  | ImportDeclaration
-  | ImportExpression
-  | ExportAllDeclaration
-  | ExportNamedDeclaration;
-
-/**
- * Create ESLint RuleListener to check string importation source.
- * @param context ESLint RuleContext
- * @param check the check logic
- * @returns ESLint RuleListener
- */
-export function create(
-  context: Rule.RuleContext,
-  check: (filename: string, source: string, node: ImportationNode) => boolean,
-): Rule.RuleListener {
-  const handle = (node: ImportationNode) => {
-    if (!node.source) return;
-    if (!("value" in node.source)) return;
-    if (typeof node.source.value !== "string") return;
-    if (check(context.filename, node.source.value, node))
-      context.report({ node: node.source, messageId: DEFAULT_MESSAGE_ID });
-  };
-  return {
-    ImportDeclaration: handle,
-    ImportExpression: handle,
-    ExportAllDeclaration: handle,
-    ExportNamedDeclaration: handle,
-  };
-}
-
-export function getSourceType(source: string) {
-  if (
-    source.startsWith("/") ||
-    source.startsWith("./") ||
-    source.startsWith("../") ||
-    source === "." ||
-    source === ".."
-  ) {
-    return "local";
-  }
-  if (source.startsWith("node:")) {
-    return "builtin";
-  }
-  return "module";
-}

package/src/index.ts

@@ -1,31 +0,0 @@
-import { existingFileImports } from "./rules/existing-file-imports.ts";
-import { noDeclarationFileImports } from "./rules/no-declaration-file-imports.ts";
-import { noDirectoryImports } from "./rules/no-directory-imports.ts";
-import { noDynamicImports } from "./rules/no-dynamic-imports.ts";
-import { noEmptyExports } from "./rules/no-empty-exports.ts";
-import { noGitIgnoredImports } from "./rules/no-git-ignored-imports.ts";
-import { noPhantomDepImports } from "./rules/no-phantom-dep-imports.ts";
-import { noRelativeParentImports } from "./rules/no-relative-parent-imports.ts";
-import { noRenameExports } from "./rules/no-rename-exports.ts";
-import { noRenameImports } from "./rules/no-rename-imports.ts";
-import { noSideEffectImports } from "./rules/no-side-effect-imports.ts";
-import { noUselessPathSegments } from "./rules/no-useless-path-segments.ts";
-import { requiredExports } from "./rules/required-exports.ts";
-import { topSideEffectImports } from "./rules/top-side-effect-imports.ts";
-
-export const rules = {
-  [existingFileImports.name]: existingFileImports.rule,
-  [noDeclarationFileImports.name]: noDeclarationFileImports.rule,
-  [noDirectoryImports.name]: noDirectoryImports.rule,
-  [noDynamicImports.name]: noDynamicImports.rule,
-  [noEmptyExports.name]: noEmptyExports.rule,
-  [noGitIgnoredImports.name]: noGitIgnoredImports.rule,
-  [noPhantomDepImports.name]: noPhantomDepImports.rule,
-  [noRelativeParentImports.name]: noRelativeParentImports.rule,
-  [noRenameExports.name]: noRenameExports.rule,
-  [noRenameImports.name]: noRenameImports.rule,
-  [noSideEffectImports.name]: noSideEffectImports.rule,
-  [noUselessPathSegments.name]: noUselessPathSegments.rule,
-  [requiredExports.name]: requiredExports.rule,
-  [topSideEffectImports.name]: topSideEffectImports.rule,
-};

package/src/rules/existing-file-imports.test.ts

@@ -1,28 +0,0 @@
-import { fileURLToPath } from "node:url";
-import { test } from "@fenge/dev-utils";
-import { existingFileImports } from "./existing-file-imports.ts";
-
-const filename = fileURLToPath(import.meta.url);
-
-const valid = [
-  "import foo from 'foo'",
-
-  // with ext
-  "import foo from './existing-file-imports.test.ts'",
-].map((code) => ({ code, filename }));
-
-const invalid = [
-  "import foo from './existing-file-imports.test.js'",
-  // without ext
-  "import foo from './existing-file-imports.test'",
-  "import foo from './inexistent-file'",
-  "import foo from '../inexistent-file'",
-  // directory
-  "import foo from '../rules'",
-  "import foo from '.'",
-  "import foo from './'",
-  "import foo from '..'",
-  "import foo from '../'",
-].map((code) => ({ code, filename }));
-
-test({ valid, invalid, ...existingFileImports });

package/src/rules/existing-file-imports.ts

@@ -1,25 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import { create, createRule, getRuleName, getSourceType } from "../common.ts";
-import { memoize } from "../utils.ts";
-
-export const existingFileImports = createRule({
-  name: getRuleName(import.meta.url),
-  message: "Only allow importing from an existing local file.",
-  create: (context) => create(context, check),
-});
-
-function check(filename: string, source: string) {
-  return getSourceType(source) === "local"
-    ? !isExisting(path.resolve(path.dirname(filename), source))
-    : false;
-}
-
-const isExisting = memoize((filepath: string): boolean => {
-  try {
-    const stat = fs.statSync(filepath);
-    return stat.isFile();
-  } catch {
-    return false;
-  }
-});

package/src/rules/no-declaration-file-imports.test.ts

@@ -1,33 +0,0 @@
-import { test } from "@fenge/dev-utils";
-import { noDeclarationFileImports } from "./no-declaration-file-imports.ts";
-
-const invalid = [
-  "import foo from 'foo.d.bar'",
-  "import foo from './foo.d.bar'",
-  "import foo from './foo/foo.d.bar'",
-
-  "import foo from './foo.d.ts'",
-  "import foo from './foo.d.cts'",
-  "import foo from './foo.d.mts'",
-  "import foo from './foo.d.tsx'",
-
-  "import foo from './foo.d.js'",
-  "import foo from './foo.d.cjs'",
-  "import foo from './foo.d.mjs'",
-  "import foo from './foo.d.jsx'",
-
-  "import foo from '/foo.d.js'",
-];
-
-const valid = [
-  "import foo from 'foo'",
-
-  "import foo from './foo.ts'",
-  "import foo from './foo.cts'",
-  "import foo from './foo.mts'",
-  "import foo from './foo.tsx'",
-
-  "import foo from '/foo.ts'",
-];
-
-test({ valid, invalid, ...noDeclarationFileImports });

package/src/rules/no-declaration-file-imports.ts

@@ -1,12 +0,0 @@
-import { create, createRule, getRuleName } from "../common.ts";
-
-export const noDeclarationFileImports = createRule({
-  name: getRuleName(import.meta.url),
-  message: "Disallow importing from a declaration style file.",
-  create: (context) => create(context, check),
-});
-
-function check(_filename: string, source: string) {
-  const file = source.split("/").at(-1);
-  return !file || file.includes(".d.");
-}

package/src/rules/no-directory-imports.test.ts

@@ -1,31 +0,0 @@
-import process from "node:process";
-import { fileURLToPath } from "node:url";
-import { test } from "@fenge/dev-utils";
-import { noDirectoryImports } from "./no-directory-imports.ts";
-
-const valid = [
-  "import foo from 'foo'",
-  "import foo from './foo'",
-  `import foo from '${process.cwd()}/index.js'`,
-  `import foo from '${process.cwd()}/index.ts'`,
-  `import foo from '${process.cwd()}/package.json'`,
-].map((code) => ({
-  code,
-  filename: fileURLToPath(import.meta.url),
-}));
-
-const invalid = [
-  "import foo from '.'",
-  "import foo from './'",
-  "import foo from '..'",
-  "import foo from '../'",
-  "import foo from '../rules'",
-  "import foo from '../rules/'",
-  "import foo from '../../src'",
-  `import foo from '${process.cwd()}'`,
-].map((code) => ({
-  code,
-  filename: fileURLToPath(import.meta.url),
-}));
-
-test({ valid, invalid, ...noDirectoryImports });

package/src/rules/no-directory-imports.ts

@@ -1,34 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import { create, createRule, getRuleName, getSourceType } from "../common.ts";
-import { memoize } from "../utils.ts";
-
-export const noDirectoryImports = createRule({
-  name: getRuleName(import.meta.url),
-  message: "Disallow importing from a directory.",
-  create: (context) => create(context, check),
-});
-
-function check(filename: string, source: string) {
-  if (getSourceType(source) !== "local") {
-    return false;
-  }
-  if (source.endsWith(".") || source.endsWith("./")) {
-    return true;
-  }
-  const absolutePath = path.resolve(path.dirname(filename), source);
-  if (!absolutePath.startsWith("/")) {
-    throw new Error(
-      `ESLint plugin internal error. Absolute path incorrect: ${absolutePath}.`,
-    );
-  }
-  return isDir(absolutePath);
-}
-
-const isDir = memoize((filePath: string) => {
-  try {
-    return fs.statSync(filePath).isDirectory();
-  } catch {
-    return false;
-  }
-});