feat: build support auto-sorting & filter for lerna project (umijs#393)

* chore: add yarn workspaces

* feat: add getLernaPackages

* feat: getLernaPackages replace getPackages

* feat: 支持配置getLernaPackages参数

* chore: update lerna.json

* feat: schema add filterPkgs

* test: 修复测试报错

* feat: filterPkgs rename pkgFilter

* feat: getLernaPackages remove stream option

* test: 修复测试报错

* feat: showPrivate => buildPrivate

* docs: add pkgFilter doc

* docs: 统一文档注释格式

* style: update comment style

* feat: buildPrivate >> skipPrivate

Co-authored-by: Peach <scdzwyxst@gmail.com>

README.md

@@ -639,8 +639,61 @@ export default {
 };
 ```
 
+### pkgFilter
+
+在 lerna 构建中，有需要对包进行过滤的需求
+
+可配置项如下:
+
+```ts
+{
+  /** 
+   * 指定包含的包 
+   */
+  include?: string[];
+  /** 
+   * 指定排除的包 
+   */
+  exclude?: string[];
+  /**
+   * 是否跳过私有的包 package.json private
+   * @default false
+   */
+  skipPrivate?: boolean;
+}
+```
+
+`pkgFilter` 允许自定义排除/包含部分包，只对过滤后的包进行构建
+
+例如: 存在  `@umi/util-1`、`@umi/util-2`、`@umi/core`、`@umi/test`(private) 多个包
+
+```ts
+// 只构建 `@umi/util-1`、`@umi/util-2`
+export default {
+  pkgFilter: {
+    include: ['@umi/util-*']
+  }
+}
+
+// 只构建 `@umi/util-1`、`@umi/core`、`@umi/test`
+export default {
+  pkgFilter: {
+    exclude: ['@umi/util-2']
+  }
+}
+
+// 只构建 `@umi/util-1`、`@umi/util-2`、`@umi/core`
+export default {
+  pkgFilter: {
+    skipPrivate: true
+  }
+}
+```
+
 ### pkgs
 
+**已提供根据依赖自动排序的功能，除非有特殊需求定制构建顺序的，此配置项可忽略**
+
 在 lerna 构建中，有可能出现组件间有构建先后的需求，比如在有两个包 `packages/father-a` 和 `packages/father-util`，在 `father-a` 中对 `father-util` 有依赖，此时需要先构建 `father-util` 才能保证构建的正确性
 
 `pkgs` 允许你自定义 packages 目录下的构建顺序，如以上场景对应的配置为

packages/father-build/package.json

@@ -23,7 +23,9 @@
     "@babel/preset-react": "7.12.1",
     "@babel/preset-typescript": "7.12.1",
     "@babel/register": "7.12.1",
-    "@lerna/project": "^3.21.0",
+    "@lerna/filter-packages": "4.0.0",
+    "@lerna/project": "4.0.0",
+    "@lerna/query-graph": "4.0.0",
     "@rollup/plugin-babel": "5.2.1",
     "@rollup/plugin-commonjs": "16.0.0",
     "@rollup/plugin-inject": "4.0.2",

packages/father-build/src/build.ts

@@ -5,12 +5,11 @@ import * as assert from 'assert';
 import { merge } from 'lodash';
 import signale from 'signale';
 import chalk from 'chalk';
-import { getPackages } from '@lerna/project';
 import { IOpts, IBundleOptions, IBundleTypeOutput, ICjs, IEsm, Dispose } from './types';
 import babel from './babel';
 import rollup from './rollup';
 import registerBabel from './registerBabel';
-import { getExistFile } from './utils';
+import { getExistFile, getLernaPackages } from './utils';
 import getUserConfig, { CONFIG_FILES } from './getUserConfig';
 import randomColor from "./randomColor";
 
@@ -194,7 +193,7 @@ export async function buildForLerna(opts: IOpts) {
 
   const userConfig = merge(getUserConfig({ cwd }), rootConfig, buildArgs);
 
-  let pkgs = await getPackages(cwd);
+  let pkgs = await getLernaPackages(cwd, userConfig.pkgFilter);
 
   // support define pkgs in lerna
   // TODO: 使用lerna包解决依赖编译问题

packages/father-build/src/fixtures/build/lerna-pkgs/core/bar/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "bar"
+}

packages/father-build/src/fixtures/build/lerna-pkgs/core/foo/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "foo"
+}

packages/father-build/src/fixtures/build/lerna-root-config-override/packages/bar/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "bar"
+}

packages/father-build/src/fixtures/build/lerna-root-config-override/packages/foo/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "foo"
+}

packages/father-build/src/fixtures/build/lerna-root-config/packages/bar/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "bar"
+}

packages/father-build/src/fixtures/build/lerna-root-config/packages/foo/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "foo"
+}

packages/father-build/src/fixtures/build/lerna-root-scope/packages/bar/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "bar"
+}

packages/father-build/src/fixtures/build/lerna-root-scope/packages/foo/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "foo"
+}

packages/father-build/src/fixtures/build/lerna-root-tsconfig/packages/bar/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "bar"
+}

packages/father-build/src/fixtures/build/lerna-root-tsconfig/packages/foo/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "foo"
+}

packages/father-build/src/fixtures/build/lerna-scope-packages/packages/@hoo/bar/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "@hoo/bar"
+}

packages/father-build/src/fixtures/build/lerna-scope-packages/packages/foo/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "foo"
+}

packages/father-build/src/fixtures/build/lerna/packages/bar/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "bar"
+}

packages/father-build/src/fixtures/build/lerna/packages/foo/package.json

@@ -1 +1,3 @@
-{}
+{
+  "name": "foo"
+}

packages/father-build/src/schema.test.ts

@@ -23,6 +23,7 @@ const successValidates = {
   doc: [{}],
   typescriptOpts: [{}],
   pkgs: [[]],
+  pkgFilter: [{}],
 };
 
 Object.keys(successValidates).forEach(key => {

packages/father-build/src/schema.ts

@@ -165,5 +165,8 @@ export default {
     pkgs: {
       type: 'array',
     },
+    pkgFilter: {
+      type: 'object',
+    },
   },
 };

packages/father-build/src/types.d.ts

@@ -83,6 +83,18 @@ export interface IBundleOptions {
     [opt: string]: any
   };
   pkgs?: string[];
+  /** 处理 lerna 包 */
+  pkgFilter?: {
+    /** 指定包含的包 */
+    include?: string[];
+    /** 指定排除的包 */
+    exclude?: string[];
+    /**
+     * 跳过私有的包 package.json private
+     * @default false
+     * */
+    skipPrivate?: boolean;
+  }
 }
 
 export interface IOpts {

packages/father-build/src/utils/getLernaPackages/fixtures/customize/core/core1/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "core1",
+  "version": "1.0.0",
+  "dependencies": {
+    "foo": "1.0.0"
+  }
+}

packages/father-build/src/utils/getLernaPackages/fixtures/customize/core/core1/src/index.js

@@ -0,0 +1,2 @@
+
+console.log('bar');

packages/father-build/src/utils/getLernaPackages/fixtures/customize/core/core2/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "core2",
+  "private": true,
+  "version": "1.0.0"
+}

packages/father-build/src/utils/getLernaPackages/fixtures/customize/core/core2/src/index.js

@@ -0,0 +1,2 @@
+
+console.log('foo');

packages/father-build/src/utils/getLernaPackages/fixtures/customize/lerna.json

@@ -0,0 +1,6 @@
+{
+  "packages": [
+    "core/*",
+    "packages/*"
+  ]
+}

packages/father-build/src/utils/getLernaPackages/fixtures/customize/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "default-packages",
+  "private": true
+}

packages/father-build/src/utils/getLernaPackages/fixtures/customize/packages/bar/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "bar",
+  "version": "1.0.0"
+}

packages/father-build/src/utils/getLernaPackages/fixtures/customize/packages/bar/src/index.js

@@ -0,0 +1,2 @@
+
+console.log('bar');

packages/father-build/src/utils/getLernaPackages/fixtures/customize/packages/foo/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "foo",
+  "version": "1.0.0",
+  "dependencies": {
+    "bar": "1.0.0"
+  }
+}

packages/father-build/src/utils/getLernaPackages/fixtures/customize/packages/foo/src/index.js

@@ -0,0 +1,2 @@
+
+console.log('foo');

packages/father-build/src/utils/getLernaPackages/fixtures/default/lerna.json

@@ -0,0 +1 @@
+{}

packages/father-build/src/utils/getLernaPackages/fixtures/default/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "default-packages",
+  "private": true
+}

packages/father-build/src/utils/getLernaPackages/fixtures/default/packages/bar/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "bar",
+  "version": "1.0.0"
+}

packages/father-build/src/utils/getLernaPackages/fixtures/default/packages/bar/src/index.js

@@ -0,0 +1,2 @@
+
+console.log('bar');

packages/father-build/src/utils/getLernaPackages/fixtures/default/packages/foo/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "foo",
+  "version": "1.0.0",
+  "dependencies": {
+    "bar": "1.0.0"
+  }
+}

packages/father-build/src/utils/getLernaPackages/fixtures/default/packages/foo/src/index.js

@@ -0,0 +1,2 @@
+
+console.log('foo');

packages/father-build/src/utils/getLernaPackages/index.test.ts

@@ -0,0 +1,83 @@
+import path from 'path';
+import fs from 'fs-extra';
+import { getLernaPackages } from './';
+
+export const FIXTURES_DIR = path.resolve(__dirname, 'fixtures');
+
+export function getDirs() {
+  return fs
+		.readdirSync(FIXTURES_DIR)
+		.filter(fixturePath =>
+			fs.statSync(path.resolve(FIXTURES_DIR, fixturePath)).isDirectory(),
+		);
+}
+
+export function fixture(...args: string[]) {
+  return path.join(FIXTURES_DIR, ...args)
+}
+
+describe('default', () => {
+  const fixturePath = fixture('default');
+
+  it('获取所有的包', async () => {
+    expect.assertions(1);
+
+    const pkgs = await getLernaPackages(fixturePath);
+
+    const pkgNames = ['bar', 'foo'];
+
+    expect(pkgNames).toEqual(pkgs.map(item => item.name));
+  })
+});
+
+describe('customize', () => {
+  const fixturePath = fixture('customize');
+
+  it('获取所有的包', async () => {
+    expect.assertions(1);
+
+    const pkgs = await getLernaPackages(fixturePath, {});
+
+    const pkgNames = ['core2', 'bar', 'foo', 'core1'];
+
+    expect(pkgNames).toEqual(pkgs.map(item => item.name));
+  });
+
+  it('过滤私有的包', async () => {
+    expect.assertions(1);
+
+    const pkgs = await getLernaPackages(fixturePath, {
+      skipPrivate: true,
+    });
+
+    const pkgNames = ['bar', 'foo', 'core1'];
+
+    expect(pkgNames).toEqual(pkgs.map(item => item.name));
+  });
+
+  it('设置包含部分包', async () => {
+    expect.assertions(1);
+
+    const pkgs = await getLernaPackages(fixturePath, {
+      include: [
+        'core*'
+      ]
+    });
+    const pkgNames = ['core1', 'core2'];
+
+    expect(pkgNames).toEqual(pkgs.map(item => item.name));
+  })
+
+  it('设置包含部分包', async () => {
+    expect.assertions(1);
+
+    const pkgs = await getLernaPackages(fixturePath, {
+      exclude: [
+        'core1'
+      ]
+    });
+    const pkgNames = ['core2', 'bar', 'foo'];
+
+    expect(pkgNames).toEqual(pkgs.map(item => item.name));
+  })
+});