sugar-scripts 0.2.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# sugar-scripts
+
+## 0.2.0-beta.0
+
+### Minor Changes
+
+- sugar-scripts 添加统一 running-context，命令都基于此运行
+
+### Patch Changes
+
+- 5101c4b: 添加 sugar-scripts，改造为基于 pnpm 的 monorepo
+  sugar-server 移除 server，整合为 application
+- Updated dependencies
+- Updated dependencies [5101c4b]
+  - sugar-scripts@0.2.0-beta.0
+  - sugar-server@0.2.0-beta.0
+
+## 1.0.1
+
+### Patch Changes
+
+- 5101c4b: 添加 sugar-scripts，改造为基于 pnpm 的 monorepo
+  sugar-server 移除 server，整合为 application
+- Updated dependencies [5101c4b]
+  - sugar-scripts@1.0.1
+  - sugar-server@0.1.16

package/README.md

@@ -0,0 +1,64 @@
+## 配置文件
+1. `sugar.project.ts`
+2. `sugar.package.ts`
+3. `sugar.build.ts`
+
+
+#### sugar.project.ts 配置文件
+```ts
+import type {
+  types
+} from 'sugar-scripts';
+
+// 待定
+```
+
+
+#### sugar.package.js 配置文件
+```ts
+import type {
+  types
+} from 'sugar-scripts';
+
+export const packageConfig: types.PackageConfig;
+```
+
+
+
+
+#### sugar.build.js 配置文件
+```ts
+import type {
+  types
+} from 'sugar-scripts';
+
+export const browserWebpackConfig: types.CustomWebpackConfig;
+
+export const serverWebpackConfig: types.CustomWebpackConfig;
+```
+
+
+## sugar-scripts cli
+
+### start
+```bash
+sugar-scripts start xxx.ts --port 9000
+```
+
+### info
+```bash
+sugar-scripts info
+```
+
+### build
+```bash
+sugar-scripts build
+```
+
+
+### cache
+```bash
+sugar-scripts cache
+```
+
+

package/bin/cli-ts.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env ts-node
+
+require('../src/commander');

package/bin/cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../lib/commander');

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "sugar-scripts",
+  "version": "0.2.0-beta.0",
+  "description": "",
+  "main": "lib/index.js",
+  "bin": {
+    "sugar-scripts": "./bin/cli.js"
+  },
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "babel-loader": "^8.0.6",
+    "chalk": "~4.1.2",
+    "commander": "^8.1.0",
+    "glob": "~7.2.0",
+    "koa-send": "~5.0.1",
+    "sugar-scripts": "^0.2.0-beta.0",
+    "sugar-server": "^0.2.0-beta.0",
+    "ts-loader": "^9.3.0",
+    "ts-node": "^10.4.0",
+    "webpack": "^5",
+    "webpack-chain": "~6.5.1",
+    "webpack-manifest-plugin": "^3.2.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.7.0",
+    "@babel/node": "^7.7.0",
+    "@babel/plugin-proposal-class-properties": "^7.7.0",
+    "@babel/plugin-proposal-decorators": "^7.7.0",
+    "@babel/plugin-proposal-object-rest-spread": "^7.7.4",
+    "@babel/plugin-transform-arrow-functions": "^7.7.4",
+    "@babel/plugin-transform-runtime": "^7.8.3",
+    "@babel/preset-env": "^7.7.0",
+    "@babel/preset-react": "^7.7.0",
+    "@babel/preset-typescript": "^7.7.4",
+    "@babel/runtime": "^7.8.3",
+    "@babel/runtime-corejs3": "^7.8.3",
+    "@types/glob": "~7.2.0",
+    "@types/koa-send": "~4.1.3",
+    "@types/node": "^18.0.0",
+    "@types/webpack": "^5",
+    "babel-loader": "^8.0.6",
+    "babel-plugin-parameter-decorator": "^1.0.16",
+    "typescript": "^4.3.5"
+  },
+  "peerDependencies": {
+    "ts-loader": "^9.3.0"
+  },
+  "scripts": {
+    "clean": "rm -fr lib",
+    "build": "npm run clean && tsc"
+  }
+}

package/src/app-utils/index.ts

@@ -0,0 +1 @@
+export * from './static';

package/src/app-utils/static.ts

