Support sync-module

Author: jdalton

.config/rollup.base.config.mjs

@@ -10,14 +10,14 @@ import { readPackageUpSync } from 'read-package-up'
 import rangesIntersect from 'semver/ranges/intersects.js'
 import { purgePolyfills } from 'unplugin-purge-polyfills'
 
-import constants from '@socketsecurity/registry/lib/constants'
 import { isRelative } from '@socketsecurity/registry/lib/path'
 import { escapeRegExp } from '@socketsecurity/registry/lib/regexps'
 import {
   isValidPackageName,
   readPackageJsonSync
 } from '@socketsecurity/registry/lib/packages'
 
+import constants from '../scripts/constants.js'
 import socketModifyPlugin from '../scripts/rollup/socket-modify-plugin.js'
 import {
   getPackageName,
@@ -28,17 +28,18 @@ import {
   resolveId
 } from '../scripts/utils/packages.js'
 
-const { LATEST } = constants
+const {
+  LATEST,
+  ROLLUP_ENTRY_SUFFIX,
+  ROLLUP_EXTERNAL_SUFFIX,
+  SLASH_NODE_MODULES_SLASH
+} = constants
 
 const __dirname = fileURLToPath(new URL('.', import.meta.url))
 const require = createRequire(import.meta.url)
 
 const ts = require('rollup-plugin-ts')
 
-const ENTRY_SUFFIX = '?commonjs-entry'
-const EXTERNAL_SUFFIX = '?commonjs-external'
-const SLASH_NODE_MODULES_SLASH = '/node_modules/'
-
 const builtinAliases = builtinModules.reduce((o, n) => {
   o[n] = `node:${n}`
   return o
@@ -91,7 +92,7 @@ function isAncestorsExternal(id, depStats) {
   return true
 }
 
-export default (extendConfig = {}) => {
+export default function baseConfig(extendConfig = {}) {
   const depStats = {
     dependencies: { __proto__: null },
     devDependencies: { __proto__: null },
@@ -107,15 +108,15 @@ export default (extendConfig = {}) => {
       }
     },
     external(id_, parentId_) {
-      if (id_.endsWith(EXTERNAL_SUFFIX) || isBuiltin(id_)) {
+      if (id_.endsWith(ROLLUP_EXTERNAL_SUFFIX) || isBuiltin(id_)) {
         return true
       }
       const id = normalizeId(id_)
       if (
         isRelative(id) ||
+        id.startsWith('src/') ||
         id.endsWith('.mjs') ||
-        id.endsWith('.mts') ||
-        id.endsWith('.ts')
+        id.endsWith('.mts')
       ) {
         return false
       }
@@ -234,13 +235,13 @@ export default (extendConfig = {}) => {
         }
       }),
       commonjs({
+        defaultIsModuleExports: true,
+        extensions: ['.cjs', '.js', '.ts', `.ts${ROLLUP_ENTRY_SUFFIX}`],
         ignoreDynamicRequires: true,
         ignoreGlobal: true,
         ignoreTryCatch: true,
-        defaultIsModuleExports: true,
         strictRequires: 'auto',
-        transformMixedEsModules: true,
-        extensions: ['.cjs', '.js', '.ts', `.ts${ENTRY_SUFFIX}`]
+        transformMixedEsModules: true
       }),
       ...(extendConfig.plugins ?? [])
     ]

.config/rollup.dist.config.mjs

@@ -4,22 +4,34 @@ import { fileURLToPath } from 'node:url'
 
 import { toSortedObject } from '@socketsecurity/registry/lib/objects'
 import { readPackageJsonSync } from '@socketsecurity/registry/lib/packages'
+import { isRelative } from '@socketsecurity/registry/lib/path'
 
 import baseConfig from './rollup.base.config.mjs'
+import constants from '../scripts/constants.js'
 import { readJsonSync } from '../scripts/utils/fs.js'
 import { formatObject } from '../scripts/utils/objects.js'
+import { normalizeId, isBuiltin } from '../scripts/utils/packages.js'
+
+const { ROLLUP_EXTERNAL_SUFFIX } = constants
 
 const __dirname = fileURLToPath(new URL('.', import.meta.url))
 
 const rootPath = path.resolve(__dirname, '..')
 const depStatsPath = path.join(rootPath, '.dep-stats.json')
 const distPath = path.join(rootPath, 'dist')
+const distLegacyPath = path.join(rootPath, 'dist-legacy')
 const srcPath = path.join(rootPath, 'src')
 
+const binBasenames = ['cli.js', 'npm-cli.js', 'npx-cli.js']
 const editablePkgJson = readPackageJsonSync(rootPath, { editable: true })
 
+function setBinPerm(filepath) {
+  // Make file chmod +x.
+  chmodSync(filepath, 0o755)
+}
+
 export default () => {
-  const config = baseConfig({
+  const legacyConfig = baseConfig({
     input: {
       cli: `${srcPath}/cli.ts`,
       'npm-cli': `${srcPath}/shadow/npm-cli.ts`,
@@ -28,7 +40,7 @@ export default () => {
     },
     output: [
       {
-        dir: 'dist',
+        dir: 'dist-legacy',
         entryFileNames: '[name].js',
         format: 'cjs',
         exports: 'auto',
@@ -42,7 +54,7 @@ export default () => {
           const { content: pkgJson } = editablePkgJson
           const { '@cyclonedx/cdxgen': cdxgenRange, synp: synpRange } =
             pkgJson.dependencies
-          const { depStats } = config.meta
+          const { depStats } = legacyConfig.meta
 
           // Manually add @cyclonedx/cdxgen and synp as they are not directly
           // referenced in the code but used through spawned processes.
@@ -71,10 +83,7 @@ export default () => {
 
           // Write dep stats
           writeFileSync(depStatsPath, `${formatObject(depStats)}\n`, 'utf8')
-          // Make dist files chmod +x
-          chmodSync(path.join(distPath, 'cli.js'), 0o755)
-          chmodSync(path.join(distPath, 'npm-cli.js'), 0o755)
-          chmodSync(path.join(distPath, 'npx-cli.js'), 0o755)
+
           // Update dependencies with additional inlined modules
           editablePkgJson
             .update({
@@ -84,10 +93,49 @@ export default () => {
               }
             })
             .saveSync()
+
+          for (const binBasename of binBasenames) {
+            setBinPerm(path.join(distLegacyPath, binBasename))
+          }
+        }
+      }
+    ]
+  })
+
+  const syncEsmConfig = baseConfig({
+    input: {
+      cli: `${srcPath}/cli.ts`,
+      'npm-cli': `${srcPath}/shadow/npm-cli.ts`,
+      'npx-cli': `${srcPath}/shadow/npx-cli.ts`,
+      'npm-injection': `${srcPath}/shadow/npm-injection.ts`
+    },
+    output: [
+      {
+        dir: 'dist',
+        entryFileNames: '[name].js',
+        format: 'cjs',
+        exports: 'auto',
+        externalLiveBindings: false,
+        freeze: false
+      }
+    ],
+    external(id_) {
+      if (id_.endsWith(ROLLUP_EXTERNAL_SUFFIX) || isBuiltin(id_)) {
+        return true
+      }
+      const id = normalizeId(id_)
+      return !(isRelative(id) || id.startsWith(srcPath))
+    },
+    plugins: [
+      {
+        writeBundle() {
+          for (const binBasename of binBasenames) {
+            setBinPerm(path.join(distPath, binBasename))
+          }
         }
       }
     ]
   })
 
-  return config
+  return [legacyConfig, syncEsmConfig]
 }

.config/rollup.test.config.mjs

@@ -1,7 +1,13 @@
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 
+import { isRelative } from '@socketsecurity/registry/lib/path'
+
 import baseConfig from './rollup.base.config.mjs'
+import constants from '../scripts/constants.js'
+import { normalizeId, isBuiltin } from '../scripts/utils/packages.js'
+
+const { ROLLUP_EXTERNAL_SUFFIX, SUPPORTS_SYNC_ESM } = constants
 
 const __dirname = fileURLToPath(new URL('.', import.meta.url))
 
@@ -23,5 +29,16 @@ export default () =>
         externalLiveBindings: false,
         freeze: false
       }
-    ]
+    ],
+    ...(SUPPORTS_SYNC_ESM
+      ? {
+          external(id_) {
+            if (id_.endsWith(ROLLUP_EXTERNAL_SUFFIX) || isBuiltin(id_)) {
+              return true
+            }
+            const id = normalizeId(id_)
+            return !(isRelative(id) || id.startsWith(srcPath))
+          }
+        }
+      : {})
   })

.gitignore

@@ -8,6 +8,7 @@ Thumbs.db
 /coverage
 /npm-debug.log
 **/dist
+**/dist-legacy
 **/node_modules
 /*.tsbuildinfo
 *.d.ts

package.json

@@ -14,9 +14,25 @@
     "url": "https://socket.dev"
   },
   "bin": {
-    "socket": "dist/cli.js",
-    "socket-npm": "dist/npm-cli.js",
-    "socket-npx": "dist/npx-cli.js"
+    "socket": "./dist/cli.js",
+    "socket-npm": "./dist/npm-cli.js",
+    "socket-npx": "./dist/npx-cli.js"
+  },
+  "exports": {
+    "./dist/cli.js": {
+      "module-sync": "./dist/cli.js",
+      "require": "./dist-legacy/cli.js"
+    },
+    "./dist/npm-cli.js": {
+      "module-sync": "./dist/npm-cli.js",
+      "require": "./dist-legacy/npm-cli.js"
+    },
+    "./dist/npx-cli.js": {
+      "module-sync": "./dist/npx-cli.js",
+      "require": "./dist-legacy/npx-cli.js"
+    },
+    "./package.json": "./package.json",
+    "./translations.json": "./translations.json"
   },
   "scripts": {
     "build": "run-s build:*",
@@ -31,12 +47,12 @@
     "lint": "oxlint -c=./.oxlintrc.json --ignore-path=./.prettierignore --tsconfig=./tsconfig.json .",
     "lint:fix": "npm run lint -- --fix && npm run lint:fix:fast",
     "lint:fix:fast": "prettier --cache --log-level warn --write .",
-    "prepare": "husky",
+    "prepare": "husky && custompatch",
     "test": "run-s check build:* test:*",
     "test:c8": "c8 --reporter=none node --test 'test/socket-npm.test.cjs'",
     "test-ci": "run-s build:* test:*",
-    "test:unit": "tap",
-    "test:coverage": "cp -r .tap/coverage/*.json coverage/tmp && c8 --reporter=lcov --reporter=text --include 'dist/*.js' --exclude 'dist/vendor.js' report"
+    "test:unit": "tap-run",
+    "test:coverage": "cp -r .tap/coverage/*.json coverage/tmp && c8 --reporter=lcov --reporter=text --include 'dist{,-legacy}/*.js' --exclude 'dist-legacy/vendor.js' report"
   },
   "dependencies": {
     "@apideck/better-ajv-errors": "^0.3.6",
@@ -83,6 +99,7 @@
     "@rollup/plugin-node-resolve": "^15.3.0",
     "@rollup/plugin-replace": "^6.0.1",
     "@rollup/pluginutils": "^5.1.3",
+    "@tapjs/run": "^4.0.1",
     "@types/blessed": "^0.1.25",
     "@types/micromatch": "^4.0.9",
     "@types/mocha": "^10.0.10",
@@ -98,6 +115,7 @@
     "@typescript-eslint/eslint-plugin": "^8.17.0",
     "@typescript-eslint/parser": "^8.17.0",
     "c8": "^10.1.2",
+    "custompatch": "^1.0.28",
     "eslint": "^9.16.0",
     "eslint-import-resolver-oxc": "^0.5.0",
     "eslint-plugin-depend": "^0.12.0",
@@ -120,7 +138,6 @@
     "read-package-up": "^11.0.0",
     "rollup": "4.28.0",
     "rollup-plugin-ts": "^3.4.5",
-    "tap": "^21.0.1",
     "terminal-link": "^3.0.0",
     "tiny-updater": "^3.5.2",
     "type-coverage": "^2.29.7",
@@ -180,6 +197,7 @@
   "files": [
     "bin/**",
     "dist/**",
+    "dist-legacy/**",
     "translations.json"
   ]
 }

patches/@tapjs+run#4.0.1.patch

@@ -0,0 +1,23 @@
+Index: /@tapjs/run/dist/esm/index.js
+===================================================================
+--- /@tapjs/run/dist/esm/index.js
++++ /@tapjs/run/dist/esm/index.js
+@@ -5,8 +5,9 @@
+ // same process as the @tapjs/core Base class. node:repl loads
+ // node:domain, which conflicts with async-hook-domains used by tap
+ import { args, config, mainCommand } from './main-config.js';
+ process.title = 'tap';
++void (async () => {
+ switch (mainCommand) {
+     case 'help':
+         ;
+         (await import('./help.js')).help(args, config);
+@@ -52,5 +53,6 @@
+         ;
+         (await import('./list.js')).list(args, config);
+         break;
+ }
+-//# sourceMappingURL=index.js.map
+\ No newline at end of file
++})()
++//# sourceMappingURL=index.js.map

scripts/constants.js

@@ -0,0 +1,39 @@
+'use strict'
+
+const semver = require('semver')
+
+const registryConstants = require('@socketsecurity/registry/lib/constants')
+const {
+  objectEntries,
+  objectFromEntries
+} = require('@socketsecurity/registry/lib/objects')
+
+const ROLLUP_ENTRY_SUFFIX = '?commonjs-entry'
+const ROLLUP_EXTERNAL_SUFFIX = '?commonjs-external'
+const SLASH_NODE_MODULES_SLASH = '/node_modules/'
+const SUPPORTS_SYNC_ESM = semver.satisfies(process.versions.node, '>=22.12')
+
+const constants = Object.freeze(
+  Object.defineProperties(
+    { __proto__: null },
+    objectFromEntries(
+      objectEntries(Object.getOwnPropertyDescriptors(registryConstants)).reduce(
+        (entries, entry) => {
+          if (entries.findIndex(p => p[0] === entry[0]) === -1) {
+            entries.push(entry)
+          }
+          return entries
+        },
+        objectEntries(
+          Object.getOwnPropertyDescriptors({
+            ROLLUP_ENTRY_SUFFIX,
+            ROLLUP_EXTERNAL_SUFFIX,
+            SLASH_NODE_MODULES_SLASH,
+            SUPPORTS_SYNC_ESM
+          })
+        )
+      )
+    )
+  )
+)
+module.exports = constants