@modern-js/node-bundle-require 1.1.0 → 1.2.1

package/CHANGELOG.md

@@ -1,85 +1,32 @@
 # @modern-js/1.0.0-rc.19
 
-## 1.1.0
-
-### Minor Changes
-
-- 96119db2: Relese v1.1.0
-
-  1. 全面支持 Windows 平台
-
-  ISSUE：
-
-  - [182](https://github.com/modern-js-dev/modern.js/issues/182)
-  - [236](https://github.com/modern-js-dev/modern.js/issues/236)
-
-  PR
-
-  - [219](https://github.com/modern-js-dev/modern.js/pull/219)
-  - [247](https://github.com/modern-js-dev/modern.js/pull/247)
-  - [249](https://github.com/modern-js-dev/modern.js/pull/249)
-  - [253](https://github.com/modern-js-dev/modern.js/pull/253)
-  - [268](https://github.com/modern-js-dev/modern.js/pull/268)
-  - [270](https://github.com/modern-js-dev/modern.js/pull/270)
-  - [273](https://github.com/modern-js-dev/modern.js/pull/273)
-  - [276](https://github.com/modern-js-dev/modern.js/pull/276)
-
-  2. 修复 Unbundled 模式启用问题
-
-  ISSUE
-
-  - [186](https://github.com/modern-js-dev/modern.js/issues/186)
-  - [224](https://github.com/modern-js-dev/modern.js/issues/224)
-  - [225](https://github.com/modern-js-dev/modern.js/issues/225)
-  - [238](https://github.com/modern-js-dev/modern.js/issues/238)
-
-  PR
-
-  - [226](https://github.com/modern-js-dev/modern.js/pull/226)
-  - [264](https://github.com/modern-js-dev/modern.js/pull/264)
-  - [codesmith-12](https://github.com/modern-js-dev/codesmith/pull/12)
+## 1.2.1
 
-  3. 修复模块工程方案 .npmignore 文件初始化未生成
-
-  ISSUE
-
-  - [198](https://github.com/modern-js-dev/modern.js/issues/198)
-
-  PR
-
-  - [209](https://github.com/modern-js-dev/modern.js/pull/209)
-
-  4. 修复 Storybook 使用时浏览器打开页面报错
-
-  ISSUE
-
-  - [228](https://github.com/modern-js-dev/modern.js/issues/228)
+### Patch Changes
 
-  PR
+- 83166714: change .npmignore
 
-  - [254](https://github.com/modern-js-dev/modern.js/pull/254)
+## 1.2.0
 
-  5. 修复 BFF 一体化开发不支持 unbundle 模式
+### Minor Changes
 
-  ISSUE
+- cfe11628: Make Modern.js self bootstraping
 
-  - [235](https://github.com/modern-js-dev/modern.js/issues/235)
-  - [257](https://github.com/modern-js-dev/modern.js/issues/257)
+### Patch Changes
 
-  PR
+- 59cbcb77: fix esbuild error when project's tsconfig.json sets "target:es5"
 
-  - [269](https://github.com/modern-js-dev/modern.js/pull/269)
-  - [271](https://github.com/modern-js-dev/modern.js/pull/271)
+## 1.1.1
 
-  6. 修复 Node17 dev 命令报错问题
+### Patch Changes
 
-  ISSUE
+- 0fa83663: support more .env files
 
-  - [180](https://github.com/modern-js-dev/modern.js/issues/180)
+## 1.1.0
 
-  PR
+### Minor Changes
 
-  - [214](https://github.com/modern-js-dev/modern.js/pull/214)
+- 96119db2: Relese v1.1.0
 
 ## 1.0.1
 

package/dist/js/modern/index.js

@@ -1,12 +1,12 @@
-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 ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : 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 { randomUUID } from 'crypto';
+import { fs } from '@modern-js/utils';
 import { build } from 'esbuild';
 const JS_EXT_RE = /\.(mjs|cjs|ts|js|tsx|jsx)$/; // Must not start with "/" or "./" or "../"
 // "/test/node_modules/foo"
@@ -39,7 +39,11 @@ export async function bundleRequire(filepath, options) {
     outfile,
     format: 'cjs',
     platform: 'node',
-    bundle: true
+    bundle: true,
+    // fix transforming error when the project's tsconfig.json
+    // sets `target: "es5"`
+    // reference: https://github.com/evanw/esbuild/releases/tag/v0.12.6
+    target: 'esnext'
   }, 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
     {
@@ -94,7 +98,7 @@ export async function bundleRequire(filepath, options) {
         ctx.onLoad({
           filter: JS_EXT_RE
         }, async args => {
-          const contents = await fs.readFile(args.path, 'utf-8');
+          const contents = fs.readFileSync(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))
@@ -132,7 +136,7 @@ export async function bundleRequire(filepath, options) {
     mod = await req(outfile);
   } finally {
     // Remove the outfile after executed
-    await fs.unlink(outfile);
+    fs.unlinkSync(outfile);
   }
 
   return mod;

package/dist/js/node/index.js

@@ -6,19 +6,19 @@ Object.defineProperty(exports, "__esModule", {
 exports.EXTERNAL_REGEXP = void 0;
 exports.bundleRequire = bundleRequire;
 
-var _promises = _interopRequireDefault(require("fs/promises"));
-
 var _path = _interopRequireDefault(require("path"));
 
 var _crypto = require("crypto");
 
+var _utils = require("@modern-js/utils");
+
 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 ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : 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; }
 
@@ -55,7 +55,11 @@ async function bundleRequire(filepath, options) {
     outfile,
     format: 'cjs',
     platform: 'node',
-    bundle: true
+    bundle: true,
+    // fix transforming error when the project's tsconfig.json
+    // sets `target: "es5"`
+    // reference: https://github.com/evanw/esbuild/releases/tag/v0.12.6
+    target: 'esnext'
   }, 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
     {
@@ -110,7 +114,8 @@ async function bundleRequire(filepath, options) {
         ctx.onLoad({
           filter: JS_EXT_RE
         }, async args => {
-          const contents = await _promises.default.readFile(args.path, 'utf-8');
+          const contents = _utils.fs.readFileSync(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))
@@ -148,7 +153,7 @@ async function bundleRequire(filepath, options) {
     mod = await req(outfile);
   } finally {
     // Remove the outfile after executed
-    await _promises.default.unlink(outfile);
+    _utils.fs.unlinkSync(outfile);
   }
 
   return mod;

package/jest.config.js

@@ -0,0 +1,8 @@
+const sharedConfig = require('@scripts/jest-config');
+
+/** @type {import('@jest/types').Config.InitialOptions} */
+module.exports = {
+  // eslint-disable-next-line node/no-unsupported-features/es-syntax
+  ...sharedConfig,
+  rootDir: __dirname,
+};

package/modern.config.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modern-js/node-bundle-require",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "The meta-framework suite designed from scratch for frontend-focused modern web development.",
   "homepage": "https://modernjs.dev",
   "bugs": "https://github.com/modern-js-dev/modern.js/issues",
@@ -20,6 +20,7 @@
   "exports": {
     ".": {
       "node": {
+        "jsnext:source": "./src/index.ts",
         "import": "./dist/js/modern/index.js",
         "require": "./dist/js/node/index.js"
       },
@@ -31,11 +32,13 @@
     "esbuild": "^0.13.8"
   },
   "devDependencies": {
-    "@modern-js/plugin-testing": "^1.0.2",
-    "@modern-js/module-tools": "^1.0.2",
+    "@scripts/build": "0.0.0",
+    "@modern-js/utils": "^1.2.2",
     "@types/jest": "^26.0.9",
     "@types/node": "^14",
-    "typescript": "^4"
+    "typescript": "^4",
+    "jest": "^27",
+    "@scripts/jest-config": "0.0.0"
   },
   "sideEffects": false,
   "modernConfig": {
@@ -45,11 +48,13 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "types": "./dist/types/index.d.ts"
   },
   "scripts": {
     "new": "modern new",
     "build": "modern build",
-    "test": "modern test --passWithNoTests"
-  }
+    "test": "jest --passWithNoTests"
+  },
+  "readme": "\n<p align=\"center\">\n  <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>\n</p>\n<p align=\"center\">\n现代 Web 工程体系\n  <br/>\n  <a href=\"https://modernjs.dev\" target=\"blank\">\n    modernjs.dev\n  </a>\n</p>\n<p align=\"center\">\n  The meta-framework suite designed from scratch for frontend-focused modern web development\n</p>\n\n# Introduction\n\n> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.\n\n- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)\n\n## Getting Started\n\n- [Quick Start](https://modernjs.dev/docs/start)\n- [Guides](https://modernjs.dev/docs/guides)\n- [API References](https://modernjs.dev/docs/apis)\n\n## Contributing\n\n- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)\n"
 }

package/tests/fixture/a.ts

@@ -1 +1,2 @@
 export const filename: string = __filename;
+export const showFileName = () => filename;

package/tests/index.test.ts

@@ -5,7 +5,14 @@ test('require', async () => {
   const result = await bundleRequire(
     path.join(__dirname, './fixture/input.ts'),
   );
+  // when tsconfig.json sets `compilerOptions.target` to `es5`
+  // normally it will met error
+  // So we need to manually set esbuild's target to esnext to avoid that
+  // These two cases above use ES6+ ability, to test whether esbuild successfuly
+  // works on non-ES5 files
+  // reference: https://github.com/evanw/esbuild/releases/tag/v0.12.6
   expect(result.default.a.filename.endsWith('a.ts')).toEqual(true);
+  expect(result.default.a.showFileName().endsWith('a.ts')).toEqual(true);
 });
 
 describe('external regexp', () => {

package/tests/tsconfig.json

@@ -2,10 +2,9 @@
   "extends": "@modern-js/tsconfig/base",
   "compilerOptions": {
     "declaration": false,
+    "target": "es5",
     "jsx": "preserve",
     "baseUrl": "./",
-    "paths": {
-      "@/*": ["../src/*"]
-    }
+    "paths": {}
   }
 }

package/tsconfig.json

@@ -5,9 +5,7 @@
     "jsx": "preserve",
     "baseUrl": "./",
     "isolatedModules": true,
-    "paths": {
-      "@/*": ["./src/*"]
-    }
+    "paths": {}
   },
   "include": ["src"]
 }

package/src/.eslintrc.json

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

package/src/index.ts

@@ -1,163 +0,0 @@
-import fs from 'fs/promises';
-import path from 'path';
-import { randomUUID } from 'crypto';
-import { build, Loader, Plugin, BuildOptions } from 'esbuild';
-
-const JS_EXT_RE = /\.(mjs|cjs|ts|js|tsx|jsx)$/;
-
-// Must not start with "/" or "./" or "../"
-// "/test/node_modules/foo"
-// "c:/node_modules/foo"
-export const EXTERNAL_REGEXP = /^[^./]|^\.[^./]|^\.\.[^/]/;
-
-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()}.${randomUUID({
-      disableEntropyCache: true,
-    })}.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) {
-          _build.onResolve({ filter: EXTERNAL_REGEXP }, args => {
-            let external = true;
-            // FIXME: windows external entrypoint
-            if (args.kind === 'entry-point') {
-              external = false;
-            }
-            return {
-              path: args.path,
-              external,
-            };
-          });
-        },
-      },
-    ],
-  });
-
-  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

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