@@ -0,0 +1,42 @@
+import send from 'koa-send';
+
+import {
+  router,
+  parameter,
+  Controller
+} from 'sugar-server';
+
+const { GetRoute } = router;
+
+export function createStaticController ({
+  staticResourcesPath,
+  prefix = '/'
+}: {
+  staticResourcesPath: string,
+  prefix?: string;
+}): typeof Controller {
+  class StaticController extends Controller {
+    static prefix = prefix;
+
+    @GetRoute('*')
+    @parameter.getter
+    async status (
+      @parameter.Context ctx: any
+    ) {
+      const routerPath = ctx.routerPath || ctx.path;
+      const filePath = routerPath.substr(prefix.length);
+
+      if (filePath) {
+        await send(
+          ctx,
+          filePath,
+          {
+            root: staticResourcesPath,
+            maxAge: 86400000
+          });
+      }
+    }
+  }
+
+  return StaticController;
+}

package/src/commander/index.ts

@@ -0,0 +1,95 @@
+import path from 'path';
+import chalk from 'chalk';
+import { Command } from 'commander';
+
+import {
+  initRunningContext
+} from '../core/init-running-context';
+import {
+  build
+} from '../core/build';
+import {
+  info
+} from '../core/info';
+import {
+  clean as cacheClean
+} from '../core/cache';
+import {
+  runApplication
+} from '../core/run-application';
+
+const program = new Command();
+program
+  .version('1.0.0');
+
+program
+  .command('info')
+  .description('工程信息')
+  .option('--dir <dir>', '自定义运行的目录')
+  .action(async (options, command) => {
+    const cwd = process.cwd();
+    const dir = options.dir ? path.resolve(cwd, options.dir) : cwd
+    // process.exit();
+  })
+
+program
+  .command('build')
+  .description('构建服务')
+  .option('--dir <dir>', '自定义运行的目录')
+  .action(async (options, command) => {
+    const cwd = process.cwd();
+    const dir = options.dir ? path.resolve(cwd, options.dir) : cwd
+
+    const context = await initRunningContext(dir);
+    await build(
+      context
+    );
+    console.log(`✅ ${chalk.bold.green('构建成功')}`);
+  })
+
+
+const cacheCommand = new Command();
+cacheCommand
+  .name('cache')
+  .description('构建缓存管理');
+
+cacheCommand
+  .command('clean')
+  .description('清理构建缓存')
+  .option('--dir <dir>', '自定义运行的目录')
+  .action(async (options, command) => {
+    const cwd = process.cwd();
+    const dir = options.dir ? path.resolve(cwd, options.dir) : cwd;
+    const context = await initRunningContext(dir);
+    await cacheClean(context);
+    console.log(`✅ ${chalk.bold.green('清理构建缓存成功')}`);
+  })
+
+program.addCommand(cacheCommand)
+
+program
+  .command('start')
+  .description('启动开发服务')
+  .option('--dir <dir>', '自定义运行的目录')
+  .option('--port <port>', '指定运行的端口')
+  .action(async (options, command) => {
+    const cwd = process.cwd();
+    const dir = options.dir ? path.resolve(cwd, options.dir) : cwd
+    const port = +options.port;
+
+    const context = await initRunningContext(dir);
+    const appFilePath = context.getStartFilePath()
+
+    if (!appFilePath) return;
+    const App = require(
+      appFilePath
+    ).default;
+
+    runApplication(
+      App,
+      port
+    );
+    console.log(`✅ ${chalk.bold.green(`启动服务成功，端口:${port}`)}`);
+  })
+
+program.parse(process.argv);

package/src/configs/babel.server.config.ts

@@ -0,0 +1,42 @@
+const path = require('path');
+
+export const babelConfig = {
+  presets: [
+    [
+      '@babel/preset-typescript',
+      {
+        'onlyRemoveTypeImports': true
+      }
+    ],
+    ['@babel/preset-react'],
+    [
+      '@babel/preset-env',
+      {
+        loose: true,
+        targets: {
+          node: 'current'
+        }
+      }
+    ]
+  ],
+  plugins: [
+    // [
+    //   '@babel/plugin-transform-runtime',
+    //   {
+    //     corejs: 3,
+    //     regenerator: true
+    //   }
+    // ],
+    '@babel/plugin-transform-arrow-functions',
+    '@babel/plugin-proposal-object-rest-spread',
+    [
+      '@babel/plugin-proposal-decorators',
+      { legacy: true }
+    ],
+    [
+      '@babel/plugin-proposal-class-properties',
+      { loose: true }
+    ],
+    ['babel-plugin-parameter-decorator']
+  ]
+}

package/src/configs/babel.static.config.ts

