@dxos/eslint-plugin-rules 0.8.4-main.84f28bd → 0.8.4-main.8baae0fced

package/rules/effect-subpath-imports.js

@@ -0,0 +1,317 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { createRequire } from 'node:module';
+
+const EXCLUDED_EFFECT_PACKAGES = ['@effect/vitest'];
+
+/**
+ * Map of Effect base-package exports that come from a subpath (not a direct segment).
+ * Used when resolving imports like `import { pipe } from 'effect'` → effect/Function.
+ */
+const EFFECT_EXPORT_TO_SUBPATH = {
+  pipe: 'Function',
+  flow: 'Function',
+};
+
+/**
+ * Subpaths that allow named imports (e.g. `import { pipe, flow } from 'effect/Function'`).
+ * Other subpaths still require namespace imports.
+ */
+const NAMED_IMPORT_ALLOWED_SUBPATHS = new Set(['Function']);
+
+/**
+ * ESLint rule to transform combined imports from 'effect' and '@effect/*'
+ * into subpath imports except for the EXCLUDED_EFFECT_PACKAGES.
+ * @example
+ * // before
+ * import { type Schema, SchemaAST } from 'effect';
+ *
+ * // after
+ * import type * as Schema from 'effect/Schema'
+ * import * as SchemaAST from 'effect/SchemaAST'
+ */
+export default {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'enforce subpath imports for Effect packages',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  create: (context) => {
+    // Resolver and caches are scoped to this lint run.
+    const requireForFile = createRequire(context.getFilename());
+    const exportsCache = new Map(); // packageName -> Set<segment>
+
+    const loadExportsForPackage = (pkgName) => {
+      if (exportsCache.has(pkgName)) {
+        return exportsCache.get(pkgName);
+      }
+      try {
+        const pkgJson = requireForFile(`${pkgName}/package.json`);
+        const ex = pkgJson && pkgJson.exports;
+        const segments = new Set();
+        if (ex && typeof ex === 'object') {
+          for (const key of Object.keys(ex)) {
+            // Keys like './Schema', './SchemaAST', './Function' (skip '.' and './package.json').
+            if (key === '.' || key === './package.json') {
+              continue;
+            }
+            if (key.startsWith('./')) {
+              segments.add(key.slice(2));
+            }
+          }
+        }
+        exportsCache.set(pkgName, segments);
+        return segments;
+      } catch {
+        const empty = new Set();
+        exportsCache.set(pkgName, empty);
+        return empty;
+      }
+    };
+
+    const isValidSubpath = (pkgName, segment) => {
+      const exported = loadExportsForPackage(pkgName);
+      return exported.has(segment);
+    };
+
+    const resolveExportToSegment = (pkgName, exportName) => {
+      if (isValidSubpath(pkgName, exportName)) {
+        return exportName;
+      }
+      if (pkgName === 'effect' && EFFECT_EXPORT_TO_SUBPATH[exportName]) {
+        const segment = EFFECT_EXPORT_TO_SUBPATH[exportName];
+        return isValidSubpath(pkgName, segment) ? segment : null;
+      }
+      return null;
+    };
+
+    const isEffectPackage = (source) => {
+      return source === 'effect' || source.startsWith('effect/') || source.startsWith('@effect/');
+    };
+
+    const shouldSkipEffectPackage = (basePackage) => {
+      return EXCLUDED_EFFECT_PACKAGES.includes(basePackage);
+    };
+
+    /**
+     * Get the base package name from a source string.
+     * @param {string} source - The source string to get the base package name from.
+     * @returns {string} The base package name.
+     * @example
+     * getBasePackage('effect/Schema') // 'effect'
+     * getBasePackage('@effect/ai/openai') // '@effect/ai'
+     */
+    const getBasePackage = (source) => {
+      if (source.startsWith('@')) {
+        const parts = source.split('/');
+        return parts.length >= 2 ? `${parts[0]}/${parts[1]}` : source;
+      } else {
+        return source.split('/')[0];
+      }
+    };
+
+    return {
+      ImportDeclaration: (node) => {
+        const source = String(node.source.value);
+        if (!isEffectPackage(source)) {
+          return;
+        }
+        const basePackage = getBasePackage(source);
+        if (shouldSkipEffectPackage(basePackage)) {
+          return;
+        }
+
+        // If it's a subpath import (e.g., 'effect/Schema'), enforce namespace import except for allowed subpaths.
+        if (source.startsWith(basePackage + '/')) {
+          const segment = source.slice(basePackage.length + 1);
+          const allowsNamed = NAMED_IMPORT_ALLOWED_SUBPATHS.has(segment);
+          const isNamespaceOnly =
+            node.specifiers.length === 1 && node.specifiers[0].type === 'ImportNamespaceSpecifier';
+          if (!allowsNamed && !isNamespaceOnly) {
+            context.report({
+              node,
+              message: 'Use namespace import for Effect subpaths',
+            });
+          }
+          return;
+        }
+
+        // From here on, we only handle root package imports like 'effect'.
+        const packageName = basePackage;
+
+        // Only process imports with specifiers.
+        if (!node.specifiers || node.specifiers.length === 0) {
+          return;
+        }
+
+        // Only process named imports.
+        const hasNamedImports = node.specifiers.some((spec) => spec.type === 'ImportSpecifier');
+
+        if (!hasNamedImports) {
+          return;
+        }
+
+        // Group specifiers by type.
+        const typeImports = [];
+        const regularImports = [];
+        for (const specifier of node.specifiers) {
+          if (specifier.type !== 'ImportSpecifier') {
+            continue;
+          }
+          const entry = { imported: specifier.imported.name, local: specifier.local.name };
+          if (specifier.importKind === 'type') {
+            typeImports.push(entry);
+          } else {
+            regularImports.push(entry);
+          }
+        }
+
+        // Partition into resolvable vs unresolved specifiers (resolved entries include segment for fix).
+        const resolvedType = [];
+        const unresolvedType = [];
+        const resolvedRegular = [];
+        const unresolvedRegular = [];
+
+        typeImports.forEach((spec) => {
+          const segment = resolveExportToSegment(packageName, spec.imported);
+          if (segment) {
+            resolvedType.push({ ...spec, segment });
+          } else {
+            unresolvedType.push(spec);
+          }
+        });
+        regularImports.forEach((spec) => {
+          const segment = resolveExportToSegment(packageName, spec.imported);
+          if (segment) {
+            resolvedRegular.push({ ...spec, segment });
+          } else {
+            unresolvedRegular.push(spec);
+          }
+        });
+
+        const unresolved = [...unresolvedType, ...unresolvedRegular].map(({ imported }) => imported);
+
+        // Report and autofix: fix resolvable ones; keep unresolved in a remaining combined import.
+        context.report({
+          node,
+          message:
+            unresolved.length > 0
+              ? `Use subpath imports for Effect packages; unresolved kept in base import: ${unresolved.join(', ')}`
+              : 'Use subpath imports for Effect packages',
+          fix: (fixer) => {
+            const sourceCode = context.getSourceCode();
+            const imports = [];
+
+            // Idempotency guard: if nothing is resolvable, do not rewrite.
+            if (resolvedType.length === 0 && resolvedRegular.length === 0) {
+              return null;
+            }
+
+            // Group resolved imports by segment.
+            const bySegment = new Map(); // segment -> { regular: [...], type: [...] }
+            resolvedRegular.forEach((entry) => {
+              const seg = entry.segment;
+              let group = bySegment.get(seg);
+              if (!group) {
+                group = { regular: [], type: [] };
+                bySegment.set(seg, group);
+              }
+              group.regular.push(entry);
+            });
+            resolvedType.forEach((entry) => {
+              const seg = entry.segment;
+              let group = bySegment.get(seg);
+              if (!group) {
+                group = { regular: [], type: [] };
+                bySegment.set(seg, group);
+              }
+              group.type.push(entry);
+            });
+
+            for (const [segment, group] of bySegment) {
+              const useNamed = NAMED_IMPORT_ALLOWED_SUBPATHS.has(segment);
+              const merged = [...group.regular];
+              for (const t of group.type) {
+                if (!group.regular.some((r) => r.local === t.local)) {
+                  merged.push(t);
+                }
+              }
+              if (useNamed && merged.length > 0) {
+                const specParts = merged.map(({ imported, local }) =>
+                  imported !== local ? `${imported} as ${local}` : imported,
+                );
+                imports.push(`import { ${specParts.join(', ')} } from '${packageName}/${segment}';`);
+              } else {
+                const seen = new Set();
+                for (const { imported, local } of merged) {
+                  const alias = imported !== local ? local : imported;
+                  if (seen.has(alias)) {
+                    continue;
+                  }
+                  seen.add(alias);
+                  const isTypeOnly =
+                    group.type.some((t) => t.imported === imported) &&
+                    !group.regular.some((r) => r.imported === imported);
+                  const importStr = isTypeOnly
+                    ? `import type * as ${alias} from '${packageName}/${segment}';`
+                    : `import * as ${alias} from '${packageName}/${segment}';`;
+                  imports.push(importStr);
+                }
+              }
+            }
+
+            // If there are unresolved, keep them in a single base import.
+            if (unresolvedType.length || unresolvedRegular.length) {
+              // Prefer value over type for the same local alias when both are present.
+              const byLocal = new Map(); // local -> { value?: {imported,local}, type?: {imported,local} }
+              unresolvedRegular.forEach((s) => {
+                const entry = byLocal.get(s.local) ?? {};
+                entry.value = s;
+                byLocal.set(s.local, entry);
+              });
+              unresolvedType.forEach((s) => {
+                const entry = byLocal.get(s.local) ?? {};
+                if (!entry.value) {
+                  entry.type = s;
+                } // only keep type if no value for same local
+                byLocal.set(s.local, entry);
+              });
+
+              const specParts = [];
+              for (const entry of byLocal.values()) {
+                if (entry.value) {
+                  const { imported, local } = entry.value;
+                  const part = imported !== local ? `${imported} as ${local}` : `${imported}`;
+                  specParts.push(part);
+                } else if (entry.type) {
+                  const { imported, local } = entry.type;
+                  const part = imported !== local ? `type ${imported} as ${local}` : `type ${imported}`;
+                  specParts.push(part);
+                }
+              }
+              if (specParts.length) {
+                imports.push(`import { ${specParts.join(', ')} } from '${packageName}';`);
+              }
+            }
+
+            // Get the original import's indentation.
+            const importIndent = sourceCode.text.slice(node.range[0] - node.loc.start.column, node.range[0]);
+
+            // Join imports with newline and proper indentation.
+            if (imports.length === 0) {
+              return null;
+            } // nothing to change
+            const newImports = imports.join('\n' + importIndent);
+
+            return fixer.replaceText(node, newImports);
+          },
+        });
+      },
+    };
+  },
+};

