@modern-js/server-utils 1.0.0-rc.2

package/dist/js/treeshaking/middleware.js

@@ -0,0 +1,35 @@
+export var createMiddlewareCollecter = function createMiddlewareCollecter() {
+  var webMiddlewares = [];
+  var apiMiddlewares = [];
+  var ssrMiddlewares = [];
+
+  var addWebMiddleware = function addWebMiddleware(input) {
+    webMiddlewares.push(input);
+  };
+
+  var addAPIMiddleware = function addAPIMiddleware(input) {
+    apiMiddlewares.push(input);
+  };
+
+  var addSSRMiddleware = function addSSRMiddleware(input) {
+    ssrMiddlewares.push(input);
+  };
+
+  var getMiddlewares = function getMiddlewares() {
+    return {
+      web: webMiddlewares,
+      api: apiMiddlewares,
+      ssr: ssrMiddlewares
+    };
+  };
+
+  return {
+    getMiddlewares: getMiddlewares,
+    addWebMiddleware: addWebMiddleware,
+    addAPIMiddleware: addAPIMiddleware,
+    addSSRMiddleware: addSSRMiddleware
+  };
+};
+export var hook = function hook(attacher) {
+  return attacher;
+};

package/dist/js/treeshaking/requireModule.js

@@ -0,0 +1,26 @@
+import { findExists } from '@modern-js/utils';
+var FILE_EXTENSIONS = ['.ts', '.js'];
+export var requireModule = function requireModule(filename) {
+  var exist = findExists(FILE_EXTENSIONS.map(function (ext) {
+    return "".concat(filename).concat(ext);
+  }));
+
+  if (!exist) {
+    return null;
+  } // throw errors directly if require fail
+
+
+  var mod = require(exist);
+
+  return interopRequire(mod);
+};
+
+function interopRequire(obj) {
+  return interopRequireDefault(obj)["default"];
+}
+
+function interopRequireDefault(obj) {
+  return obj !== null && obj !== void 0 && obj.__esModule ? obj : {
+    "default": obj
+  };
+}

package/dist/types/babel.d.ts

@@ -0,0 +1,27 @@
+import { ILibPresetOption, ISyntaxOption } from '@modern-js/babel-preset-lib';
+import { TransformOptions } from '@babel/core';
+import type { NormalizedConfig } from '@modern-js/core';
+export * from '@babel/core';
+export interface ITsconfig {
+  compilerOptions?: {
+    rootDir?: string;
+    baseUrl?: string;
+    declaration?: boolean;
+    emitDeclarationOnly?: boolean;
+    isolatedModules?: boolean;
+    allowJs?: boolean;
+    outDir?: string;
+    paths?: Record<string, string[]>;
+  } | undefined;
+  include?: string[];
+  exclude?: string[];
+}
+export declare const readTsConfig: <T extends ITsconfig | null>(tsconfigPath: string, noExistReturn?: T) => ITsconfig | T;
+export declare const existTsConfigFile: (tsconfigAbsolutePath: string) => boolean;
+export declare const getBabelConfig: (libPresetOption: ILibPresetOption, syntaxOption: ISyntaxOption) => TransformOptions;
+export interface IPackageModeValue {
+  type: 'module' | 'commonjs';
+  syntax: 'es5' | 'es6+';
+  tsconfigPath: string;
+}
+export declare const resolveBabelConfig: (appDirectory: string, modernConfig: NormalizedConfig, option: IPackageModeValue) => any;

package/dist/types/gather.d.ts

@@ -0,0 +1 @@
+export declare const gather: (pwd: string) => import("./middleware").CollectMiddlewaresResult;

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './middleware';
+export * from './gather';
+export * from './babel';

package/dist/types/middleware.d.ts

@@ -0,0 +1,16 @@
+export declare type CollectMiddlewaresResult = {
+  web: any[];
+  api: any[];
+  ssr: any[];
+};
+export declare const createMiddlewareCollecter: () => {
+  getMiddlewares: () => CollectMiddlewaresResult;
+  addWebMiddleware: (input: any) => void;
+  addAPIMiddleware: (input: any) => void;
+  addSSRMiddleware: (input: any) => void;
+};
+export declare type AttacherOptions = {
+  addMiddleware: (...input: any[]) => void;
+};
+export declare type Attacher = (options: AttacherOptions) => void;
+export declare const hook: (attacher: Attacher) => Attacher;

