@next-core/build-next-bricks 1.12.0 → 1.13.1

package/index.d.ts

@@ -2,7 +2,9 @@ import type { Compiler, Configuration, RuleSetRule, container } from "webpack";
 
 export declare function build(config: BuildNextBricksConfig): Compiler;
 export declare function getSvgrLoaders(options?: {
-  /** Set it to true for font icons */
+  /** Set it to true for icon font, defaults to false. */
+  icon?: boolean | string | number;
+  /** Defaults to true when `icon` is truthy, otherwise defaults to false. */
   convertCurrentColor?: boolean;
 }): RuleSetRule["use"];
 
@@ -77,7 +79,7 @@ export interface BuildNextBricksConfig {
   svgAsReactComponent?: boolean;
   /** Customize rules for svg, this will take precedence over `svgAsReactComponent` */
   svgRules?: RuleSetRule[];
-  /** By default the image assets are named `images/[hash][ext][query]` */
+  /** By default the image assets are named `images/[hash][ext]` */
   imageAssetFilename?: string | ((pathData: any, assetInfo: any) => string);
   plugins?: Configuration["plugins"];
   moduleRules?: RuleSetRule[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/build-next-bricks",
-  "version": "1.12.0",
+  "version": "1.13.1",
   "description": "Build next bricks",
   "homepage": "https://github.com/easyops-cn/next-core/tree/v3/packages/build-next-bricks",
   "license": "GPL-3.0",
@@ -51,5 +51,5 @@
   "devDependencies": {
     "@next-core/brick-manifest": "^0.5.0"
   },
-  "gitHead": "fbd30ceaf3abd9c99c5dc2085a81413c68e367e0"
+  "gitHead": "ade903abfe7858ec69518eed83a91c43b54bdd4a"
 }

package/src/build.js

@@ -1,4 +1,5 @@
 import path from "node:path";
+import { existsSync } from "node:fs";
 import { readFile } from "node:fs/promises";
 import { createRequire } from "node:module";
 import webpack from "webpack";
@@ -6,6 +7,7 @@ import MiniCssExtractPlugin from "mini-css-extract-plugin";
 import postcssPresetEnv from "postcss-preset-env";
 import cssnano from "cssnano";
 import cssnanoPresetLite from "cssnano-preset-lite";
+import _ from "lodash";
 import EmitBricksJsonPlugin from "./EmitBricksJsonPlugin.js";
 import getCamelPackageName from "./getCamelPackageName.js";
 import getSvgrLoaders from "./getSvgrLoaders.js";
@@ -65,13 +67,48 @@ async function getWebpackConfig(config) {
 
   const packageJsonFile = await readFile(
     path.join(packageDir, "package.json"),
-    { encoding: "utf-8" }
+    "utf-8"
   );
   const packageJson = JSON.parse(packageJsonFile);
   const packageName = packageJson.name.split("/").pop();
   const camelPackageName = getCamelPackageName(packageName);
   const libName = isBricks ? `bricks/${packageName}` : config.type;
 
+  /** @type {string[]} */
+  let commonBricks;
+  const commonBricksJsonFile = path.join(
+    packageDir,
+    "../../shared/common-bricks/common-bricks.json"
+  );
+  if (existsSync(commonBricksJsonFile)) {
+    const commonBricksJson = JSON.parse(
+      await readFile(commonBricksJsonFile, "utf-8")
+    );
+
+    /** @type {Set<string, string>} */
+    const commonBricksMap = new Map();
+    for (const [pkg, bricks] of Object.entries(commonBricksJson)) {
+      for (const brick of bricks) {
+        const existedPkg = commonBricksMap.get(brick);
+        if (existedPkg && existedPkg !== pkg) {
+          throw new Error(
+            `Conflicted common brick: "${brick}" in package "${existedPkg}" and "${pkg}"`
+          );
+        }
+        commonBricksMap.set(brick, pkg);
+      }
+    }
+
+    commonBricks = Object.prototype.hasOwnProperty.call(
+      commonBricksJson,
+      packageName
+    )
+      ? commonBricksJson[packageName]
+      : [];
+  } else {
+    commonBricks = [];
+  }
+
   const sharedSingletonPackages = [
     "history",
     "i18next",
@@ -181,12 +218,31 @@ async function getWebpackConfig(config) {
     }
   }
 
+  const invalidElements = _.difference(elements, commonBricks);
+  if (invalidElements.length > 0) {
+    throw new Error(
+      `Find common bricks in \`${packageName}\` which are not in common-bricks.json: ${invalidElements.join(
+        ", "
+      )}`
+    );
+  }
+  const missingElements = _.difference(commonBricks, elements);
+  if (missingElements.length > 0) {
+    throw new Error(
+      `Missing common bricks in \`${packageName}\`: ${missingElements.join(
+        ", "
+      )}`
+    );
+  }
+
   /** @type {Record<string, { import: string; name: string; }>} */
   const extraExposes = {};
 
   const outputPath = path.join(packageDir, config.outputPath ?? "dist");
   const chunksDir = isBricks ? "chunks/" : "";
 
+  const imageAssetFilename = config.imageAssetFilename ?? "images/[hash][ext]";
+
   return {
     entry: config.entry || {
       main: "./src/index",
@@ -267,7 +323,7 @@ async function getWebpackConfig(config) {
           ),
           type: "asset/resource",
           generator: {
-            filename: config.imageAssetFilename ?? "images/[hash][ext][query]",
+            filename: imageAssetFilename,
           },
         },
         ...(config.svgRules ??
@@ -275,6 +331,29 @@ async function getWebpackConfig(config) {
             ? [
                 {
                   test: /\.svg$/i,
+                  type: "asset/resource",
+                  // Match `xxx.svg?url`
+                  resourceQuery: /url/,
+                  generator: {
+                    filename: imageAssetFilename,
+                  },
+                },
+                {
+                  test: /\.svg$/i,
+                  // Exclude issuer of js files
+                  issuer: {
+                    not: /\.[jt]sx?$/,
+                  },
+                  type: "asset/resource",
+                  generator: {
+                    filename: imageAssetFilename,
+                  },
+                },
+                {
+                  test: /\.svg$/i,
+                  issuer: /\.[jt]sx?$/,
+                  // Exclude `xxx.svg?url`
+                  resourceQuery: { not: /url/ },
                   use: getSvgrLoaders(),
                 },
               ]

package/src/getSvgrLoaders.js

@@ -10,7 +10,7 @@ export default function getSvgrLoaders(options = {}) {
       loader: "@svgr/webpack",
       options: {
         babel: false,
-        icon: true,
+        icon: options.icon ?? false,
         svgoConfig: {
           plugins: [
             {
@@ -21,7 +21,7 @@ export default function getSvgrLoaders(options = {}) {
                   removeViewBox: false,
 
                   convertColors: {
-                    currentColor: options.convertCurrentColor ?? false,
+                    currentColor: options.convertCurrentColor ?? !!options.icon,
                   },
                 },
               },