@knighted/module 1.0.0-alpha.9 → 1.0.0-beta.1

package/dist/cjs/utils/identifiers.cjs

@@ -0,0 +1,190 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.collectScopeIdentifiers = exports.collectModuleIdentifiers = void 0;
+var _walk = require("#walk");
+var _scope = require("#helpers/scope.js");
+var _identifier = require("#helpers/identifier.js");
+const collectScopeIdentifiers = (node, scopes) => {
+  const {
+    type
+  } = node;
+  switch (type) {
+    case 'BlockStatement':
+    case 'ClassBody':
+      scopes.push({
+        node,
+        type: 'Block',
+        name: type,
+        idents: new Set()
+      });
+      break;
+    case 'FunctionDeclaration':
+    case 'FunctionExpression':
+    case 'ArrowFunctionExpression':
+      {
+        const name = node.id ? node.id.name : 'anonymous';
+        const scope = {
+          node,
+          name,
+          type: 'Function',
+          idents: new Set()
+        };
+        node.params.map(param => {
+          if (param.type === 'TSParameterProperty') {
+            return param.parameter;
+          }
+          if (param.type === 'RestElement') {
+            return param.argument;
+          }
+          if (param.type === 'AssignmentPattern') {
+            return param.left;
+          }
+          return param;
+        }).filter(_identifier.identifier.isNamed).forEach(param => {
+          scope.idents.add(param.name);
+        });
+
+        /**
+         * If a FunctionExpression has an id, it is a named function expression.
+         * The function expression name shadows the module scope identifier, so
+         * we don't want to count reads of module identifers that have the same name.
+         * They also do not cause a SyntaxError if the function expression name is
+         * the same as a module scope identifier.
+         *
+         * TODO: Is this necessary for FunctionDeclaration?
+         */
+        if (node.type === 'FunctionExpression' && node.id) {
+          scope.idents.add(node.id.name);
+        }
+
+        // First add the function to any previous scopes
+        if (scopes.length > 0) {
+          scopes[scopes.length - 1].idents.add(name);
+        }
+
+        // Then add the function scope to the scopes stack
+        scopes.push(scope);
+      }
+      break;
+    case 'ClassDeclaration':
+      {
+        const className = node.id ? node.id.name : 'anonymous';
+
+        // First add the class to any previous scopes
+        if (scopes.length > 0) {
+          scopes[scopes.length - 1].idents.add(className);
+        }
+
+        // Then add the class to the scopes stack
+        scopes.push({
+          node,
+          name: className,
+          type: 'Class',
+          idents: new Set()
+        });
+      }
+      break;
+    case 'ClassExpression':
+      {}
+      break;
+    case 'VariableDeclaration':
+      if (scopes.length > 0) {
+        const scope = scopes[scopes.length - 1];
+        node.declarations.forEach(decl => {
+          if (decl.type === 'VariableDeclarator' && decl.id.type === 'Identifier') {
+            scope.idents.add(decl.id.name);
+          }
+        });
+      }
+      break;
+  }
+};
+
+/**
+ * Collects all module scope identifiers in the AST.
+ *
+ * Ignores identifiers that are in functions or classes.
+ * Ignores new scopes for StaticBlock nodes (can only reference static class members).
+ *
+ * Special case handling for these which create their own scopes,
+ * but are also valid module scope identifiers:
+ * - ClassDeclaration
+ * - FunctionDeclaration
+ *
+ * Special case handling for var inside BlockStatement
+ * which are also valid module scope identifiers.
+ */
+exports.collectScopeIdentifiers = collectScopeIdentifiers;
+const collectModuleIdentifiers = async (ast, hoisting = true) => {
+  const identifiers = new Map();
+  const globalReads = new Map();
+  const scopes = [];
+  await (0, _walk.ancestorWalk)(ast, {
+    enter(node, ancestors) {
+      const {
+        type
+      } = node;
+      collectScopeIdentifiers(node, scopes);
+
+      // Add module scope identifiers to the registry map
+
+      if (type === 'Identifier') {
+        const {
+          name
+        } = node;
+        const meta = identifiers.get(name) ?? {
+          declare: [],
+          read: []
+        };
+        const isDeclaration = _identifier.identifier.isDeclaration(ancestors);
+        const inScope = scopes.some(scope => scope.idents.has(name) || scope.name === name);
+        if (hoisting && !_identifier.identifier.isDeclaration(ancestors) && !_identifier.identifier.isFunctionExpressionId(ancestors) && !_identifier.identifier.isExportSpecifierAlias(ancestors) && !_identifier.identifier.isClassPropertyKey(ancestors) && !_identifier.identifier.isMethodDefinitionKey(ancestors) && !_identifier.identifier.isMemberKey(ancestors) && !_identifier.identifier.isPropertyKey(ancestors) && !_identifier.identifier.isIife(ancestors) && !inScope) {
+          if (globalReads.has(name)) {
+            globalReads.get(name)?.push(node);
+          } else {
+            globalReads.set(name, [node]);
+          }
+        }
+        if (isDeclaration) {
+          const isModuleScope = _identifier.identifier.isModuleScope(ancestors);
+          const isClassOrFuncDeclaration = _identifier.identifier.isClassOrFuncDeclarationId(ancestors);
+          const isVarDeclarationInGlobalScope = _identifier.identifier.isVarDeclarationInGlobalScope(ancestors);
+          if (isModuleScope || isClassOrFuncDeclaration || isVarDeclarationInGlobalScope) {
+            meta.declare.push(node);
+
+            // Check for hoisted reads
+            if (hoisting && globalReads.has(name)) {
+              const reads = globalReads.get(name);
+              if (reads) {
+                reads.forEach(read => {
+                  if (!meta.read.includes(read)) {
+                    meta.read.push(read);
+                  }
+                });
+              }
+            }
+            identifiers.set(name, meta);
+          }
+        } else {
+          if (identifiers.has(name) && !inScope && !_identifier.identifier.isIife(ancestors) && !_identifier.identifier.isFunctionExpressionId(ancestors) && !_identifier.identifier.isExportSpecifierAlias(ancestors) && !_identifier.identifier.isClassPropertyKey(ancestors) && !_identifier.identifier.isMethodDefinitionKey(ancestors) && !_identifier.identifier.isMemberKey(ancestors) && !_identifier.identifier.isPropertyKey(ancestors)) {
+            // Closure is referencing module scope identifier
+            meta.read.push(node);
+          }
+        }
+      }
+    },
+    leave(node) {
+      const {
+        type
+      } = node;
+      if (_scope.scopes.includes(type)) {
+        scopes.pop();
+      }
+    }
+  });
+  return identifiers;
+};
+exports.collectModuleIdentifiers = collectModuleIdentifiers;

