@knighted/module 1.0.0-alpha.2 → 1.0.0-alpha.4

package/README.md

@@ -89,8 +89,13 @@ type ModuleOptions = {
   /* Whether import/export and require/exports should be transformed. */
   modules?: boolean
   /* Whether to change specifier extensions to the assigned value. If omitted they are left alone. */
-  specifiers?: '.js' | '.mjs' | '.cjs' | '.ts' | '.mts' | '.cts'
-  /* What filepath to write the transformed source to. If omitted the transformed source is returned. */
+  specifier?: '.js' | '.mjs' | '.cjs' | '.ts' | '.mts' | '.cts'
+  /* What filepath to write the transformed source to. */
   out?: string
 }
 ```
+
+## Roadmap
+
+- Support option `modules`.
+- Remove `@knighted/specifier` and avoid double parsing.

package/dist/cjs/format.cjs

@@ -6,9 +6,9 @@ Object.defineProperty(exports, "__esModule", {
 exports.format = void 0;
 var _magicString = _interopRequireDefault(require("magic-string"));
 var _traverse2 = _interopRequireDefault(require("@babel/traverse"));
+var _identifier = require("./formatters/identifier.cjs");
 var _metaProperty = require("./formatters/metaProperty.cjs");
 var _memberExpression = require("./formatters/memberExpression.cjs");
-var _expressionStatement = require("./formatters/expressionStatement.cjs");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const traverse = _traverse2.default.default;
 
@@ -19,12 +19,12 @@ const traverse = _traverse2.default.default;
 const format = (code, ast, options) => {
   const src = new _magicString.default(code);
   traverse(ast, {
+    Identifier(path) {
+      (0, _identifier.identifier)(path, src, options);
+    },
     MetaProperty(path) {
       (0, _metaProperty.metaProperty)(path, src, options);
     },
-    ExpressionStatement(path) {
-      (0, _expressionStatement.expressionStatement)(path, src, options);
-    },
     MemberExpression(path) {
       (0, _memberExpression.memberExpression)(path, src, options);
     }

package/dist/cjs/formatters/identifier.cjs

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.identifier = void 0;
+const identifier = (nodePath, src, options) => {
+  if (options.type === 'module') {
+    const {
+      node
+    } = nodePath;
+    const {
+      start,
+      end
+    } = node;
+    if (typeof start === 'number' && typeof end === 'number' && node.type === 'Identifier') {
+      const {
+        name
+      } = node;
+      const isMemberExpression = Boolean(nodePath.findParent(path => path.isMemberExpression()));
+
+      // CommonJS globals in expression/statement
+      switch (name) {
+        case 'module':
+          {
+            if (!isMemberExpression) {
+              src.update(start, end, 'import.meta');
+            }
+            break;
+          }
+        case 'exports':
+          {
+            if (!isMemberExpression) {
+              src.update(start, end, '{}');
+            }
+            break;
+          }
+        case '__filename':
+          src.update(start, end, 'import.meta.filename');
+          break;
+        case '__dirname':
+          src.update(start, end, 'import.meta.dirname');
+          break;
+      }
+    }
+  }
+};
+exports.identifier = identifier;

package/dist/cjs/identifier.d.cts

@@ -0,0 +1,5 @@
+import MagicString from 'magic-string';
+import type { NodePath } from '@babel/traverse';
+import type { Identifier } from '@babel/types';
+import type { FormatterOptions } from '../types.cjs';
+export declare const identifier: (nodePath: NodePath<Identifier>, src: MagicString, options: FormatterOptions) => void;

package/dist/cjs/module.cjs

@@ -6,16 +6,14 @@ Object.defineProperty(exports, "__esModule", {
 exports.transform = void 0;
 var _nodePath = require("node:path");
 var _promises = require("node:fs/promises");
+var _specifier = require("@knighted/specifier");
 var _parse = require("./parse.cjs");
 var _format = require("./format.cjs");
-/**
- * Defaults to only transforming ES module globals to CommonJS.
- */
 const defaultOptions = {
   type: 'commonjs',
   out: undefined,
   modules: false,
-  specifiers: undefined
+  specifier: undefined
 };
 const transform = async (filename, options = defaultOptions) => {
   const opts = {
@@ -25,8 +23,29 @@ const transform = async (filename, options = defaultOptions) => {
   const file = (0, _nodePath.resolve)(filename);
   const code = (await (0, _promises.readFile)(file)).toString();
   const ast = (0, _parse.parse)(code);
-
-  // TODO: Support `out` option.
-  return (0, _format.format)(code, ast, opts).toString();
+  let source = (0, _format.format)(code, ast, opts).toString();
+  if (options.specifier) {
+    const {
+      code,
+      error
+    } = await _specifier.specifier.updateSrc(source, ({
+      value
+    }) => {
+      // Collapse any BinaryExpression or NewExpression to test for a relative specifier
+      const collapsed = value.replace(/['"`+)\s]|new String\(/g, '');
+      const relative = /^(?:\.|\.\.)\//;
+      if (relative.test(collapsed)) {
+        // $2 is for any closing quotation/parens around BE or NE
+        return value.replace(/(.+)\.(?:m|c)?(?:j|t)s([)'"`]*)?$/, `$1${options.specifier}$2`);
+      }
+    });
+    if (code && !error) {
+      source = code;
+    }
+  }
+  if (opts.out) {
+    await (0, _promises.writeFile)((0, _nodePath.resolve)(opts.out), source);
+  }
+  return source;
 };
 exports.transform = transform;

