build-scripts-2.0.0

.eslintignore

@@ -6,18 +6,6 @@ expected
 website
 gh-pages
 vendors
-packages/build-scripts/test
-packages/template-plugin/tests
-packages/build-scripts/bin
-packages/build-scripts/lib
-packages/build-plugin-store/lib
-packages/build-plugin-ice-router/lib
-packages/build-plugin-ice-stark-child/lib
-packages/build-plugin-env-config/lib
-packages/build-plugin-webpack5/lib
-packages/build-plugin-rml/lib
-packages/build-plugin-stark-module/lib
-packages/build-plugin-stark-module/test
-packages/template-component-demo/lib
-packages/template-component-demo/es
 examples
+__tests__
+lib

.eslintrc.js

@@ -1,38 +1,9 @@
-const { eslint, tslint, deepmerge } = require('@ice/spec');
+const { getESLintConfig } = require('@iceworks/spec');
 
-const commonRules = {
-  'global-require': 0,
-  'import/no-dynamic-require': 0,
-  'no-restricted-syntax': ['error', "BinaryExpression[operator='of']"],
-  'import/order': 0,
-};
-
-const jsRules = deepmerge(eslint, {
+module.exports = getESLintConfig('react-ts', {
   rules: {
-    ...commonRules,
+    'no-async-promise-executor': 'off',
+    '@iceworks/best-practices/recommend-polyfill': 'off',
+    '@typescript-eslint/no-invalid-void-type': 'off',
   },
 });
-
-const tsRules = deepmerge(tslint, {
-  rules: {
-    ...commonRules,
-    '@typescript-eslint/explicit-function-return-type': [
-      'warn',
-      {
-        allowTypedFunctionExpressions: true,
-      },
-    ],
-  },
-});
-
-delete tsRules.root;
-
-module.exports = {
-  ...jsRules,
-  overrides: [
-    {
-      ...tsRules,
-      files: ['**/*.ts', '**/*.tsx'],
-    },
-  ],
-};

.github/workflows/ci.yml

@@ -12,12 +12,20 @@ jobs:
       - uses: actions/checkout@v2
       - name: Set branch name
         run: echo >>$GITHUB_ENV BRANCH_NAME=${GITHUB_REF#refs/heads/}
+
       - name: Echo branch name
         run: echo ${BRANCH_NAME}
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
           registry-url: https://registry.npmjs.org/
-      - run: npm run setup
-      - run: npm run test
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 6
+
+      - run: pnpm run setup
+      - run: pnpm run test

.gitignore

@@ -41,3 +41,4 @@ examples/react-component/es
 packages/template-component-demo/lib
 packages/template-component-demo/es
 
+.pnpm-debug.log

README.md

@@ -26,7 +26,6 @@
 
 - 完善灵活的插件能力，帮助扩展不同工程构建的场景
 - 提供多构建任务机制，支持同时构建多份产物
-- 基于 webpack-chain 提供灵活的自定义 webpack 配置能力
 - 标准化构建&调试的完整流程，同时提供 Hook 能力进行定制
 - 已支持多种场景：
   - React 项目开发
@@ -232,7 +231,6 @@ context 参数包含运行时的各种环境信息：
 - `originalUserConfig` 用户在 build.json 中配置的原始内容
 - `userConfig` 用户配置，包含被 modifyUserConfig 修改后的结果
 - `pkg` 项目 package.json 的内容
-- `webpack` webpack 实例，插件中针对 webpack 的逻辑均使用此方式引入
 
 ```js
 module.exports = ({ context }) => {
@@ -242,9 +240,9 @@ module.exports = ({ context }) => {
 };
 ```
 
-#### onGetWebpackConfig
+#### onGetConfig
 
-通过 `onGetWebpackConfig` 获取 [webpack-chain](https://github.com/neutrinojs/webpack-chain) 形式的配置，并对配置进行自定义修改：
+通过 `onGetConfig` 获取通过 [registerTask](#registerTask) 注册的配置，并对配置进行自定义修改：
 
 ```js
 // 场景一：修改所有 webpack 配置
@@ -255,15 +253,15 @@ module.exports = ({ onGetWebpackConfig }) => {
 }
 
 // 场景二：多 webpack 任务情况下，修改指定任务配置
-module.exports = ({onGetWebpackConfig, registerTask}) => {
+module.exports = ({onGetConfig, registerTask}) => {
   registerTask('web', webpackConfigWeb);
   registerTask('weex', webpackConfigWeex);
 
-  onGetWebpackConfig('web'，(config) => {
+  onGetConfig('web'，(config) => {
     config.entry('src/index');
   });
 
-  onGetWebpackConfig('weex'，(config) => {
+  onGetConfig('weex'，(config) => {
     config.entry('src/app');
   });
 }
@@ -329,7 +327,7 @@ module.exports = ({ log }) => {
 
 通过 registerUserConfig 注册 build.json 中的顶层配置字段，注册是可以进行用户字段校验，支持传入单个配置对象或者包含多个配置对象的数组。
 
-方法生效的生命周期，在 registerTask 和 onGetWebpackConfig 之间。
+方法生效的生命周期，在 registerTask 和 onGetConfig 之间。
 
 配置对象字段如下：
 
@@ -346,11 +344,11 @@ module.exports = ({ log }) => {
 
 配置忽略指定 webpack 任务
 
-- configWebpack(function)
+- setConfig(function)
 
 字段效果，具体作用到 webpack 配置上，接收参数：
 
-- config：webpack-chain 形式的配置
+- config：通过 registerTask 注册的配置
 - value: build.json 中的字段值
 - context：与外部 context 相同，新增字段 taskName 表现当前正在修改的 task
 
@@ -570,6 +568,12 @@ module.exports = ({ applyMethod }) => {
 
 ## 版本升级
 
+### 1.x -> 2.x
+
+2.x 的核心变化：
+
+- 与 webpack 整体解耦，沉淀为插件开发服务
+
 ### 0.x -> 1.x
 
 1.x 核心变化：

package.json

@@ -4,8 +4,9 @@
     "packages/*"
   ],
   "scripts": {
+    "preinstall": "npx only-allow pnpm",
     "clean": "rm -rf node_modules ./packages/*/node_modules",
-    "setup": "npm run clean && yarn install --registry=https://registry.npm.taobao.org && lerna bootstrap --registry=https://registry.npm.taobao.org",
+    "setup": "npm run clean && pnpm i --registry=https://registry.npmmirror.com",
     "lint": "eslint --cache --quiet --ext .js,.ts ./",
     "lint-fix": "eslint --cache --ext .js,.ts ./ --fix",
     "prettier": "prettier --write '**/*.{js,jsx,tsx,ts,less,md,json}'",
@@ -21,11 +22,11 @@
   "devDependencies": {
     "@commitlint/cli": "^7.5.2",
     "@commitlint/config-conventional": "^7.5.0",
-    "@ice/spec": "^0.1.4",
-    "eslint": "^6.0.1",
+    "@iceworks/spec": "^1.5.0",
+    "build-scripts": "workspace:*",
+    "eslint": "^7.31.0",
     "husky": "^1.3.1",
-    "lerna": "^3.16.4",
-    "prettier": "^1.19.1",
-    "typescript": "^3.7.4"
+    "stylelint": "^10.1.0",
+    "typescript": "^4"
   }
 }

packages/build-scripts/__tests__/configFiles.test.ts

@@ -0,0 +1,36 @@
+import { createContext } from '../src/Context'
+import path = require('path')
+
+describe('load js config', () => {
+  it('combine basic config', async () => {
+    const context = await createContext({
+      args: {},
+      command: 'start',
+      rootDir: path.join(__dirname, 'fixtures/jsConfig/')
+    });
+
+    expect(context.userConfig.entry).toEqual('src/index');
+  });
+});
+
+describe('load ts config', () => {
+  it('combine basic config', async () => {
+    const context = await createContext({
+      args: {},
+      command: 'start',
+      rootDir: path.join(__dirname, 'fixtures/tsConfig/')
+    });
+    expect(context.userConfig.entry).toEqual('src/index');
+  });
+});
+
+describe('load mix config', () => {
+  it('combine basic config', async () => {
+    const context = await createContext({
+      args: {},
+      command: 'start',
+      rootDir: path.join(__dirname, 'fixtures/mixConfig/')
+    });
+    expect(context.userConfig.entry).toEqual('src/index.ts');
+  });
+});

packages/build-scripts/__tests__/createContext.test.ts

@@ -0,0 +1,20 @@
+import { createContext } from '../src/Context'
+import path = require('path')
+
+describe('create-context', () => {
+  it('basic', async () => {
+    const context = await createContext({
+      args: {
+        https: true
+      },
+      command: 'start',
+      rootDir: path.join(__dirname, 'fixtures/basic/')
+    });
+
+    // 验证 registerUserConfig
+    expect(context.userConfig.entry).toEqual('src/index');
+
+    // 验证 registerCliOption
+    expect(context.commandArgs.https).toBeTruthy();
+  });
+});

packages/build-scripts/__tests__/fixtures/basic/build.json

@@ -0,0 +1,6 @@
+{
+  "entry": "src/index",
+  "plugins": [
+    "./plugin.js"
+  ]
+}

packages/build-scripts/__tests__/fixtures/basic/plugin.js

@@ -0,0 +1,18 @@
+module.exports = ({
+  registerUserConfig,
+  registerCliOption,
+}) => {
+  registerUserConfig([
+    {
+      name: 'entry',
+      validation: 'string'
+    }
+  ]);
+
+  registerCliOption([
+    {
+      name: 'https',
+      commands: ['start', 'build']
+    }
+  ])
+}

packages/build-scripts/__tests__/fixtures/jsConfig/build.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  entry: 'src/index',
+  plugins: [
+    './plugin.js'
+  ]
+};

packages/build-scripts/__tests__/fixtures/jsConfig/plugin.js

@@ -0,0 +1,8 @@
+module.exports = ({ registerUserConfig }) => {
+  registerUserConfig([
+    {
+      name: 'entry',
+      validation: 'string'
+    }
+  ]);
+}

packages/build-scripts/__tests__/fixtures/mixConfig/build.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  entry: 'src/index.js',
+  plugins: [
+    "./plugin.js"
+  ]
+};

packages/build-scripts/__tests__/fixtures/mixConfig/build.json

@@ -0,0 +1,6 @@
+{
+  "entry": "src/index.ts",
+  "plugins": [
+    "./plugin.js"
+  ]
+}

packages/build-scripts/__tests__/fixtures/mixConfig/plugin.js

@@ -0,0 +1,8 @@
+module.exports = ({ registerUserConfig }) => {
+  registerUserConfig([
+    {
+      name: 'entry',
+      validation: 'string'
+    }
+  ]);
+}

packages/build-scripts/test/fixtures/tsConfig/build.config.ts → packages/build-scripts/__tests__/fixtures/tsConfig/build.config.ts

@@ -1,9 +1,11 @@
 interface Config {
   entry: string;
+  plugins: string[];
 }
 
 const config: Config = {
   entry: 'src/index',
+  plugins: ['./plugin.js']
 };
 
 export default config;

packages/build-scripts/__tests__/fixtures/tsConfig/plugin.js

@@ -0,0 +1,8 @@
+module.exports = ({ registerUserConfig }) => {
+  registerUserConfig([
+    {
+      name: 'entry',
+      validation: 'string'
+    }
+  ]);
+}

packages/build-scripts/test/loadConfig.test.ts → packages/build-scripts/__tests__/loadConfig.test.ts

@@ -1,29 +1,31 @@
 import * as path from 'path';
-import loadConfig from '../src/utils/loadConfig';
-import log = require('../src/utils/log');
+import { loadConfig } from '../src/utils/loadConfig';
+import { createLogger } from '../src/utils/logger';
+
+const logger = createLogger();
 
 interface IUserConfig {
   entry: string;
 }
 
 describe('load config file', () => {
   it('json file', async () => {
-    const userConfig = await loadConfig<IUserConfig>(path.join(__dirname, './configFile/config.json'), log);
+    const userConfig = await loadConfig<IUserConfig>(path.join(__dirname, './configFile/config.json'), logger);
     expect(userConfig.entry).toBe('src/json.js');
   })
 
   it('js file', async () => {
-    const userConfig = await loadConfig<IUserConfig>(path.join(__dirname, './configFile/config.js'), log);
+    const userConfig = await loadConfig<IUserConfig>(path.join(__dirname, './configFile/config.js'), logger);
     expect(userConfig.entry).toBe('src/config.js');
   })
 
   it('ts file', async () => {
-    const userConfig = await loadConfig<IUserConfig>(path.join(__dirname, './configFile/config.ts'), log);
+    const userConfig = await loadConfig<IUserConfig>(path.join(__dirname, './configFile/config.ts'), logger);
     expect(userConfig.entry).toBe('src/tsFile.ts');
   })
 
   it('esm file', async () => {
-    const userConfig = await loadConfig<IUserConfig>(path.join(__dirname, './configFile/esmConfig.js'), log);
+    const userConfig = await loadConfig<IUserConfig>(path.join(__dirname, './configFile/esmConfig.js'), logger);
     expect(userConfig.entry).toBe('src/mjsFile.mjs');
   })
 });