package/dist/cjs/utils/lang.cjs

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getLangFromExt = void 0;
+var _nodePath = require("node:path");
+// Determine language from filename extension for specifier rewrite.
+
+const getLangFromExt = filename => {
+  const ext = (0, _nodePath.extname)(filename);
+  if (ext.endsWith('.js')) {
+    return 'js';
+  }
+  if (ext.endsWith('.ts')) {
+    return 'ts';
+  }
+  if (ext === '.tsx') {
+    return 'tsx';
+  }
+  if (ext === '.jsx') {
+    return 'jsx';
+  }
+};
+exports.getLangFromExt = getLangFromExt;

package/dist/cjs/utils/url.cjs

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isValidUrl = void 0;
+// URL validation used when rewriting import.meta.url assignments.
+const isValidUrl = url => {
+  try {
+    new URL(url);
+    return true;
+  } catch {
+    return false;
+  }
+};
+exports.isValidUrl = isValidUrl;

package/dist/cjs/utils.cjs

@@ -0,0 +1,288 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.requireMainRgx = exports.isValidUrl = exports.getLangFromExt = exports.exportsRename = exports.collectScopeIdentifiers = exports.collectModuleIdentifiers = exports.collectCjsExports = void 0;
+var _nodePath = require("node:path");
+var _walk = require("./walk.cjs");
+var _scope = require("./helpers/scope.cjs");
+var _identifier = require("./helpers/identifier.cjs");
+const getLangFromExt = filename => {
+  const ext = (0, _nodePath.extname)(filename);
+  if (ext.endsWith('.js')) {
+    return 'js';
+  }
+  if (ext.endsWith('.ts')) {
+    return 'ts';
+  }
+  if (ext === '.tsx') {
+    return 'tsx';
+  }
+  if (ext === '.jsx') {
+    return 'jsx';
+  }
+};
+exports.getLangFromExt = getLangFromExt;
+const isValidUrl = url => {
+  try {
+    new URL(url);
+    return true;
+  } catch {
+    return false;
+  }
+};
+exports.isValidUrl = isValidUrl;
+const exportsRename = exports.exportsRename = '__exports';
+const requireMainRgx = exports.requireMainRgx = /(require\.main\s*===\s*module|module\s*===\s*require\.main)/g;
+const resolveExportTarget = node => {
+  if (node.type !== 'MemberExpression') return null;
+  const base = node.object;
+  const prop = node.property;
+  if (prop.type !== 'Identifier') return null;
+  if (base.type === 'Identifier' && base.name === 'exports') {
+    return {
+      key: prop.name,
+      via: 'exports'
+    };
+  }
+  if (base.type === 'MemberExpression' && base.object.type === 'Identifier' && base.object.name === 'module' && base.property.type === 'Identifier' && base.property.name === 'exports') {
+    return {
+      key: prop.name,
+      via: 'module.exports'
+    };
+  }
+  if (base.type === 'Identifier' && base.name === 'module' && prop.type === 'Identifier' && prop.name === 'exports') {
+    return {
+      key: 'default',
+      via: 'module.exports'
+    };
+  }
+  return null;
+};
+const collectCjsExports = async ast => {
+  const exportsMap = new Map();
+  const localToExport = new Map();
+  await (0, _walk.ancestorWalk)(ast, {
+    enter(node) {
+      if (node.type === 'AssignmentExpression') {
+        const target = resolveExportTarget(node.left);
+        if (target) {
+          const entry = exportsMap.get(target.key) ?? {
+            key: target.key,
+            writes: [],
+            via: new Set(),
+            reassignments: []
+          };
+          entry.via.add(target.via);
+          entry.writes.push(node);
+          if (node.right.type === 'Identifier') {
+            entry.fromIdentifier ??= node.right.name;
+            if (entry.fromIdentifier) {
+              const set = localToExport.get(entry.fromIdentifier) ?? new Set();
+              set.add(target.key);
+              localToExport.set(entry.fromIdentifier, set);
+            }
+          }
+          exportsMap.set(target.key, entry);
+          return;
+        }
+        if (node.left.type === 'Identifier') {
+          const keys = localToExport.get(node.left.name);
+          if (keys) {
+            keys.forEach(key => {
+              const entry = exportsMap.get(key);
+              if (entry) {
+                entry.reassignments.push(node);
+                exportsMap.set(key, entry);
+              }
+            });
+          }
+        }
+      }
+    }
+  });
+  return exportsMap;
+};
+exports.collectCjsExports = collectCjsExports;
+const collectScopeIdentifiers = (node, scopes) => {
+  const {
+    type
+  } = node;
+  switch (type) {
+    case 'BlockStatement':
+    case 'ClassBody':
+      scopes.push({
+        node,
+        type: 'Block',
+        name: type,
+        idents: new Set()
+      });
+      break;
+    case 'FunctionDeclaration':
+    case 'FunctionExpression':
+    case 'ArrowFunctionExpression':
+      {
+        const name = node.id ? node.id.name : 'anonymous';
+        const scope = {
+          node,
+          name,
+          type: 'Function',
+          idents: new Set()
+        };
+        node.params.map(param => {
+          if (param.type === 'TSParameterProperty') {
+            return param.parameter;
+          }
+          if (param.type === 'RestElement') {
+            return param.argument;
+          }
+          if (param.type === 'AssignmentPattern') {
+            return param.left;
+          }
+          return param;
+        }).filter(_identifier.identifier.isNamed).forEach(param => {
+          scope.idents.add(param.name);
+        });
+
+        /**
+         * If a FunctionExpression has an id, it is a named function expression.
+         * The function expression name shadows the module scope identifier, so
+         * we don't want to count reads of module identifers that have the same name.
+         * They also do not cause a SyntaxError if the function expression name is
+         * the same as a module scope identifier.
+         *
+         * TODO: Is this necessary for FunctionDeclaration?
+         */
+        if (node.type === 'FunctionExpression' && node.id) {
+          scope.idents.add(node.id.name);
+        }
+
+        // First add the function to any previous scopes
+        if (scopes.length > 0) {
+          scopes[scopes.length - 1].idents.add(name);
+        }
+
+        // Then add the function scope to the scopes stack
+        scopes.push(scope);
+      }
+      break;
+    case 'ClassDeclaration':
+      {
+        const className = node.id ? node.id.name : 'anonymous';
+
+        // First add the class to any previous scopes
+        if (scopes.length > 0) {
+          scopes[scopes.length - 1].idents.add(className);
+        }
+
+        // Then add the class to the scopes stack
+        scopes.push({
+          node,
+          name: className,
+          type: 'Class',
+          idents: new Set()
+        });
+      }
+      break;
+    case 'ClassExpression':
+      {}
+      break;
+    case 'VariableDeclaration':
+      if (scopes.length > 0) {
+        const scope = scopes[scopes.length - 1];
+        node.declarations.forEach(decl => {
+          if (decl.type === 'VariableDeclarator' && decl.id.type === 'Identifier') {
+            scope.idents.add(decl.id.name);
+          }
+        });
+      }
+      break;
+  }
+};
+
+/**
+ * Collects all module scope identifiers in the AST.
+ *
+ * Ignores identifiers that are in functions or classes.
+ * Ignores new scopes for StaticBlock nodes (can only reference static class members).
+ *
+ * Special case handling for these which create their own scopes,
+ * but are also valid module scope identifiers:
+ * - ClassDeclaration
+ * - FunctionDeclaration
+ *
+ * Special case handling for var inside BlockStatement
+ * which are also valid module scope identifiers.
+ */
+exports.collectScopeIdentifiers = collectScopeIdentifiers;
+const collectModuleIdentifiers = async (ast, hoisting = true) => {
+  const identifiers = new Map();
+  const globalReads = new Map();
+  const scopes = [];
+  await (0, _walk.ancestorWalk)(ast, {
+    enter(node, ancestors) {
+      const {
+        type
+      } = node;
+      collectScopeIdentifiers(node, scopes);
+
+      // Add module scope identifiers to the registry map
+
+      if (type === 'Identifier') {
+        const {
+          name
+        } = node;
+        const meta = identifiers.get(name) ?? {
+          declare: [],
+          read: []
+        };
+        const isDeclaration = _identifier.identifier.isDeclaration(ancestors);
+        const inScope = scopes.some(scope => scope.idents.has(name) || scope.name === name);
+        if (hoisting && !_identifier.identifier.isDeclaration(ancestors) && !_identifier.identifier.isFunctionExpressionId(ancestors) && !_identifier.identifier.isExportSpecifierAlias(ancestors) && !_identifier.identifier.isClassPropertyKey(ancestors) && !_identifier.identifier.isMethodDefinitionKey(ancestors) && !_identifier.identifier.isMemberKey(ancestors) && !_identifier.identifier.isPropertyKey(ancestors) && !_identifier.identifier.isIife(ancestors) && !inScope) {
+          if (globalReads.has(name)) {
+            globalReads.get(name)?.push(node);
+          } else {
+            globalReads.set(name, [node]);
+          }
+        }
+        if (isDeclaration) {
+          const isModuleScope = _identifier.identifier.isModuleScope(ancestors);
+          const isClassOrFuncDeclaration = _identifier.identifier.isClassOrFuncDeclarationId(ancestors);
+          const isVarDeclarationInGlobalScope = _identifier.identifier.isVarDeclarationInGlobalScope(ancestors);
+          if (isModuleScope || isClassOrFuncDeclaration || isVarDeclarationInGlobalScope) {
+            meta.declare.push(node);
+
+            // Check for hoisted reads
+            if (hoisting && globalReads.has(name)) {
+              const reads = globalReads.get(name);
+              if (reads) {
+                reads.forEach(read => {
+                  if (!meta.read.includes(read)) {
+                    meta.read.push(read);
+                  }
+                });
+              }
+            }
+            identifiers.set(name, meta);
+          }
+        } else {
+          if (identifiers.has(name) && !inScope && !_identifier.identifier.isIife(ancestors) && !_identifier.identifier.isFunctionExpressionId(ancestors) && !_identifier.identifier.isExportSpecifierAlias(ancestors) && !_identifier.identifier.isClassPropertyKey(ancestors) && !_identifier.identifier.isMethodDefinitionKey(ancestors) && !_identifier.identifier.isMemberKey(ancestors) && !_identifier.identifier.isPropertyKey(ancestors)) {
+            // Closure is referencing module scope identifier
+            meta.read.push(node);
+          }
+        }
+      }
+    },
+    leave(node) {
+      const {
+        type
+      } = node;
+      if (_scope.scopes.includes(type)) {
+        scopes.pop();
+      }
+    }
+  });
+  return identifiers;
+};
+exports.collectModuleIdentifiers = collectModuleIdentifiers;