package/dist/cjs/types.d.cts

@@ -1,7 +1,7 @@
 export type ModuleOptions = {
     type?: 'module' | 'commonjs';
     modules?: boolean;
-    specifiers?: '.js' | '.mjs' | '.cjs' | '.ts' | '.mts' | '.cts';
+    specifier?: '.js' | '.mjs' | '.cjs' | '.ts' | '.mts' | '.cts';
     out?: string;
 };
 export type FormatterOptions = Omit<ModuleOptions, 'out'> & Required<Pick<ModuleOptions, 'type'>>;

package/dist/format.js

@@ -1,8 +1,8 @@
 import MagicString from 'magic-string';
 import _traverse from '@babel/traverse';
+import { identifier } from './formatters/identifier.js';
 import { metaProperty } from './formatters/metaProperty.js';
 import { memberExpression } from './formatters/memberExpression.js';
-import { expressionStatement } from './formatters/expressionStatement.js';
 const traverse = _traverse.default;
 
 /**
@@ -12,12 +12,12 @@ const traverse = _traverse.default;
 export const format = (code, ast, options) => {
   const src = new MagicString(code);
   traverse(ast, {
+    Identifier(path) {
+      identifier(path, src, options);
+    },
     MetaProperty(path) {
       metaProperty(path, src, options);
     },
-    ExpressionStatement(path) {
-      expressionStatement(path, src, options);
-    },
     MemberExpression(path) {
       memberExpression(path, src, options);
     }

package/dist/formatters/identifier.d.ts

@@ -0,0 +1,5 @@
+import MagicString from 'magic-string';
+import type { NodePath } from '@babel/traverse';
+import type { Identifier } from '@babel/types';
+import type { FormatterOptions } from '../types.js';
+export declare const identifier: (nodePath: NodePath<Identifier>, src: MagicString, options: FormatterOptions) => void;

package/dist/formatters/identifier.js

@@ -0,0 +1,41 @@
+export const identifier = (nodePath, src, options) => {
+  if (options.type === 'module') {
+    const {
+      node
+    } = nodePath;
+    const {
+      start,
+      end
+    } = node;
+    if (typeof start === 'number' && typeof end === 'number' && node.type === 'Identifier') {
+      const {
+        name
+      } = node;
+      const isMemberExpression = Boolean(nodePath.findParent(path => path.isMemberExpression()));
+
+      // CommonJS globals in expression/statement
+      switch (name) {
+        case 'module':
+          {
+            if (!isMemberExpression) {
+              src.update(start, end, 'import.meta');
+            }
+            break;
+          }
+        case 'exports':
+          {
+            if (!isMemberExpression) {
+              src.update(start, end, '{}');
+            }
+            break;
+          }
+        case '__filename':
+          src.update(start, end, 'import.meta.filename');
+          break;
+        case '__dirname':
+          src.update(start, end, 'import.meta.dirname');
+          break;
+      }
+    }
+  }
+};

package/dist/identifier.d.ts

@@ -0,0 +1,5 @@
+import MagicString from 'magic-string';
+import type { NodePath } from '@babel/traverse';
+import type { Identifier } from '@babel/types';
+import type { FormatterOptions } from '../types.js';
+export declare const identifier: (nodePath: NodePath<Identifier>, src: MagicString, options: FormatterOptions) => void;

package/dist/module.js

@@ -1,15 +1,13 @@
 import { resolve } from 'node:path';
-import { readFile } from 'node:fs/promises';
+import { readFile, writeFile } from 'node:fs/promises';
+import { specifier } from '@knighted/specifier';
 import { parse } from './parse.js';
 import { format } from './format.js';
-/**
- * Defaults to only transforming ES module globals to CommonJS.
- */
 const defaultOptions = {
   type: 'commonjs',
   out: undefined,
   modules: false,
-  specifiers: undefined
+  specifier: undefined
 };
 const transform = async (filename, options = defaultOptions) => {
   const opts = {
@@ -19,8 +17,29 @@ const transform = async (filename, options = defaultOptions) => {
   const file = resolve(filename);
   const code = (await readFile(file)).toString();
   const ast = parse(code);
-
-  // TODO: Support `out` option.
-  return format(code, ast, opts).toString();
+  let source = format(code, ast, opts).toString();
+  if (options.specifier) {
+    const {
+      code,
+      error
+    } = await specifier.updateSrc(source, ({
+      value
+    }) => {
+      // Collapse any BinaryExpression or NewExpression to test for a relative specifier
+      const collapsed = value.replace(/['"`+)\s]|new String\(/g, '');
+      const relative = /^(?:\.|\.\.)\//;
+      if (relative.test(collapsed)) {
+        // $2 is for any closing quotation/parens around BE or NE
+        return value.replace(/(.+)\.(?:m|c)?(?:j|t)s([)'"`]*)?$/, `$1${options.specifier}$2`);
+      }
+    });
+    if (code && !error) {
+      source = code;
+    }
+  }
+  if (opts.out) {
+    await writeFile(resolve(opts.out), source);
+  }
+  return source;
 };
 export { transform };

package/dist/types.d.ts

@@ -1,7 +1,7 @@
 export type ModuleOptions = {
     type?: 'module' | 'commonjs';
     modules?: boolean;
-    specifiers?: '.js' | '.mjs' | '.cjs' | '.ts' | '.mts' | '.cts';
+    specifier?: '.js' | '.mjs' | '.cjs' | '.ts' | '.mts' | '.cts';
     out?: string;
 };
 export type FormatterOptions = Omit<ModuleOptions, 'out'> & Required<Pick<ModuleOptions, 'type'>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knighted/module",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.4",
   "description": "Converts module differences in source files between ES and CommonJS.",
   "type": "module",
   "main": "dist/module.js",
@@ -68,13 +68,14 @@
     "eslint": "^9.3.0",
     "eslint-plugin-n": "^17.7.0",
     "prettier": "^3.2.5",
-    "tsx": "^4.11.0",
+    "tsx": "^4.11.2",
     "typescript": "^5.4.5",
-    "typescript-eslint": "^8.0.0-alpha.16"
+    "typescript-eslint": "^8.0.0-alpha.26"
   },
   "dependencies": {
     "@babel/parser": "^7.24.6",
     "@babel/traverse": "^7.24.6",
+    "@knighted/specifier": "^2.0.0-rc.1",
     "magic-string": "^0.30.10"
   },
   "prettier": {