package/dist/types/requireModule.d.ts

@@ -0,0 +1 @@
+export declare const requireModule: (filename: string) => any;

package/modern.config.js

@@ -0,0 +1,15 @@
+/** @type {import('@modern-js/module-tools').UserConfig} */
+module.exports = {
+  testing: {
+    jest: {
+      collectCoverage: true,
+      collectCoverageFrom: ['./src/**/*.ts'],
+      coveragePathIgnorePatterns: ['/node_modules/'],
+      testEnvironment: 'jsdom',
+      moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx', 'json'],
+      transform: {
+        '^.+\\.tsx?$': 'ts-jest',
+      },
+    },
+  },
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@modern-js/server-utils",
+  "version": "1.0.0-rc.2",
+  "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",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/js/modern/index.js",
+        "require": "./dist/js/node/index.js"
+      },
+      "default": "./dist/js/treeshaking/index.js"
+    }
+  },
+  "dependencies": {
+    "@babel/compat-data": "^7.15.0",
+    "@babel/core": "^7.15.0",
+    "@babel/plugin-proposal-class-properties": "^7.14.5",
+    "@babel/plugin-proposal-decorators": "^7.15.4",
+    "@babel/preset-env": "^7.15.0",
+    "@babel/preset-typescript": "^7.15.0",
+    "@babel/runtime": "^7",
+    "@modern-js/babel-preset-lib": "^1.0.0-rc.2",
+    "@modern-js/plugin": "^1.0.0-rc.2",
+    "@modern-js/utils": "^1.0.0-rc.2",
+    "babel-plugin-module-resolver": "^4.1.0",
+    "babel-plugin-transform-typescript-metadata": "^0.3.2",
+    "json5": "^2.2.0"
+  },
+  "devDependencies": {
+    "@modern-js/core": "^1.0.0-rc.2",
+    "@types/babel__core": "^7.1.15",
+    "@types/jest": "^26",
+    "@types/node": "^14",
+    "@types/react": "^17",
+    "@types/react-dom": "^17",
+    "ts-jest": "^27.0.4",
+    "typescript": "^4",
+    "@modern-js/plugin-testing": "^1.0.0-rc.2",
+    "@modern-js/module-tools": "^1.0.0-rc.2"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "new": "modern new",
+    "build": "modern build",
+    "test": "modern test --passWithNoTests"
+  }
+}

package/src/babel.ts