package/dist/cjs/utils.d.cts

@@ -0,0 +1,26 @@
+import type { Node } from 'oxc-parser';
+import type { Specifier } from '@knighted/specifier';
+import type { IdentMeta, Scope, CjsExport } from './types.cjs';
+type UpdateSrcLang = Parameters<Specifier['updateSrc']>[1];
+declare const getLangFromExt: (filename: string) => UpdateSrcLang;
+declare const isValidUrl: (url: string) => boolean;
+declare const exportsRename = "__exports";
+declare const requireMainRgx: RegExp;
+declare const collectCjsExports: (ast: Node) => Promise<Map<string, CjsExport>>;
+declare const collectScopeIdentifiers: (node: Node, scopes: Scope[]) => void;
+/**
+ * Collects all module scope identifiers in the AST.
+ *
+ * Ignores identifiers that are in functions or classes.
+ * Ignores new scopes for StaticBlock nodes (can only reference static class members).
+ *
+ * Special case handling for these which create their own scopes,
+ * but are also valid module scope identifiers:
+ * - ClassDeclaration
+ * - FunctionDeclaration
+ *
+ * Special case handling for var inside BlockStatement
+ * which are also valid module scope identifiers.
+ */
+declare const collectModuleIdentifiers: (ast: Node, hoisting?: boolean) => Promise<Map<string, IdentMeta>>;
+export { getLangFromExt, isValidUrl, collectScopeIdentifiers, collectModuleIdentifiers, collectCjsExports, exportsRename, requireMainRgx, };