@@ -0,0 +1,43 @@
+export const babelConfig = {
+  presets: [
+    ['@babel/preset-typescript'],
+    ['@babel/preset-react'],
+    [
+      '@babel/preset-env',
+      {
+        loose: true,
+        targets: {
+          chrome: '58',
+          ie: '11'
+        }
+        // useBuiltIns: "entry"
+        // corejs: false
+      }
+    ]
+  ],
+  plugins: [
+    [
+      '@babel/plugin-transform-runtime',
+      {
+        // "corejs": 3,
+        // polyfill: false,
+        corejs: false,
+        regenerator: true
+      }
+    ],
+    '@babel/plugin-transform-arrow-functions',
+    '@babel/plugin-proposal-object-rest-spread',
+    [
+      '@babel/plugin-proposal-decorators',
+      {
+        legacy: true
+      }
+    ],
+    [
+      '@babel/plugin-proposal-class-properties',
+      {
+        loose: true
+      }
+    ]
+  ]
+}

package/src/constants/index.ts

@@ -0,0 +1,5 @@
+export const SUGAR_PACKAGE_CONFIG_FILENAME = 'sugar.package';
+export const SUGAR_PROJECT_CONFIG_FILENAME = 'sugar.project';
+
+export const SUGAR_BUILD_EXPORT_BROWSER = 'browserWebpackConfig';
+export const SUGAR_BUILD_EXPORT_SERVER = 'serverWebpackConfig';

package/src/core/build.ts

@@ -0,0 +1,98 @@
+import path from 'path';
+import * as tsNode from 'ts-node';
+
+import {
+  SugarScriptsContext
+} from './running-context';
+
+import {
+  mergeBrowserEntryFromServer,
+  mergeBuildDllConfig,
+  mergeBrowserCustomConfig
+} from '../webpack/webpack.browser';
+import {
+  mergeServerEntry,
+  mergeServerCustomConfig
+} from '../webpack/webpack.server';
+import {
+  createCommonChainConfig,
+  mergeDllReferences
+} from '../webpack/webpack.common';
+import {
+  runWebpack
+} from '../webpack/run-webpack';
+
+
+export const build = async (
+  context: SugarScriptsContext
+) => {
+  tsNode.register({
+    cwd: context.root,
+    projectSearchDir: context.root,
+    project: path.resolve(context.root, './tsconfig.json'),
+    transpileOnly: true
+  })
+
+  await buildBrowser(
+    context
+  )
+
+  await buildServer(
+    context
+  )
+}
+
+const buildBrowser = async (context: SugarScriptsContext) => {
+  if (!context.packageConfig.browser) return;
+  const browserConfig = context.packageConfig.browser;
+
+  const chainConfig = await createCommonChainConfig(
+    context,
+    browserConfig.output
+  );
+
+  await mergeBrowserEntryFromServer(
+    context,
+    chainConfig
+  )
+
+  // 合并其他已经构建好的dll
+  await mergeDllReferences(
+    context,
+    chainConfig,
+  )
+
+  // 如果是dll
+  await mergeBuildDllConfig(
+    context,
+    chainConfig
+  )
+
+  await mergeBrowserCustomConfig(
+    context,
+    chainConfig
+  )
+
+  await runWebpack(chainConfig);
+}
+
+
+const buildServer = async (context: SugarScriptsContext) => {
+  if (!context.packageConfig.server) return;
+  const serverConfig = context.packageConfig.server;
+
+  const chainConfig = await createCommonChainConfig(
+    context,
+    serverConfig.output
+  );
+
+  await mergeServerEntry(
+    context,
+    chainConfig
+  );
+  await mergeServerCustomConfig(
+    context,
+    chainConfig
+  );
+  await runWebpack(chainConfig);
+}

package/src/core/cache.ts

@@ -0,0 +1,15 @@
+import path from 'path';
+import {
+  SugarScriptsContext
+} from './running-context';
+import {
+  rm
+} from '../shared/file-helpers';
+
+export const clean = (
+  context: SugarScriptsContext
+) => {
+  return rm(
+    context.getCacheDir()
+  );
+}

package/src/core/entry.ts

