xhs-mp-compiler-cli 1.9.5 → 1.9.6

package/dist/presets/configs/miniprogram/render/sjsEntryPlugin.d.ts

@@ -1,14 +1,29 @@
 import { Compilation, ICompiler } from '../../../../packs';
 import { IPresetOptions } from '../../../../types';
+/**
+ * @NOTE 分包中使用 SJS 的规则
+ *
+ *  - 整包情况下，可以在所有页面中引用整包内的任意SJS模块。
+ *  - 分包情况下：
+ *    - 主包不能引入分包的 SJS 模块。
+ *    - 分包内部可以引用主分包内的SJS模块。
+ *    - 分包A 和 分包B 之间不可以互相引用SJS模块。
+ *    - 独立分包内的SJS模块只能在独立分包内使用，不能跨分包引用。
+ */
 declare class SjsEntryPlugin {
     options: IPresetOptions;
     entriesCache: Map<string, boolean>;
     mainpkgPaths: string[];
     subPackagePaths: Map<string, string[]>;
     subPackageRoots: string[];
+    _compilation: Compilation;
     constructor(options: IPresetOptions);
     isFileInMainPkg(filePath: any): boolean;
     isFileInSubpackage(filePath: any): boolean;
+    get compilation(): Compilation;
+    set compilation(value: Compilation);
+    emitError(details: string): void;
+    generateMessage(_errs: string | string[], fileName?: string): string;
     apply(compiler: ICompiler): void;
     makeSjsFileContent(compilation: Compilation, chunkName: string, sjsFiles: string[] | undefined, sjsModuleName: string, pkgRoot?: string): void;
 }

package/dist/presets/configs/miniprogram/render/sjsEntryPlugin.js

@@ -51,16 +51,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
      *    - 分包A 和 分包B 之间不可以互相引用SJS模块。
      *    - 独立分包内的SJS模块只能在独立分包内使用，不能跨分包引用。
      */