@@ -0,0 +1,149 @@
+import {
+  getBabelChain,
+  ILibPresetOption,
+  ISyntaxOption,
+} from '@modern-js/babel-preset-lib';
+import { TransformOptions } from '@babel/core';
+import { applyOptionsChain, fs, getAlias } from '@modern-js/utils';
+import type { NormalizedConfig } from '@modern-js/core';
+import json5 from 'json5';
+
+export * from '@babel/core';
+
+export interface ITsconfig {
+  compilerOptions?:
+    | {
+        rootDir?: string;
+        baseUrl?: string;
+        declaration?: boolean;
+        emitDeclarationOnly?: boolean;
+        isolatedModules?: boolean;
+        allowJs?: boolean;
+        outDir?: string;
+        paths?: Record<string, string[]>;
+      }
+    | undefined;
+  include?: string[];
+  exclude?: string[];
+}
+
+export const readTsConfig = <T extends null | ITsconfig>(
+  tsconfigPath: string,
+  noExistReturn: T = null as T,
+): ITsconfig | T => {
+  // 如果不存在，则返回 noExistReturn
+  if (!fs.existsSync(tsconfigPath)) {
+    return noExistReturn;
+  }
+  const content = fs.readFileSync(tsconfigPath, 'utf-8');
+  return json5.parse(content);
+};
+
+export const existTsConfigFile = (tsconfigAbsolutePath: string) => {
+  const tsconfig = readTsConfig(tsconfigAbsolutePath);
+  return Boolean(tsconfig);
+};
+
+export const getBabelConfig = (
+  libPresetOption: ILibPresetOption,
+  syntaxOption: ISyntaxOption,
+): TransformOptions => {
+  const chain = getBabelChain(libPresetOption, syntaxOption);
+
+  return {
+    sourceType: 'unambiguous',
+    ...chain.toJSON(),
+  };
+};
+
+export interface IPackageModeValue {
+  type: 'module' | 'commonjs';
+  syntax: 'es5' | 'es6+';
+  tsconfigPath: string;
+}
+
+export const resolveBabelConfig = (
+  appDirectory: string,
+  modernConfig: NormalizedConfig,
+  option: IPackageModeValue,
+  // FIXME: babel type can't pass type checking
+): any => {
+  const {
+    source: {
+      envVars,
+      globalVars,
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-expect-error
+      jsxTransformRuntime = 'automatic',
+    },
+    tools: { lodash: userLodashOption },
+  } = modernConfig;
+
+  // alias config
+  const aliasConfig = getAlias(modernConfig.source.alias, {
+    appDirectory,
+    ...option,
+  });
+
+  // lodash config
+  const lodashOptions = applyOptionsChain(
+    { id: ['lodash', 'ramda'] },
+    // TODO: 需要处理类型问题
+    userLodashOption as any,
+  );
+  // babel config
+  const babelChain = getBabelChain(
+    {
+      appDirectory,
+      enableReactPreset: true,
+      enableTypescriptPreset: true,
+      alias: aliasConfig,
+      envVars,
+      globalVars,
+      lodashOptions,
+      jsxTransformRuntime,
+    },
+    {
+      type: option.type,
+      syntax: option.syntax,
+    },
+  );
+
+  const envOptions = babelChain.preset('@babel/preset-env').options();
+  babelChain
+    .preset('@babel/preset-env')
+    .use(require.resolve('@babel/preset-env'), [
+      {
+        ...envOptions[0],
+        loose: true,
+      },
+    ]);
+
+  babelChain
+    .plugin('babel-plugin-transform-typescript-metadata')
+    .use(require.resolve('babel-plugin-transform-typescript-metadata'), []);
+
+  babelChain
+    .plugin('@babel/plugin-proposal-decorators')
+    .use(require.resolve('@babel/plugin-proposal-decorators'), [
+      { legacy: true },
+    ]);
+
+  babelChain
+    .plugin('@babel/plugin-proposal-class-properties')
+    .use(require.resolve('@babel/plugin-proposal-class-properties'), [
+      { loose: true },
+    ]);
+
+  const internalBabelConfig = { ...babelChain.toJSON() };
+
+  const userBabelConfig = modernConfig.tools.babel;
+  applyOptionsChain(
+    internalBabelConfig,
+    // TODO: 感觉 userBabelConfig 的类型应该是TransformOptions
+    userBabelConfig as any,
+    { chain: babelChain },
+  );
+
+  return internalBabelConfig;
+};

package/src/gather.ts

@@ -0,0 +1,30 @@
+import path from 'path';
+import { createMiddlewareCollecter } from './middleware';
+import { requireModule } from './requireModule';
+
+const API_DIR_PATH = 'api';
+const API_APP_NAME = '_app';
+const SERVER_DIR_PATH = 'server';
+const WEB_APP_NAME = 'index';
+
+export const gather = (pwd: string) => {
+  const { getMiddlewares, addAPIMiddleware, addWebMiddleware } =
+    createMiddlewareCollecter();
+
+  const apiPath = path.resolve(pwd, API_DIR_PATH);
+  const apiAppPath = path.resolve(apiPath, API_APP_NAME);
+  const serverPath = path.resolve(pwd, SERVER_DIR_PATH);
+  const webAppPath = path.resolve(serverPath, WEB_APP_NAME);
+
+  const apiAttacher = requireModule(apiAppPath);
+  if (apiAttacher) {
+    apiAttacher({ addMiddleware: addAPIMiddleware });
+  }
+
+  const webAttacher = requireModule(webAppPath);
+  if (webAttacher) {
+    webAttacher({ addMiddleware: addWebMiddleware });
+  }
+
+  return getMiddlewares();
+};

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './middleware';
+export * from './gather';
+export * from './babel';