package/rules/header.js

@@ -5,7 +5,7 @@
 const REGEX = /Copyright [0-9]+ DXOS.org/;
 const TEMPLATE = ['//', `// Copyright ${new Date().getFullYear()} DXOS.org`, '//', ''].join('\n') + '\n';
 
-module.exports = {
+export default {
   pattern: REGEX,
   meta: {
     type: 'layout',
@@ -19,7 +19,7 @@ module.exports = {
   create: (context) => {
     return {
       Program: (node) => {
-        if (!context.getSource().match(REGEX)) {
+        if (!context.sourceCode.getText().match(REGEX)) {
           context.report({
             node,
             message: 'Missing copyright header',

package/rules/import-as-namespace.js

@@ -0,0 +1,271 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import fs from 'node:fs';
+import path from 'node:path';
+
+const DIRECTIVE_TEXT = '@import-as-namespace';
+const DIRECTIVE_LINE_REGEX = /^\s*\/\/\s*@import-as-namespace\s*$/m;
+const PASCAL_CASE_REGEX = /^[A-Z][a-zA-Z0-9]*$/;
+const TS_EXTENSIONS = ['.ts', '.tsx', '.js', '.jsx'];
+
+/**
+ * ESLint rule to enforce namespace imports for modules annotated with `// @import-as-namespace`.
+ *
+ * When a module contains the `// @import-as-namespace` directive comment, this rule enforces:
+ * - The module filename is PascalCase (e.g. `LanguageModel.ts`).
+ * - All imports of the module use namespace form: `import * as LanguageModel from './LanguageModel'`.
+ * - The namespace name matches the filename (without extension), or has a `Module` suffix.
+ * - Re-exports use namespace form: `export * as LanguageModel from './LanguageModel'`.
+ *
+ * The `Module` suffix is allowed as an escape hatch when the expected namespace name conflicts
+ * with a local declaration in the importing file (e.g., `import * as ObjModule from './Obj'`
+ * when the file also exports its own `Obj` interface).
+ *
+ * @example
+ * // In LanguageModel.ts:
+ * // @import-as-namespace
+ * export const foo = 1;
+ *
+ * // ❌ Bad (in another file):
+ * import { foo } from './LanguageModel';
+ * export { foo } from './LanguageModel';
+ * export * from './LanguageModel';
+ *
+ * // ✅ Good:
+ * import * as LanguageModel from './LanguageModel';
+ * import * as LanguageModelModule from './LanguageModel';  // Also allowed when needed
+ * export * as LanguageModel from './LanguageModel';
+ */
+export default {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'enforce namespace imports for modules marked with @import-as-namespace',
+    },
+    fixable: 'code',
+    schema: [],
+    messages: {
+      filenameMustBePascalCase:
+        'Module marked with @import-as-namespace must have a PascalCase filename. Got: "{{filename}}".',
+      mustUseNamespaceImport:
+        'Module "{{source}}" is marked @import-as-namespace. Use: `import * as {{namespace}} from \'{{source}}\'`.',
+      namespaceMustMatchFilename: 'Namespace import name "{{actual}}" must match filename "{{expected}}".',
+      mustUseNamespaceReexport:
+        'Module "{{source}}" is marked @import-as-namespace. Use: `export * as {{namespace}} from \'{{source}}\'`.',
+    },
+  },
+  create: (context) => {
+    const directiveCache = new Map();
+
+    const fileHasDirective = (filePath) => {
+      if (directiveCache.has(filePath)) {
+        return directiveCache.get(filePath);
+      }
+      try {
+        const content = fs.readFileSync(filePath, 'utf8');
+        const result = DIRECTIVE_LINE_REGEX.test(content);
+        directiveCache.set(filePath, result);
+        return result;
+      } catch {
+        directiveCache.set(filePath, false);
+        return false;
+      }
+    };
+
+    const resolveRelativeImport = (source, currentFile) => {
+      if (!source.startsWith('.')) {
+        return null;
+      }
+      const dir = path.dirname(currentFile);
+      const resolved = path.resolve(dir, source);
+      for (const ext of TS_EXTENSIONS) {
+        const filePath = resolved + ext;
+        if (fs.existsSync(filePath)) {
+          return filePath;
+        }
+      }
+      for (const ext of TS_EXTENSIONS) {
+        const filePath = path.join(resolved, 'index' + ext);
+        if (fs.existsSync(filePath)) {
+          return filePath;
+        }
+      }
+      return null;
+    };
+
+    const namespaceFromSource = (source) => {
+      const parts = source.split('/');
+      const last = parts[parts.length - 1];
+      return last.replace(/\.\w+$/, '');
+    };
+
+    const buildImportFix = (fixer, node, source, expectedNamespace, context) => {
+      const fixes = [];
+      const importKeyword = node.importKind === 'type' ? 'import type' : 'import';
+      fixes.push(fixer.replaceText(node, `${importKeyword} * as ${expectedNamespace} from '${source}';`));
+
+      try {
+        const declaredVars = context.sourceCode.getDeclaredVariables(node);
+        for (const variable of declaredVars) {
+          for (const ref of variable.references) {
+            if (ref.identifier.range[0] >= node.range[0] && ref.identifier.range[1] <= node.range[1]) {
+              continue;
+            }
+            fixes.push(fixer.replaceText(ref.identifier, `${expectedNamespace}.${variable.name}`));
+          }
+        }
+      } catch {
+        // Scope analysis unavailable; fix import declaration only.
+      }
+
+      return fixes;
+    };
+
+    return {
+      Program: (node) => {
+        const comments = context.sourceCode.getAllComments();
+        const hasDirective = comments.some(
+          (comment) => comment.type === 'Line' && comment.value.trim() === DIRECTIVE_TEXT,
+        );
+        if (!hasDirective) {
+          return;
+        }
+        const filename = path.basename(context.getFilename());
+        const stem = filename.replace(/\.\w+$/, '');
+        if (!PASCAL_CASE_REGEX.test(stem)) {
+          context.report({
+            node,
+            messageId: 'filenameMustBePascalCase',
+            data: { filename },
+          });
+        }
+      },
+
+      ImportDeclaration: (node) => {
+        const source = String(node.source.value);
+        if (!source.startsWith('.')) {
+          return;
+        }
+        if (!node.specifiers || node.specifiers.length === 0) {
+          return;
+        }
+
+        const currentFile = context.getFilename();
+        const resolved = resolveRelativeImport(source, currentFile);
+        if (!resolved) {
+          return;
+        }
+        if (!fileHasDirective(resolved)) {
+          return;
+        }
+
+        const expectedNamespace = namespaceFromSource(source);
+
+        const isNamespaceImport =
+          node.specifiers.length === 1 && node.specifiers[0].type === 'ImportNamespaceSpecifier';
+
+        if (!isNamespaceImport) {
+          context.report({
+            node,
+            messageId: 'mustUseNamespaceImport',
+            data: { source, namespace: expectedNamespace },
+            fix: (fixer) => buildImportFix(fixer, node, source, expectedNamespace, context),
+          });
+          return;
+        }
+
+        const actual = node.specifiers[0].local.name;
+        const allowedNames = [expectedNamespace, expectedNamespace + 'Module'];
+        if (!allowedNames.includes(actual)) {
+          context.report({
+            node,
+            messageId: 'namespaceMustMatchFilename',
+            data: { actual, expected: expectedNamespace },
+            fix: (fixer) => {
+              const importKeyword = node.importKind === 'type' ? 'import type' : 'import';
+              return fixer.replaceText(node, `${importKeyword} * as ${expectedNamespace} from '${source}';`);
+            },
+          });
+        }
+      },
+
+      ExportNamedDeclaration: (node) => {
+        if (!node.source) {
+          return;
+        }
+        const source = String(node.source.value);
+        if (!source.startsWith('.')) {
+          return;
+        }
+
+        const currentFile = context.getFilename();
+        const resolved = resolveRelativeImport(source, currentFile);
+        if (!resolved) {
+          return;
+        }
+        if (!fileHasDirective(resolved)) {
+          return;
+        }
+
+        const expectedNamespace = namespaceFromSource(source);
+        const exportKeyword = node.exportKind === 'type' ? 'export type' : 'export';
+        context.report({
+          node,
+          messageId: 'mustUseNamespaceReexport',
+          data: { source, namespace: expectedNamespace },
+          fix: (fixer) => {
+            return fixer.replaceText(node, `${exportKeyword} * as ${expectedNamespace} from '${source}';`);
+          },
+        });
+      },
+
+      ExportAllDeclaration: (node) => {
+        if (!node.source) {
+          return;
+        }
+        const source = String(node.source.value);
+        if (!source.startsWith('.')) {
+          return;
+        }
+
+        const currentFile = context.getFilename();
+        const resolved = resolveRelativeImport(source, currentFile);
+        if (!resolved) {
+          return;
+        }
+        if (!fileHasDirective(resolved)) {
+          return;
+        }
+
+        const expectedNamespace = namespaceFromSource(source);
+
+        if (node.exported) {
+          const actual = node.exported.name;
+          const allowedNames = [expectedNamespace, expectedNamespace + 'Module'];
+          if (!allowedNames.includes(actual)) {
+            context.report({
+              node,
+              messageId: 'namespaceMustMatchFilename',
+              data: { actual, expected: expectedNamespace },
+              fix: (fixer) => {
+                return fixer.replaceText(node, `export * as ${expectedNamespace} from '${source}';`);
+              },
+            });
+          }
+          return;
+        }
+
+        context.report({
+          node,
+          messageId: 'mustUseNamespaceReexport',
+          data: { source, namespace: expectedNamespace },
+          fix: (fixer) => {
+            return fixer.replaceText(node, `export * as ${expectedNamespace} from '${source}';`);
+          },
+        });
+      },
+    };
+  },
+};

package/rules/no-bare-dot-imports.js

@@ -0,0 +1,55 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+/**
+ * ESLint rule to prevent bare "." or ".." imports.
+ * These imports are ambiguous as they don't explicitly show which file is being imported.
+ *
+ * @example
+ * // ❌ Bad
+ * import { foo } from '.';
+ * import { bar } from '..';
+ *
+ * // ✅ Good
+ * import { foo } from './index';
+ * import { bar } from '../index';
+ */
+export default {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'disallow bare "." or ".." in import paths',
+      category: 'Best Practices',
+      recommended: true,
+    },
+    fixable: 'code',
+    schema: [],
+    messages: {
+      bareDotImport: 'Use explicit path instead of bare "{{source}}". Consider "{{suggestion}}" instead.',
+    },
+  },
+  create: (context) => {
+    return {
+      ImportDeclaration: (node) => {
+        const source = node.source.value;
+
+        // Check if the import is exactly "." or ".."
+        if (source === '.' || source === '..') {
+          context.report({
+            node: node.source,
+            messageId: 'bareDotImport',
+            data: {
+              source,
+              suggestion: source === '.' ? './index' : '../index',
+            },
+            fix: (fixer) => {
+              const newSource = source === '.' ? './index' : '../index';
+              return fixer.replaceText(node.source, `'${newSource}'`);
+            },
+          });
+        }
+      },
+    };
+  },
+};