@@ -0,0 +1,189 @@
+import path from 'path';
+import {
+  Application,
+  Controller,
+  ControllerContext
+} from 'sugar-server';
+
+import {
+  CustomRender
+} from '../custom-config.type';
+
+export const ENTRIES_KEY = Symbol('_sugar_entries');
+export const ENTRIES_CONFIG_KEY = Symbol('_sugar_entries_config');
+
+export interface EntryConfig {
+  filePath: string
+}
+
+export interface EntriesController extends Controller {
+  [ENTRIES_KEY]: EntryConfig[]
+}
+
+const defaultRender: CustomRender = (
+  ctx,
+  entries,
+  custom
+) => {
+  return entries.toString();
+}
+
+const render: CustomRender = (
+  ...args
+) => {
+  let currentRender = defaultRender;
+  console.log('SUGAR_PROJECT_RENDER', process.env.SUGAR_PROJECT_RENDER)
+  if (process.env.SUGAR_PROJECT_RENDER) {
+    try {
+      currentRender = require(process.env.SUGAR_PROJECT_RENDER).default;
+      console.log('load custom render success');
+    } catch (e) {}
+  }
+  return currentRender(
+    ...args
+  )
+}
+
+// discuss：需要string[] 吗？
+export type RegisterFilePath = string | {[key: string]: string}
+
+export function register (
+  filePath: RegisterFilePath
+) {
+  return function (
+    target: Controller,
+    key: string,
+    descriptor: PropertyDescriptor
+  ) {
+    if (!Object.getOwnPropertyDescriptor(target, ENTRIES_KEY)) {
+      Object.defineProperty(target, ENTRIES_KEY, {
+        configurable: true,
+        enumerable: false,
+        writable: true,
+        value: []
+      })
+    }
+
+    if (typeof filePath === 'string') {
+      (target as EntriesController)[ENTRIES_KEY].push({
+        filePath
+      })
+    } else {
+      Object.keys(filePath).forEach((filePathKey) => {
+        const oneFilePath = filePath[filePathKey];
+        (target as EntriesController)[ENTRIES_KEY].push({
+          filePath: oneFilePath
+        })
+      })
+    }
+
+    const oldValue = descriptor.value;
+    descriptor.value = async function (
+      ctx: ControllerContext,
+      ...args: any
+    ) {
+      // ctx.app
+      let oldResult;
+      if (oldValue) {
+        oldResult = await oldValue.call(this, ...args);
+      }
+
+      let envEntries = ENV_ENTRIES;
+      if (
+        (ctx.app.constructor as any).ENTRIES
+      ) {
+        envEntries = (ctx.app.constructor as any).ENTRIES;
+      }
+      console.log('envEntries', envEntries, ENV_ENTRIES )
+
+      let entries: string[] | {[key: string]: string[]} = [];
+      if (typeof filePath === 'string') {
+        entries = envEntries[filePath] || [];
+      } else {
+        entries = Object.keys(filePath).reduce((
+          currentEntries,
+          filePathKey
+          ) => {
+            const oneFilePath = filePath[filePathKey];
+            currentEntries[filePathKey] = envEntries[oneFilePath];
+            return currentEntries;
+          }, {} as {[key: string]: string[]})
+      }
+
+      console.log(
+        'will search file',
+        envEntries,
+        filePath,
+        entries
+      )
+
+      return render(
+        ctx,
+        entries,
+        oldResult
+      );
+    }
+  }
+}
+
+export const ENTRY_WEBPACK_INJECT_KEY = 'ENTRY_WEBPACK_INJECT_KEY';
+
+export const ENV_ENTRIES = (process.env.SUGAR_PROJECT_ENTRIES || {}) as {
+  [entryKey: string]: string[]
+};
+
+export function getEntryUrl (
+  filePath: string
+) {
+  return '';
+}
+
+export function getEntries (
+  dirname: string
+) {
+ let entries = {};
+
+ require(
+   path.resolve(
+     dirname,
+     ''
+   )
+ )
+}
+
+export function getEntriesFromController (
+  controller: Controller
+) {
+  return (controller as EntriesController)[ENTRIES_KEY] || [];
+}
+
+export function getEntriesFromControllers (
+  controllers: Controller[],
+  root: string
+) {
+  const entries: {
+    [key: string]: string
+  } = {};
+  controllers.forEach(
+    (controller) => {
+      getEntriesFromController(controller).forEach(({ filePath }) => {
+        entries[filePath] = path.resolve(
+          root,
+          filePath
+        )
+      })
+    }
+  )
+  return entries;
+}
+
+export function getEntriesFromApplicationClass (
+  ApplicationClass: typeof Application,
+  root: string
+) {
+  const app = new ApplicationClass();
+  return getEntriesFromControllers(
+    app.controllers,
+    root
+  )
+}

package/src/core/info.ts

@@ -0,0 +1,5 @@
+import {
+  router
+} from 'sugar-server';
+
+export const info = () => {}