package/src/middleware.ts

@@ -0,0 +1,43 @@
+export type CollectMiddlewaresResult = {
+  web: any[];
+  api: any[];
+  ssr: any[];
+};
+
+export const createMiddlewareCollecter = () => {
+  const webMiddlewares: any[] = [];
+  const apiMiddlewares: any[] = [];
+  const ssrMiddlewares: any[] = [];
+
+  const addWebMiddleware = (input: any) => {
+    webMiddlewares.push(input);
+  };
+
+  const addAPIMiddleware = (input: any) => {
+    apiMiddlewares.push(input);
+  };
+
+  const addSSRMiddleware = (input: any) => {
+    ssrMiddlewares.push(input);
+  };
+
+  const getMiddlewares = (): CollectMiddlewaresResult => ({
+    web: webMiddlewares,
+    api: apiMiddlewares,
+    ssr: ssrMiddlewares,
+  });
+  return {
+    getMiddlewares,
+    addWebMiddleware,
+    addAPIMiddleware,
+    addSSRMiddleware,
+  };
+};
+
+export type AttacherOptions = {
+  addMiddleware: (...input: any[]) => void;
+};
+
+export type Attacher = (options: AttacherOptions) => void;
+
+export const hook = (attacher: Attacher) => attacher;

package/src/requireModule.ts

@@ -0,0 +1,23 @@
+import { findExists } from '@modern-js/utils';
+
+const FILE_EXTENSIONS = ['.ts', '.js'];
+
+export const requireModule = (filename: string) => {
+  const exist = findExists(FILE_EXTENSIONS.map(ext => `${filename}${ext}`));
+
+  if (!exist) {
+    return null;
+  }
+
+  // throw errors directly if require fail
+  const mod = require(exist);
+  return interopRequire(mod);
+};
+
+function interopRequire(obj: any) {
+  return interopRequireDefault(obj).default;
+}
+
+function interopRequireDefault(obj: any) {
+  return obj?.__esModule ? obj : { default: obj };
+}

package/tests/__snapshots__/babel.test.ts.snap

