@deot/dev-builder 1.1.0

package/README.md

@@ -0,0 +1,14 @@
+# @deot/dev-builder
+
+打包
+
+- 使用`dependencies`，非`peerDependencies`。主要考虑仅安装`@deot/dev-builder`即可
+- 优先执行`scripts`下的`build`和`build:types`，如果声明`build`，打包由用户管理，`build:types`，类型编译由用户管理
+
+
+## 其它
+
+- 目前依赖`rollup`打包，后续考虑读取`rollup.config.js`
+- 如果改成`vite`打包，则考虑读取配置`vite.config.js`
+
+打包输出文件`index.[format].js` + `index.d.ts`

package/dist/index.cjs.js

@@ -0,0 +1,233 @@
+'use strict';
+
+var devShared = require('@deot/dev-shared');
+var path = require('node:path');
+var node_module = require('node:module');
+var fs = require('fs-extra');
+var typescript = require('@rollup/plugin-typescript');
+var pluginNodeResolve = require('@rollup/plugin-node-resolve');
+var commonjs = require('@rollup/plugin-commonjs');
+var replace = require('@rollup/plugin-replace');
+var rollup = require('rollup');
+var apiExtractor = require('@microsoft/api-extractor');
+var chalk = require('chalk');
+var ora = require('ora');
+
+function _interopNamespaceDefault(e) {
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n.default = e;
+    return Object.freeze(n);
+}
+
+var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
+
+const require$ = node_module.createRequire(process.cwd());
+class Build {
+    packageDir;
+    packageName;
+    packageOptions;
+    config;
+    commandOptions;
+    constructor(config, commandOptions) {
+        const { workspace, packageDir, packageName } = devShared.Locals.impl();
+        if (typeof config === 'string') {
+            let packageFolderName = config;
+            let packageDir$ = path__namespace.resolve(packageDir, packageFolderName);
+            let input = fs.existsSync(packageDir$ + '/src/index.ts')
+                ? packageDir$ + '/src/index.ts'
+                : fs.existsSync(packageDir$ + '/src/index.js')
+                    ? packageDir$ + '/src/index.js'
+                    : '';
+            config = {
+                dir: packageDir$,
+                name: packageFolderName || 'index',
+                input,
+                output: [
+                    {
+                        file: packageDir$ + '/dist/index.es.js',
+                        format: 'es',
+                        exports: 'named',
+                        sourcemap: false
+                    },
+                    {
+                        file: packageDir$ + '/dist/index.iife.js',
+                        format: 'iife',
+                        name: packageName,
+                    },
+                    {
+                        file: packageDir$ + '/dist/index.cjs.js',
+                        format: 'cjs'
+                    }
+                ].filter(i => {
+                    return commandOptions.formats.includes(i.format);
+                })
+            };
+        }
+        this.packageDir = path__namespace.resolve(packageDir, workspace ? `./${config.name}` : '');
+        this.packageName = config.name === 'index'
+            ? packageName
+            : `${packageName}-${config.name}`;
+        this.packageOptions = require$(`${this.packageDir}/package.json`);
+        this.config = config;
+        this.commandOptions = commandOptions;
+    }
+    async process() {
+        const { cwd, workspace } = devShared.Locals.impl();
+        const { config, packageOptions, packageName, packageDir } = this;
+        if (workspace
+            && packageOptions?.scripts?.build
+            && packageDir !== cwd) {
+            await devShared.Shell.spawn(`npm`, ['run', 'build'], {
+                cwd: packageDir
+            });
+            return;
+        }
+        if (!config.input)
+            return;
+        const spinner = ora(`${packageName} Build ...`);
+        try {
+            spinner.start();
+            await fs.emptyDir(`${packageDir}/dist`);
+            const stats = await this.buildSources();
+            await this.buildTypes();
+            spinner.stop();
+            devShared.Logger.log(`${chalk.cyan(`${packageName}`)}: ${chalk.green('Success')}`);
+            stats.forEach((stat) => {
+                devShared.Logger.log(`${chalk.green(stat.format.toUpperCase())}: ${devShared.Utils.formatBytes(stat.size)}`);
+            });
+        }
+        catch (e) {
+            devShared.Logger.log('Error!', e);
+            throw e;
+        }
+    }
+    async buildSources() {
+        const { workspace } = devShared.Locals.impl();
+        const { name, input, output } = this.config;
+        const { packageOptions } = this;
+        const external = Object
+            .keys({
+            ...packageOptions.dependencies,
+            ...packageOptions.peerDependencies
+        })
+            .map(i => new RegExp(`^${i}$`));
+        const source = workspace ? `${workspace}/${name}/**/*` : 'src/**/*';
+        const shims = workspace ? `${workspace}/shims.d.ts` : 'shims.d.ts';
+        const outDir = workspace ? `${workspace}/${name}/dist` : 'dist';
+        const builder = await rollup.rollup({
+            input,
+            external: [
+                /^node:/,
+                /^[a-zA-Z@]/,
+                ...external
+            ],
+            plugins: [
+                typescript({
+                    include: [source, shims],
+                    exclude: ['dist'],
+                    compilerOptions: {
+                        rootDir: '.',
+                        outDir,
+                        declaration: true
+                    }
+                }),
+                commonjs({ extensions: ['.js', '.ts'] }),
+                pluginNodeResolve.nodeResolve(),
+                replace({
+                    '1.0.0': `'${packageOptions.version}'`,
+                    false: 'false',
+                    true: true
+                })
+            ]
+        });
+        await Promise.all(output.map(builder.write));
+        const stats = [];
+        await output.reduce((pre, cur, index) => {
+            pre
+                .then(() => fs.stat(cur.file))
+                .then((stat) => {
+                stats[index] = {
+                    format: cur.format,
+                    size: stat.size
+                };
+            });
+            return pre;
+        }, Promise.resolve());
+        return stats;
+    }
+    async buildTypes() {
+        const { workspace } = devShared.Locals.impl();
+        const { packageDir, packageOptions } = this;
+        if (workspace && packageOptions?.scripts?.['build:types']) {
+            await devShared.Shell.spawn(`npm`, ['run', 'build:types'], {
+                cwd: packageDir
+            });
+            return;
+        }
+        const config = path__namespace.resolve(packageDir, `api-extractor.json`);
+        if (fs.existsSync(config)) {
+            const result = apiExtractor.Extractor.invoke(apiExtractor.ExtractorConfig.loadFileAndPrepare(config), {
+                localBuild: true,
+                showVerboseMessages: false
+            });
+            if (!result.succeeded) {
+                devShared.Logger.error(`API Extractor completed with ${result.errorCount} errors and ${result.warningCount} warnings`);
+                process.exitCode = 1;
+            }
+        }
+        await fs.remove(`${packageDir}/dist/${workspace || 'src'}`);
+    }
+}
+const build = (options, commandOptions) => {
+    return new Build(options, commandOptions);
+};
+
+const run = (options) => devShared.Utils.autoCatch(async () => {
+    options = {
+        formats: 'es,cjs',
+        ...options
+    };
+    const locals = devShared.Locals.impl();
+    if (typeof options.dryRun === 'undefined') {
+        options.dryRun = process.env.NODE_ENV === 'UNIT';
+    }
+    const { normalizePackageFolderNames } = devShared.Locals.impl();
+    let packageFolderName = devShared.Locals.getPackageFolderName(options.packageName || '**');
+    let inputs = [];
+    if (locals.workspace && packageFolderName === '**') {
+        inputs = normalizePackageFolderNames;
+    }
+    else {
+        inputs = [packageFolderName];
+    }
+    if (options.dryRun)
+        return devShared.Shell.spawn(`echo ${inputs.join(' ')}`);
+    await inputs
+        .reduce((preProcess, packageFolderName$) => {
+        preProcess = preProcess.then(() => build(packageFolderName$, options).process());
+        return preProcess;
+    }, Promise.resolve());
+}, {
+    onError: (e) => {
+        if (typeof e === 'number' && e === 1) {
+            devShared.Logger.error('编译未通过');
+        }
+        else {
+            devShared.Logger.error(e);
+        }
+        process.exit(1);
+    }
+});
+
+exports.run = run;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import type { Options } from '@deot/dev-shared';
+
+export declare const run: (options: Options) => Promise<any>;
+
+export { }