package/dist/cjs/walk.cjs

@@ -0,0 +1,75 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.walk = exports.ancestorWalk = void 0;
+var _oxcParser = require("oxc-parser");
+/**
+ * Using visitorKeys instead of oxc Visitor to keep
+ * an ancestor-aware enter/leave API with this.skip()
+ * without per-node method boilerplate.
+ */
+
+let skipDepth = -1;
+const isNodeLike = value => {
+  return Boolean(value && typeof value === 'object' && 'type' in value);
+};
+const traverse = async (node, visitors, ancestors, depth) => {
+  if (!node) return;
+  const keys = _oxcParser.visitorKeys[node.type] ?? [];
+  const ctx = {
+    skip: () => {
+      skipDepth = depth;
+    }
+  };
+  ancestors.push(node);
+  if (visitors.enter) {
+    await visitors.enter.call(ctx, node, ancestors);
+  }
+  if (skipDepth === -1 || depth < skipDepth) {
+    const fields = node;
+    for (const key of keys) {
+      const child = fields[key];
+      if (Array.isArray(child)) {
+        for (const nested of child) {
+          if (isNodeLike(nested)) {
+            await traverse(nested, visitors, ancestors, depth + 1);
+          }
+        }
+      } else if (isNodeLike(child)) {
+        await traverse(child, visitors, ancestors, depth + 1);
+      }
+    }
+  }
+  if (visitors.leave) {
+    await visitors.leave.call(ctx, node, ancestors);
+  }
+  ancestors.pop();
+  if (skipDepth === depth) {
+    skipDepth = -1;
+  }
+};
+const ancestorWalk = async (node, visitors) => {
+  skipDepth = -1;
+  await traverse(node, visitors, [], 0);
+};
+exports.ancestorWalk = ancestorWalk;
+const walk = async (node, visitors) => {
+  const wrap = {
+    enter(current, ancestors) {
+      const parent = ancestors[ancestors.length - 2] ?? null;
+      if (visitors.enter) {
+        return visitors.enter.call(this, current, parent);
+      }
+    },
+    leave(current, ancestors) {
+      const parent = ancestors[ancestors.length - 2] ?? null;
+      if (visitors.leave) {
+        return visitors.leave.call(this, current, parent);
+      }
+    }
+  };
+  await ancestorWalk(node, wrap);
+};
+exports.walk = walk;