@@ -0,0 +1,172 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`babel resolveBabelConfig 1`] = `
+Object {
+  "plugins": Array [
+    Array [
+      "/babel-plugin-macros/dist/index.js",
+      Object {
+        "twin": Object {
+          "preset": "styled-components",
+        },
+      },
+    ],
+    Array [
+      "/babel-plugin-import/lib/index.js",
+      Object {
+        "libraryDirectory": "es",
+        "libraryName": "antd",
+        "style": true,
+      },
+      "import-antd",
+    ],
+    Array [
+      "/babel-plugin-lodash/lib/index.js",
+      Object {
+        "id": Array [
+          "lodash",
+          "ramda",
+        ],
+      },
+    ],
+    Array [
+      "/@babel/plugin-proposal-decorators/lib/index.js",
+      Object {
+        "legacy": true,
+      },
+    ],
+    Array [
+      "/@babel/plugin-proposal-class-properties/lib/index.js",
+      Object {
+        "loose": true,
+      },
+    ],
+    Array [
+      "/@babel/plugin-proposal-private-methods/lib/index.js",
+      Object {
+        "loose": true,
+      },
+    ],
+    Array [
+      "/@babel/plugin-proposal-private-property-in-object/lib/index.js",
+      Object {
+        "loose": true,
+      },
+    ],
+    Array [
+      "/@babel/plugin-proposal-object-rest-spread/lib/index.js",
+      Object {
+        "useBuiltIns": true,
+      },
+    ],
+    Array [
+      "/@babel/plugin-transform-runtime/lib/index.js",
+      Object {
+        "corejs": false,
+        "helpers": false,
+        "regenerator": false,
+        "useESModules": false,
+        "version": "7.15.4",
+      },
+    ],
+    Array [
+      "/babel-plugin-transform-react-remove-prop-types/lib/index.js",
+      Object {
+        "removeImport": true,
+      },
+    ],
+    Array [
+      "/@babel/plugin-proposal-function-bind/lib/index.js",
+    ],
+    Array [
+      "/@babel/plugin-proposal-export-default-from/lib/index.js",
+    ],
+    Array [
+      "/@babel/plugin-proposal-export-namespace-from/lib/index.js",
+    ],
+    Array [
+      "/@babel/plugin-proposal-optional-chaining/lib/index.js",
+    ],
+    Array [
+      "/@babel/plugin-proposal-numeric-separator/lib/index.js",
+    ],
+    Array [
+      "/@babel/plugin-proposal-pipeline-operator/lib/index.js",
+      Object {
+        "proposal": "minimal",
+      },
+    ],
+    Array [
+      "/@babel/plugin-proposal-partial-application/lib/index.js",
+    ],
+    Array [
+      "/@babel/plugin-proposal-nullish-coalescing-operator/lib/index.js",
+    ],
+    Array [
+      "/babel-plugin-styled-components/lib/index.js",
+      Object {},
+      "styled-components",
+    ],
+    Array [
+      "/babel-plugin-transform-inline-environment-variables/lib/index.js",
+      Object {
+        "include": Array [],
+      },
+    ],
+    Array [
+      "/babel-plugin-module-resolver/lib/index.js",
+      Object {
+        "alias": Object {
+          "@/*": Array [
+            "./src/*",
+          ],
+        },
+        "extensions": Array [
+          ".ts",
+          ".tsx",
+          ".js",
+          ".jsx",
+          ".es",
+          ".es6",
+          ".mjs",
+        ],
+        "resolvePath": [Function],
+        "root": "/packages/server/utils/tests/fixtures/",
+      },
+    ],
+    Array [
+      "/babel-plugin-transform-typescript-metadata/lib/plugin.js",
+    ],
+  ],
+  "presets": Array [
+    Array [
+      "/@babel/preset-env/lib/index.js",
+      Object {
+        "bugfixes": true,
+        "modules": "commonjs",
+        "shippedProposals": false,
+        "targets": Array [
+          "chrome > 61",
+          "edge > 16",
+          "firefox > 60",
+          "safari > 11",
+          "ios_saf > 11",
+        ],
+      },
+    ],
+    Array [
+      "/@babel/preset-react/lib/index.js",
+      Object {
+        "runtime": "automatic",
+      },
+    ],
+    Array [
+      "/@babel/preset-typescript/lib/index.js",
+      Object {
+        "allowDeclareFields": true,
+        "allowNamespaces": true,
+      },
+    ],
+  ],
+}
+`;

package/tests/babel.test.ts

@@ -0,0 +1,31 @@
+import path from 'path';
+import { defaults } from './helpers';
+import { resolveBabelConfig } from '@/index';
+
+describe('babel', () => {
+  it('resolveBabelConfig', () => {
+    const pwd = path.resolve(__dirname, './fixtures');
+    const tsconfigPath = path.resolve(
+      __dirname,
+      './fixtures/api/tsconfig.json',
+    );
+    const config = resolveBabelConfig(pwd, defaults as any, {
+      type: 'commonjs',
+      syntax: 'es6+',
+      tsconfigPath,
+    });
+
+    expect.addSnapshotSerializer({
+      test: val => typeof val === 'string' && val.includes('modern-js'),
+      print: val =>
+        // eslint-disable-next-line no-nested-ternary
+        typeof val === 'string'
+          ? val.includes('node_modules')
+            ? `"${val.replace(/.+node_modules/, '')}"`
+            : `"${val.replace(/.+modern-js/, '')}"`
+          : (val as string),
+    });
+
+    expect(config).toMatchSnapshot();
+  });
+});

package/tests/fixtures/api/_app.ts

@@ -0,0 +1,5 @@
+import { hook } from '../../..';
+
+export default hook(({ addMiddleware }) => {
+  addMiddleware('@koa/api');
+});

package/tests/fixtures/api/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "declaration": false,
+    "jsx": "preserve",
+    "baseUrl": "./",
+    "isolatedModules": true,
+    "experimentalDecorators": true,
+    "esModuleInterop": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src", "api", "server", "electron"]
+}

package/tests/fixtures/server/index.ts

@@ -0,0 +1,5 @@
+import { hook } from '../../..';
+
+export default hook(({ addMiddleware }) => {
+  addMiddleware('@koa/web');
+});