-    function formatSJSPath(i) {
-        if (/\.(sjs|wxs)$/.test(i)) {
-            return (0, common_1.toUnixPath)(i);
-        }
-        const suffix = ['sjs', 'wxs'].find(n => fs_extra_1.default.existsSync(`${i}.${n}`));
-        if (!suffix) {
-            throw new packs_1.WebpackError(`[SJS文件编译错误] ${i}.sjs 不存在`);
-        }
-        return (0, common_1.toUnixPath)(suffix ? `${i}.${suffix}` : i);
-    }
     class SjsEntryPlugin {
         constructor(options) {
             this.options = options;
@@ -75,12 +65,32 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
         isFileInSubpackage(filePath) {
             return this.subPackageRoots.some(root => filePath.startsWith(`${root}/`));
         }
+        get compilation() {
+            return this._compilation;
+        }
+        set compilation(value) {
+            this._compilation = value;
+        }
+        emitError(details) {
+            var _a, _b;
+            (_b = (_a = this.compilation) === null || _a === void 0 ? void 0 : _a.errors) === null || _b === void 0 ? void 0 : _b.push(new packs_1.WebpackError(details));
+        }
+        generateMessage(_errs, fileName = '') {
+            const errs = Array.isArray(_errs) ? _errs : [_errs];
+            return [
+                '\n<xhsml!',
+                (fileName === null || fileName === void 0 ? void 0 : fileName.trim()) ? `[error:sjs编译错误]： [file:${fileName === null || fileName === void 0 ? void 0 : fileName.trim()}]` : '[error:sjs编译错误]',
+                ...errs,
+                '!xhsml>\n'
+            ].join('\n');
+        }
         apply(compiler) {
             compiler.hooks.watchRun.tap('SjsEntryPlugin', () => {
                 this.subPackagePaths.clear();
                 this.mainpkgPaths = [];
             });
             compiler.hooks.emit.tapAsync('SjsEntryPlugin', (compilation, callback) => {
+                this.compilation = compilation;
                 const { project } = this.options;
                 const { appJSON, miniprogramDir } = project;
                 this.subPackageRoots = appJSON.subPackages.map(pkg => pkg.root);
@@ -130,40 +140,53 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
                 if (sjsPathCache.has(sjsPath)) {
                     continue;
                 }
-                const sjsAbsPath = formatSJSPath(sjsPath);
+                let sjsAbsPath = '';
+                if (/\.(sjs|wxs)$/.test(sjsPath)) {
+                    sjsAbsPath = (0, common_1.toUnixPath)(sjsPath);
+                }
+                else {
+                    this.emitError(this.generateMessage(`文件后缀不正确 ${sjsPath}`));
+                }
                 const content = fs_extra_1.default.readFileSync(sjsAbsPath, 'utf8');
-                const result = xhs_mp_compiler_sjs_loader_1.default.call(compilation, content, requirePath => {
-                    const realPath = (0, common_1.unixResolve)(path_1.default.dirname(sjsAbsPath), requirePath);
-                    const relativePath = (0, common_1.getShortPath)(project.miniprogramDir, realPath);
-                    /**
-                     * 不是当前分包的 sjs 文件不处理
-                     */
-                    if (pkgRoot && !relativePath.startsWith(pkgRoot)) {
-                        throw new Error(`require(${JSON.stringify(requirePath)})，请检测引入路径是否正确或符合分包规则！`);
-                    }
-                    if (!fs_extra_1.default.existsSync(realPath)) {
-                        throw new Error(`require(${JSON.stringify(requirePath)}) file does not exist`);
+                try {
+                    const result = xhs_mp_compiler_sjs_loader_1.default.call(compilation, content, requirePath => {
+                        const realPath = (0, common_1.unixResolve)(path_1.default.dirname(sjsAbsPath), requirePath);
+                        const relativePath = (0, common_1.getShortPath)(project.miniprogramDir, realPath);
+                        /**
+                         * 不是当前分包的 sjs 文件不处理
+                         */
+                        if (pkgRoot && !relativePath.startsWith(pkgRoot)) {
+                            this.emitError(this.generateMessage(`require(${JSON.stringify(requirePath)})，请检测引入路径是否正确或符合分包规则！`, sjsAbsPath));
+                        }
+                        else if (!fs_extra_1.default.existsSync(realPath)) {
+                            this.emitError(this.generateMessage(`require(${JSON.stringify(requirePath)})，请检测引入路径是否正确！`, sjsAbsPath));
+                        }
+                        else if (!/\.(sjs|wxs)$/.test(requirePath)) {
+                            this.emitError(this.generateMessage(`require(${JSON.stringify(requirePath)})，仅支持引入 .js 后缀结尾的文件！`, sjsAbsPath));
+                        }
+                        else {
+                            sjsFiles.push(realPath);
+                        }
+                        return relativePath;
+                    });
+                    if ((_a = result.errors) === null || _a === void 0 ? void 0 : _a.length) {
+                        this.emitError(this.generateMessage(result.errors.map(i => i.message).join("\n"), sjsAbsPath));
                     }
-                    sjsFiles.push(realPath);
-                    return relativePath;
-                });
-                if ((_a = result.errors) === null || _a === void 0 ? void 0 : _a.length) {
-                    throw new packs_1.WebpackError([
-                        '\n<xhsml!',
-                        `[error:sjs编译错误]： [file:${sjsAbsPath === null || sjsAbsPath === void 0 ? void 0 : sjsAbsPath.trim()}]`,
-                        // swc span 信息不准确
-                        // `${result.errors.map(i => `${i.span.start} ${i.span.end} ${i.message}`).join("\n")}`,
-                        `${result.errors.map(i => i.message).join("\n")}`,
-                        '!xhsml>\n'
+                    const moduleName = (0, common_1.getShortPath)(project.miniprogramDir, sjsAbsPath);
+                    // 老版本兼容代码
+                    sjsModules.push(`"${moduleName}": ${JSON.stringify(result.legacyCode)}`);
+                    // 模块化代码
+                    sjsModules.push([
+                        `".sjs#${moduleName}": function(exports,require,module,${xhs_mp_compiler_sjs_loader_1.SJS_HELPER}){`,
+                        `${result.code};`,
+                        `return module;}`
                     ].join('\n'));
+                    // 处理后的加入缓存
+                    sjsPathCache.add(sjsPath);
+                }
+                catch (error) {
+                    this.emitError(this.generateMessage(error.message, sjsAbsPath));
                 }
-                const moduleName = (0, common_1.getShortPath)(project.miniprogramDir, sjsAbsPath);
-                // 老版本兼容代码
-                sjsModules.push(`"${moduleName}": ${JSON.stringify(result.legacyCode)}`);
-                // 模块化代码
-                sjsModules.push(`".sjs#${moduleName}": function(exports,require,module,${xhs_mp_compiler_sjs_loader_1.SJS_HELPER}){${(result.code)};return module;}`);
-                // 处理后的加入缓存
-                sjsPathCache.add(sjsPath);
             }
             const source = new packs_1.ConcatSource(`globalThis['${sjsModuleName}'] = {`, `${sjsModules.join(',\n')}`, '}');
             if (packSetting.enableV1) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xhs-mp-compiler-cli",
-  "version": "1.9.5",
+  "version": "1.9.6",
   "description": "xhs mp command tool.",
   "preferGlobal": true,
   "category": "esm",
@@ -94,13 +94,13 @@
     "webpack-chain": "^6.5.1",
     "webpack-sources": "^3.2.2",
     "xhs-mp-workerpool": "^9.1.3",
-    "xhs-mp-compiler-ml-loader": "3.0.5",
-    "xhs-mp-compiler-utils": "1.9.5",
-    "xhs-mp-pack": "1.9.5",
-    "xhs-mp-project": "1.9.5",
-    "xhs-mp-utils": "1.9.5",
-    "xhs-mp-shared-fs": "1.4.5",
-    "xhs-mp-compiler-sjs-loader": "1.9.5",
+    "xhs-mp-compiler-ml-loader": "3.0.6",
+    "xhs-mp-compiler-utils": "1.9.6",
+    "xhs-mp-pack": "1.9.6",
+    "xhs-mp-project": "1.9.6",
+    "xhs-mp-utils": "1.9.6",
+    "xhs-mp-shared-fs": "1.4.6",
+    "xhs-mp-compiler-sjs-loader": "1.9.6",
     "yauzl": "^2.10.0"
   },
   "devDependencies": {