package/dist/cjs/walk.d.cts

@@ -0,0 +1,20 @@
+import type { Node } from 'oxc-parser';
+/**
+ * Using visitorKeys instead of oxc Visitor to keep
+ * an ancestor-aware enter/leave API with this.skip()
+ * without per-node method boilerplate.
+ */
+type AncestorContext = {
+    skip: () => void;
+};
+type AncestorVisitor = {
+    enter?: (this: AncestorContext, node: Node, ancestors: Node[]) => void | Promise<void>;
+    leave?: (this: AncestorContext, node: Node, ancestors: Node[]) => void | Promise<void>;
+};
+type WalkVisitor = {
+    enter?: (this: AncestorContext, node: Node, parent: Node | null) => void | Promise<void>;
+    leave?: (this: AncestorContext, node: Node, parent: Node | null) => void | Promise<void>;
+};
+declare const ancestorWalk: (node: Node, visitors: AncestorVisitor) => Promise<void>;
+declare const walk: (node: Node, visitors: WalkVisitor) => Promise<void>;
+export { ancestorWalk, walk };

package/dist/exports.d.ts

@@ -0,0 +1,6 @@
+import type { Node } from 'oxc-parser';
+import type { CjsExport } from '../types.js';
+declare const exportsRename = "__exports";
+declare const requireMainRgx: RegExp;
+declare const collectCjsExports: (ast: Node) => Promise<Map<string, CjsExport>>;
+export { exportsRename, requireMainRgx, collectCjsExports };