package/dist/index.es.js

@@ -0,0 +1,212 @@
+import { Locals, Shell, Logger, Utils } from '@deot/dev-shared';
+import * as path from 'node:path';
+import { createRequire } from 'node:module';
+import fs from 'fs-extra';
+import typescript from '@rollup/plugin-typescript';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import replace from '@rollup/plugin-replace';
+import { rollup } from 'rollup';
+import { Extractor, ExtractorConfig } from '@microsoft/api-extractor';
+import chalk from 'chalk';
+import ora from 'ora';
+
+const require$ = createRequire(process.cwd());
+class Build {
+    packageDir;
+    packageName;
+    packageOptions;
+    config;
+    commandOptions;
+    constructor(config, commandOptions) {
+        const { workspace, packageDir, packageName } = Locals.impl();
+        if (typeof config === 'string') {
+            let packageFolderName = config;
+            let packageDir$ = path.resolve(packageDir, packageFolderName);
+            let input = fs.existsSync(packageDir$ + '/src/index.ts')
+                ? packageDir$ + '/src/index.ts'
+                : fs.existsSync(packageDir$ + '/src/index.js')
+                    ? packageDir$ + '/src/index.js'
+                    : '';
+            config = {
+                dir: packageDir$,
+                name: packageFolderName || 'index',
+                input,
+                output: [
+                    {
+                        file: packageDir$ + '/dist/index.es.js',
+                        format: 'es',
+                        exports: 'named',
+                        sourcemap: false
+                    },
+                    {
+                        file: packageDir$ + '/dist/index.iife.js',
+                        format: 'iife',
+                        name: packageName,
+                    },
+                    {
+                        file: packageDir$ + '/dist/index.cjs.js',
+                        format: 'cjs'
+                    }
+                ].filter(i => {
+                    return commandOptions.formats.includes(i.format);
+                })
+            };
+        }
+        this.packageDir = path.resolve(packageDir, workspace ? `./${config.name}` : '');
+        this.packageName = config.name === 'index'
+            ? packageName
+            : `${packageName}-${config.name}`;
+        this.packageOptions = require$(`${this.packageDir}/package.json`);
+        this.config = config;
+        this.commandOptions = commandOptions;
+    }
+    async process() {
+        const { cwd, workspace } = Locals.impl();
+        const { config, packageOptions, packageName, packageDir } = this;
+        if (workspace
+            && packageOptions?.scripts?.build
+            && packageDir !== cwd) {
+            await Shell.spawn(`npm`, ['run', 'build'], {
+                cwd: packageDir
+            });
+            return;
+        }
+        if (!config.input)
+            return;
+        const spinner = ora(`${packageName} Build ...`);
+        try {
+            spinner.start();
+            await fs.emptyDir(`${packageDir}/dist`);
+            const stats = await this.buildSources();
+            await this.buildTypes();
+            spinner.stop();
+            Logger.log(`${chalk.cyan(`${packageName}`)}: ${chalk.green('Success')}`);
+            stats.forEach((stat) => {
+                Logger.log(`${chalk.green(stat.format.toUpperCase())}: ${Utils.formatBytes(stat.size)}`);
+            });
+        }
+        catch (e) {
+            Logger.log('Error!', e);
+            throw e;
+        }
+    }
+    async buildSources() {
+        const { workspace } = Locals.impl();
+        const { name, input, output } = this.config;
+        const { packageOptions } = this;
+        const external = Object
+            .keys({
+            ...packageOptions.dependencies,
+            ...packageOptions.peerDependencies
+        })
+            .map(i => new RegExp(`^${i}$`));
+        const source = workspace ? `${workspace}/${name}/**/*` : 'src/**/*';
+        const shims = workspace ? `${workspace}/shims.d.ts` : 'shims.d.ts';
+        const outDir = workspace ? `${workspace}/${name}/dist` : 'dist';
+        const builder = await rollup({
+            input,
+            external: [
+                /^node:/,
+                /^[a-zA-Z@]/,
+                ...external
+            ],
+            plugins: [
+                typescript({
+                    include: [source, shims],
+                    exclude: ['dist'],
+                    compilerOptions: {
+                        rootDir: '.',
+                        outDir,
+                        declaration: true
+                    }
+                }),
+                commonjs({ extensions: ['.js', '.ts'] }),
+                nodeResolve(),
+                replace({
+                    '1.0.0': `'${packageOptions.version}'`,
+                    false: 'false',
+                    true: true
+                })
+            ]
+        });
+        await Promise.all(output.map(builder.write));
+        const stats = [];
+        await output.reduce((pre, cur, index) => {
+            pre
+                .then(() => fs.stat(cur.file))
+                .then((stat) => {
+                stats[index] = {
+                    format: cur.format,
+                    size: stat.size
+                };
+            });
+            return pre;
+        }, Promise.resolve());
+        return stats;
+    }
+    async buildTypes() {
+        const { workspace } = Locals.impl();
+        const { packageDir, packageOptions } = this;
+        if (workspace && packageOptions?.scripts?.['build:types']) {
+            await Shell.spawn(`npm`, ['run', 'build:types'], {
+                cwd: packageDir
+            });
+            return;
+        }
+        const config = path.resolve(packageDir, `api-extractor.json`);
+        if (fs.existsSync(config)) {
+            const result = Extractor.invoke(ExtractorConfig.loadFileAndPrepare(config), {
+                localBuild: true,
+                showVerboseMessages: false
+            });
+            if (!result.succeeded) {
+                Logger.error(`API Extractor completed with ${result.errorCount} errors and ${result.warningCount} warnings`);
+                process.exitCode = 1;
+            }
+        }
+        await fs.remove(`${packageDir}/dist/${workspace || 'src'}`);
+    }
+}
+const build = (options, commandOptions) => {
+    return new Build(options, commandOptions);
+};
+
+const run = (options) => Utils.autoCatch(async () => {
+    options = {
+        formats: 'es,cjs',
+        ...options
+    };
+    const locals = Locals.impl();
+    if (typeof options.dryRun === 'undefined') {
+        options.dryRun = process.env.NODE_ENV === 'UNIT';
+    }
+    const { normalizePackageFolderNames } = Locals.impl();
+    let packageFolderName = Locals.getPackageFolderName(options.packageName || '**');
+    let inputs = [];
+    if (locals.workspace && packageFolderName === '**') {
+        inputs = normalizePackageFolderNames;
+    }
+    else {
+        inputs = [packageFolderName];
+    }
+    if (options.dryRun)
+        return Shell.spawn(`echo ${inputs.join(' ')}`);
+    await inputs
+        .reduce((preProcess, packageFolderName$) => {
+        preProcess = preProcess.then(() => build(packageFolderName$, options).process());
+        return preProcess;
+    }, Promise.resolve());
+}, {
+    onError: (e) => {
+        if (typeof e === 'number' && e === 1) {
+            Logger.error('编译未通过');
+        }
+        else {
+            Logger.error(e);
+        }
+        process.exit(1);
+    }
+});
+
+export { run };

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@deot/dev-builder",
+  "version": "1.1.0",
+  "main": "dist/index.es.js",
+  "module": "dist/index.es.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@deot/dev-extract": "^1.1.0",
+    "@deot/dev-shared": "^1.1.0",
+    "@microsoft/api-extractor": "^7.34.4",
+    "@rollup/plugin-commonjs": "^24.1.0",
+    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-replace": "^5.0.2",
+    "@rollup/plugin-typescript": "11.1.0",
+    "rollup": "^3.20.5"
+  }
+}