@modern-js/node-bundle-require 1.0.0-rc.20

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# @modern-js/node-bundle-require
+
+## 1.0.0-rc.20
+### Patch Changes
+
+- feat: fix bugs

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Modern.js
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+
+<p align="center">
+  <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
+</p>
+
+<p align="center">
+现代 Web 工程体系
+<br/>
+<a href="https://modernjs.dev" target="blank">
+modernjs.dev
+</a>
+</p>
+
+
+## 参考链接
+- [迈入现代 Web 开发](https://zhuanlan.zhihu.com/p/386607009)
+- [现代 Web 开发者问卷调查报告](https://zhuanlan.zhihu.com/p/403206195)
+- [字节跳动是如何落地微前端的](https://mp.weixin.qq.com/s/L9wbfNG5fTXF5bx7dcgj4Q)
+
+## 近期计划
+
+Modern.js 的 1.0.0.rc 版已经发到 npm，目前在做测试改进和文档建设。
+
+README、完整的文档站、介绍等，都计划在 10 月 27 日上线。

package/dist/js/modern/index.js

@@ -0,0 +1,123 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import fs from 'fs/promises';
+import path from 'path';
+import { build } from 'esbuild';
+const JS_EXT_RE = /\.(mjs|cjs|ts|js|tsx|jsx)$/;
+const CACHE_DIR = path.relative(process.cwd(), './node_modules/.node-bundle-require');
+
+function inferLoader(ext) {
+  if (ext === '.mjs' || ext === '.cjs') return 'js';
+  return ext.slice(1);
+}
+
+const defaultGetOutputFile = filepath => path.resolve(CACHE_DIR, `${filepath}-${Date.now()}.bundled.cjs`);
+
+export async function bundleRequire(filepath, options) {
+  if (!JS_EXT_RE.test(filepath)) {
+    throw new Error(`${filepath} is not a valid JS file`);
+  }
+
+  const getOutputFile = (options === null || options === void 0 ? void 0 : options.getOutputFile) || defaultGetOutputFile;
+  const outfile = getOutputFile(filepath);
+  await build(_objectSpread(_objectSpread({
+    entryPoints: [filepath],
+    outfile,
+    format: 'cjs',
+    platform: 'node',
+    bundle: true
+  }, options === null || options === void 0 ? void 0 : options.esbuildOptions), {}, {
+    plugins: [...((options === null || options === void 0 ? void 0 : options.esbuildPlugins) || []), // https://github.com/evanw/esbuild/issues/1051#issuecomment-806325487
+    {
+      name: 'native-node-modules',
+
+      // eslint-disable-next-line @typescript-eslint/no-shadow
+      setup(build) {
+        // If a ".node" file is imported within a module in the "file" namespace, resolve
+        // it to an absolute path and put it into the "node-file" virtual namespace.
+        build.onResolve({
+          filter: /\.node$/,
+          namespace: 'file'
+        }, args => ({
+          path: require.resolve(args.path, {
+            paths: [args.resolveDir]
+          }),
+          namespace: 'node-file'
+        })); // Files in the "node-file" virtual namespace call "require()" on the
+        // path from esbuild of the ".node" file in the output directory.
+
+        build.onLoad({
+          filter: /.*/,
+          namespace: 'node-file'
+        }, args => ({
+          contents: `
+              import path from ${JSON.stringify(args.path)}
+              try { module.exports = require(path) }
+              catch {}
+            `
+        })); // If a ".node" file is imported within a module in the "node-file" namespace, put
+        // it in the "file" namespace where esbuild's default loading behavior will handle
+        // it. It is already an absolute path since we resolved it to one above.
+
+        build.onResolve({
+          filter: /\.node$/,
+          namespace: 'node-file'
+        }, args => ({
+          path: args.path,
+          namespace: 'file'
+        })); // Tell esbuild's default loading behavior to use the "file" loader for
+        // these ".node" files.
+
+        const opts = build.initialOptions;
+        opts.loader = opts.loader || {};
+        opts.loader['.node'] = 'file';
+      }
+
+    }, {
+      name: 'replace-path',
+
+      setup(ctx) {
+        ctx.onLoad({
+          filter: JS_EXT_RE
+        }, async args => {
+          const contents = await fs.readFile(args.path, 'utf-8');
+          return {
+            contents: contents.replace(/\b__filename\b/g, JSON.stringify(args.path)).replace(/\b__dirname\b/g, JSON.stringify(path.dirname(args.path))).replace(/\bimport\.meta\.url\b/g, JSON.stringify(`file://${args.path}`)),
+            loader: inferLoader(path.extname(args.path))
+          };
+        });
+      }
+
+    }, // https://github.com/evanw/esbuild/issues/619#issuecomment-751995294
+    {
+      name: 'make-all-packages-external',
+
+      setup(build) {
+        let filter = /^[^.\/]|^\.[^.\/]|^\.\.[^\/]/; // Must not start with "/" or "./" or "../"
+
+        build.onResolve({
+          filter
+        }, args => ({
+          path: args.path,
+          external: true
+        }));
+      }
+
+    }]
+  }));
+  let mod;
+  const req = (options === null || options === void 0 ? void 0 : options.require) || require;
+
+  try {
+    mod = await req(outfile);
+  } finally {
+    // Remove the outfile after executed
+    await fs.unlink(outfile);
+  }
+
+  return mod;
+}

package/dist/js/node/index.js

@@ -0,0 +1,136 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.bundleRequire = bundleRequire;
+
+var _promises = _interopRequireDefault(require("fs/promises"));
+
+var _path = _interopRequireDefault(require("path"));
+
+var _esbuild = require("esbuild");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+const JS_EXT_RE = /\.(mjs|cjs|ts|js|tsx|jsx)$/;
+
+const CACHE_DIR = _path.default.relative(process.cwd(), './node_modules/.node-bundle-require');
+
+function inferLoader(ext) {
+  if (ext === '.mjs' || ext === '.cjs') return 'js';
+  return ext.slice(1);
+}
+
+const defaultGetOutputFile = filepath => _path.default.resolve(CACHE_DIR, `${filepath}-${Date.now()}.bundled.cjs`);
+
+async function bundleRequire(filepath, options) {
+  if (!JS_EXT_RE.test(filepath)) {
+    throw new Error(`${filepath} is not a valid JS file`);
+  }
+
+  const getOutputFile = (options === null || options === void 0 ? void 0 : options.getOutputFile) || defaultGetOutputFile;
+  const outfile = getOutputFile(filepath);
+  await (0, _esbuild.build)(_objectSpread(_objectSpread({
+    entryPoints: [filepath],
+    outfile,
+    format: 'cjs',
+    platform: 'node',
+    bundle: true
+  }, options === null || options === void 0 ? void 0 : options.esbuildOptions), {}, {
+    plugins: [...((options === null || options === void 0 ? void 0 : options.esbuildPlugins) || []), // https://github.com/evanw/esbuild/issues/1051#issuecomment-806325487
+    {
+      name: 'native-node-modules',
+
+      // eslint-disable-next-line @typescript-eslint/no-shadow
+      setup(build) {
+        // If a ".node" file is imported within a module in the "file" namespace, resolve
+        // it to an absolute path and put it into the "node-file" virtual namespace.
+        build.onResolve({
+          filter: /\.node$/,
+          namespace: 'file'
+        }, args => ({
+          path: require.resolve(args.path, {
+            paths: [args.resolveDir]
+          }),
+          namespace: 'node-file'
+        })); // Files in the "node-file" virtual namespace call "require()" on the
+        // path from esbuild of the ".node" file in the output directory.
+
+        build.onLoad({
+          filter: /.*/,
+          namespace: 'node-file'
+        }, args => ({
+          contents: `
+              import path from ${JSON.stringify(args.path)}
+              try { module.exports = require(path) }
+              catch {}
+            `
+        })); // If a ".node" file is imported within a module in the "node-file" namespace, put
+        // it in the "file" namespace where esbuild's default loading behavior will handle
+        // it. It is already an absolute path since we resolved it to one above.
+
+        build.onResolve({
+          filter: /\.node$/,
+          namespace: 'node-file'
+        }, args => ({
+          path: args.path,
+          namespace: 'file'
+        })); // Tell esbuild's default loading behavior to use the "file" loader for
+        // these ".node" files.
+
+        const opts = build.initialOptions;
+        opts.loader = opts.loader || {};
+        opts.loader['.node'] = 'file';
+      }
+
+    }, {
+      name: 'replace-path',
+
+      setup(ctx) {
+        ctx.onLoad({
+          filter: JS_EXT_RE
+        }, async args => {
+          const contents = await _promises.default.readFile(args.path, 'utf-8');
+          return {
+            contents: contents.replace(/\b__filename\b/g, JSON.stringify(args.path)).replace(/\b__dirname\b/g, JSON.stringify(_path.default.dirname(args.path))).replace(/\bimport\.meta\.url\b/g, JSON.stringify(`file://${args.path}`)),
+            loader: inferLoader(_path.default.extname(args.path))
+          };
+        });
+      }
+
+    }, // https://github.com/evanw/esbuild/issues/619#issuecomment-751995294
+    {
+      name: 'make-all-packages-external',
+
+      setup(build) {
+        let filter = /^[^.\/]|^\.[^.\/]|^\.\.[^\/]/; // Must not start with "/" or "./" or "../"
+
+        build.onResolve({
+          filter
+        }, args => ({
+          path: args.path,
+          external: true
+        }));
+      }
+
+    }]
+  }));
+  let mod;
+  const req = (options === null || options === void 0 ? void 0 : options.require) || require;
+
+  try {
+    mod = await req(outfile);
+  } finally {
+    // Remove the outfile after executed
+    await _promises.default.unlink(outfile);
+  }
+
+  return mod;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,26 @@
+import { Plugin, BuildOptions } from 'esbuild';
+export interface Options {
+  /**
+   * The `require` function that is used to load the output file
+   * Default to the global `require` function
+   * This function can be asynchronous, i.e. returns a Promise
+   */
+  require?: (outfile: string) => any;
+  /**
+   * esbuild options
+   */
+
+  esbuildOptions?: BuildOptions;
+  /**
+   * esbuild plugin
+   */
+
+  esbuildPlugins?: Plugin[];
+  /**
+   * Get the path to the output file
+   * By default we simply replace the extension with `.bundled.cjs`
+   */
+
+  getOutputFile?: (filepath: string) => string;
+}
+export declare function bundleRequire(filepath: string, options?: Options): Promise<any>;

package/modern.config.js

@@ -0,0 +1,10 @@
+/** @type {import('@modern-js/module-tools').UserConfig} */
+module.exports = {
+  testing: {
+    jest: {
+      collectCoverage: true,
+      collectCoverageFrom: ['src/**/*.ts'],
+      coveragePathIgnorePatterns: ['/node_modules/'],
+    },
+  },
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@modern-js/node-bundle-require",
+  "version": "1.0.0-rc.20",
+  "jsnext:source": "./src/index.ts",
+  "types": "./dist/types/index.d.ts",
+  "main": "./dist/js/node/index.js",
+  "module": "./dist/js/treeshaking/index.js",
+  "jsnext:modern": "./dist/js/modern/index.js",
+  "dependencies": {
+    "@babel/runtime": "^7",
+    "esbuild": "^0.13.9"
+  },
+  "peerDependencies": {
+    "react": "^17"
+  },
+  "devDependencies": {
+    "@modern-js/plugin-testing": "^1.0.0-rc.20",
+    "@modern-js/module-tools": "^1.0.0-rc.20",
+    "@types/jest": "^26.0.9",
+    "@types/node": "^14",
+    "@types/react": "^17",
+    "@types/react-dom": "^17",
+    "react": "^17",
+    "typescript": "^4"
+  },
+  "sideEffects": false,
+  "modernConfig": {
+    "output": {
+      "packageMode": "node-js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "dev": "modern dev",
+    "build": "modern build",
+    "new": "modern new",
+    "test": "modern test --passWithNoTests"
+  }
+}

package/src/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["@modern-js-app"]
+}

package/src/index.ts

@@ -0,0 +1,138 @@
+import fs from 'fs/promises';
+import path from 'path';
+import { build, Loader, Plugin, BuildOptions } from 'esbuild';
+
+const JS_EXT_RE = /\.(mjs|cjs|ts|js|tsx|jsx)$/;
+
+const CACHE_DIR = path.relative(process.cwd(), './node_modules/.node-bundle-require');
+
+function inferLoader(ext: string): Loader {
+  if (ext === '.mjs' || ext === '.cjs') return 'js'
+  return ext.slice(1) as Loader
+}
+
+export interface Options {
+  /**
+   * The `require` function that is used to load the output file
+   * Default to the global `require` function
+   * This function can be asynchronous, i.e. returns a Promise
+   */
+  require?: (outfile: string) => any;
+  /**
+   * esbuild options
+   */
+  esbuildOptions?: BuildOptions;
+  /**
+   * esbuild plugin
+   */
+  esbuildPlugins?: Plugin[];
+  /**
+   * Get the path to the output file
+   * By default we simply replace the extension with `.bundled.cjs`
+   */
+  getOutputFile?: (filepath: string) => string;
+}
+
+const defaultGetOutputFile = (filepath: string) =>
+  path.resolve(CACHE_DIR, `${filepath}-${Date.now()}.bundled.cjs`);
+
+export async function bundleRequire(filepath: string, options?: Options) {
+  if (!JS_EXT_RE.test(filepath)) {
+    throw new Error(`${filepath} is not a valid JS file`);
+  }
+
+  const getOutputFile = options?.getOutputFile || defaultGetOutputFile;
+  const outfile = getOutputFile(filepath);
+
+  await build({
+    entryPoints: [filepath],
+    outfile,
+    format: 'cjs',
+    platform: 'node',
+    bundle: true,
+    ...options?.esbuildOptions,
+    plugins: [
+      ...(options?.esbuildPlugins || []),
+      // https://github.com/evanw/esbuild/issues/1051#issuecomment-806325487
+      {
+        name: 'native-node-modules',
+        // eslint-disable-next-line @typescript-eslint/no-shadow
+        setup(build) {
+          // If a ".node" file is imported within a module in the "file" namespace, resolve
+          // it to an absolute path and put it into the "node-file" virtual namespace.
+          build.onResolve({ filter: /\.node$/, namespace: 'file' }, args => ({
+            path: require.resolve(args.path, { paths: [args.resolveDir] }),
+            namespace: 'node-file',
+          }));
+
+          // Files in the "node-file" virtual namespace call "require()" on the
+          // path from esbuild of the ".node" file in the output directory.
+          build.onLoad({ filter: /.*/, namespace: 'node-file' }, args => ({
+            contents: `
+              import path from ${JSON.stringify(args.path)}
+              try { module.exports = require(path) }
+              catch {}
+            `,
+          }));
+
+          // If a ".node" file is imported within a module in the "node-file" namespace, put
+          // it in the "file" namespace where esbuild's default loading behavior will handle
+          // it. It is already an absolute path since we resolved it to one above.
+          build.onResolve(
+            { filter: /\.node$/, namespace: 'node-file' },
+            args => ({
+              path: args.path,
+              namespace: 'file',
+            }),
+          );
+
+          // Tell esbuild's default loading behavior to use the "file" loader for
+          // these ".node" files.
+          const opts = build.initialOptions;
+          opts.loader = opts.loader || {};
+          opts.loader['.node'] = 'file';
+        },
+      },
+      {
+        name: 'replace-path',
+        setup(ctx) {
+          ctx.onLoad({ filter: JS_EXT_RE }, async (args) => {
+            const contents = await fs.readFile(args.path, 'utf-8')
+            return {
+              contents: contents
+                .replace(/\b__filename\b/g, JSON.stringify(args.path))
+                .replace(
+                  /\b__dirname\b/g,
+                  JSON.stringify(path.dirname(args.path)),
+                )
+                .replace(
+                  /\bimport\.meta\.url\b/g,
+                  JSON.stringify(`file://${args.path}`),
+                ),
+              loader: inferLoader(path.extname(args.path)),
+            }
+          })
+        },
+      },
+      // https://github.com/evanw/esbuild/issues/619#issuecomment-751995294
+      {
+        name: 'make-all-packages-external',
+        setup(build) {
+          let filter = /^[^.\/]|^\.[^.\/]|^\.\.[^\/]/ // Must not start with "/" or "./" or "../"
+          build.onResolve({ filter }, args => ({ path: args.path, external: true }))
+        },
+      }
+    ],
+  });
+
+  let mod: any;
+  const req = options?.require || require;
+  try {
+    mod = await req(outfile);
+  } finally {
+    // Remove the outfile after executed
+    await fs.unlink(outfile);
+  }
+
+  return mod;
+}

package/src/modern-app-env.d.ts

@@ -0,0 +1,2 @@
+/// <reference types='@modern-js/module-tools' />
+/// <reference types='@modern-js/plugin-testing/type' />

package/tests/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: "@modern-js-app",
+  parserOptions: {
+    project: require.resolve('tsconfig.json')
+  }
+}

package/tests/fixture/a.ts

@@ -0,0 +1 @@
+export const filename: string = __filename

package/tests/fixture/input.ts

@@ -0,0 +1,5 @@
+import * as a from './a'
+
+export default {
+  a,
+}

package/tests/index.test.ts

@@ -0,0 +1,7 @@
+import path from 'path'
+import { bundleRequire } from '..'
+
+test('main', async () => {
+  const result = await bundleRequire(path.join(__dirname, './fixture/input.ts'))
+  expect(result.default.a.filename.endsWith('a.ts')).toEqual(true)
+})

package/tests/modern-app-env.d.ts

@@ -0,0 +1,2 @@
+///<reference types="@modern-js/module-tools/types" />
+///<reference types="@modern-js/plugin-testing/type" />

package/tests/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "@modern-js/tsconfig/base",
+  "compilerOptions": {
+    "declaration": false,
+    "jsx": "preserve",
+    "baseUrl": "./",
+    "paths": {
+      "@/*": ["../src/*"]
+    }
+  }
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@modern-js/tsconfig/base",
+  "compilerOptions": {
+    "declaration": false,
+    "jsx": "preserve",
+    "baseUrl": "./",
+    "paths": {
+      "@/*": ["./src/*"],
+      "@style/*": ["./styles/*"]
+    }
+  },
+  "include": ["src"]
+}