package/dist/expressionStatement.d.ts

@@ -1,5 +1,4 @@
 import MagicString from 'magic-string';
-import type { NodePath } from '@babel/traverse';
-import type { ExpressionStatement } from '@babel/types';
+import type { Node, ExpressionStatement } from 'oxc-parser';
 import type { FormatterOptions } from '../types.js';
-export declare const expressionStatement: (nodePath: NodePath<ExpressionStatement>, src: MagicString, options: FormatterOptions) => void;
+export declare const expressionStatement: (node: ExpressionStatement, parent: Node | null, src: MagicString, options: FormatterOptions) => void;

package/dist/format.d.ts

@@ -1,9 +1,9 @@
-import MagicString from 'magic-string';
-import type { ParseResult } from '@babel/parser';
-import type { File } from '@babel/types';
+import type { ParseResult } from 'oxc-parser';
 import type { FormatterOptions } from './types.js';
 /**
- * Note, there is no specific conversion for `import.meta.main` as it does not exist.
- * @see https://github.com/nodejs/node/issues/49440
+ * Node added support for import.meta.main.
+ * Added in: v24.2.0, v22.18.0
+ * @see https://nodejs.org/api/esm.html#importmetamain
  */
-export declare const format: (code: string, ast: ParseResult<File>, options: FormatterOptions) => MagicString;
+declare const format: (src: string, ast: ParseResult, opts: FormatterOptions) => Promise<string>;
+export { format };