@fluentui/react-icons-font-subsetting-webpack-plugin 2.0.170-rc.7

package/README.md

@@ -0,0 +1,33 @@
+@fluentui/react-icons-font-subsetting-webpack-plugin
+===
+
+This package includes a plugin for `webpack@>=5.0.0` to subset the icon font files used by `@fluentui/react-icons` when using the `"fluentIcontFont"` condition in `resolve.conditionNames`. 
+
+If `optimization.usedExports` is enabled (as it is by default), this plugin will subset the font files to only include the glyphs actually used by your build.
+
+Usage
+---
+```js
+// webpack.config.js
+const {default: FluentUIReactIconsFontSubsettingPlugin} = require('@fluentui/react-icons-font-subsetting-webpack-plugin');
+
+module.exports = {
+    module: {
+        rules: [
+            // Treat the font files as webpack assets
+            {
+                test: /\.(ttf|woff2?)$/,
+                type: 'asset',
+            }
+        ]
+    },
+    resolve: {
+        // Include 'fluentIcontFont' to use the font implementation of the Fluent icons
+        conditionNames: ['fluentIcontFont', 'import']
+    },
+    plugins: [
+        // Include this plugin
+        new FluentUIReactIconsFontSubsettingPlugin(),
+    ],
+};
+```

package/lib/index.js

@@ -0,0 +1,123 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const webpack = __importStar(require("webpack"));
+const subset_font_1 = __importDefault(require("subset-font"));
+const path_1 = require("path");
+const promises_1 = require("fs/promises");
+const PLUGIN_NAME = "FluentUIReactIconsFontSubsettingPlugin";
+const FONT_FILES_BASE_NAMES = [
+    "FluentSystemIcons-Filled",
+    "FluentSystemIcons-Resizable",
+    "FluentSystemIcons-Regular",
+];
+const FONT_EXTENSIONS = [
+    '.ttf',
+    '.woff',
+    '.woff2'
+];
+class FluentUIReactIconsFontSubsettingPlugin {
+    apply(compiler) {
+        compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
+            compilation.hooks.optimizeAssets.tapPromise(PLUGIN_NAME, async () => {
+                // There could be multiple instances of `@fluentui/react-icons`, and they need to be subset separately
+                const packageToUsedFontExports = new Map();
+                for (const m of compilation.modules) {
+                    if (isFluentUIReactFontChunk(m)) {
+                        const usedModuleExports = compilation.moduleGraph.getUsedExports(m, undefined);
+                        if (usedModuleExports === null || typeof usedModuleExports === 'boolean') {
+                            // Either all exports are used or there's no info on used exports
+                            continue;
+                        }
+                        const pkgLibPath = (0, path_1.resolve)((0, path_1.dirname)(m.resource), '../..');
+                        const usedPkgExports = packageToUsedFontExports.get(pkgLibPath) ?? new Set();
+                        for (const icon of usedModuleExports) {
+                            usedPkgExports.add(icon);
+                        }
+                        packageToUsedFontExports.set(pkgLibPath, usedPkgExports);
+                    }
+                }
+                const optimizationPromises = [];
+                for (const [pkgLibPath, usedExports] of packageToUsedFontExports) {
+                    for (const { assetName, codepoints: codepointMap } of await getFontAssetsAndCodepoints(pkgLibPath, compilation)) {
+                        optimizationPromises.push(optimizeFontAsset(codepointMap, usedExports, compilation, assetName));
+                    }
+                }
+                await optimizationPromises;
+            });
+        });
+    }
+}
+exports.default = FluentUIReactIconsFontSubsettingPlugin;
+async function optimizeFontAsset(codepointMap, usedExports, compilation, assetName) {
+    const subsetText = Object.entries(codepointMap)
+        .filter(([glyphName]) => usedExports.has(glyphName))
+        .map(([, codepoint]) => String.fromCodePoint(codepoint))
+        .join('');
+    let source = compilation.assets[assetName].source();
+    if (typeof source === "string") {
+        source = Buffer.from(source);
+    }
+    compilation.assets[assetName] = new webpack.sources.RawSource(await (0, subset_font_1.default)(source, subsetText, {
+        targetFormat: getTargetFormat(assetName),
+    }));
+}
+function getTargetFormat(assetName) {
+    switch ((0, path_1.extname)(assetName)) {
+        case ".woff":
+            return "woff";
+        case ".woff2":
+            return "woff2";
+        default:
+            return "sfnt";
+    }
+}
+function isNormalModule(m) {
+    return m instanceof webpack.NormalModule;
+}
+function isFluentUIReactFontChunk(m) {
+    if (isNormalModule(m)) {
+        return /react-icons[\/\\]lib(-cjs)?[\/\\]fonts[\/\\](sizedIcons|icons)[\/\\]chunk-\d+\.js$/.test(m.resource);
+    }
+    return false;
+}
+async function getFontAssetsAndCodepoints(pkgLibPath, compilation) {
+    const utilsFontsFolder = (0, path_1.resolve)(pkgLibPath, 'utils/fonts');
+    const codepoints = Object.fromEntries(await Promise.all(FONT_FILES_BASE_NAMES.map(async (fontBaseName) => [fontBaseName, JSON.parse(await (0, promises_1.readFile)((0, path_1.resolve)(utilsFontsFolder, `${fontBaseName}.json`), 'utf8'))])));
+    const fontPaths = new Map(FONT_FILES_BASE_NAMES.flatMap(fontBaseName => FONT_EXTENSIONS.map(ext => [(0, path_1.resolve)(utilsFontsFolder, `${fontBaseName}${ext}`), codepoints[fontBaseName]])));
+    const result = [];
+    for (const m of compilation.modules) {
+        if (isNormalModule(m) && fontPaths.has(m.resource)) {
+            const assetName = m.buildInfo?.filename;
+            if (assetName) {
+                result.push({ assetName, codepoints: fontPaths.get(m.resource) });
+            }
+        }
+    }
+    return result;
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@fluentui/react-icons-font-subsetting-webpack-plugin",
+  "version": "2.0.170-rc.7",
+  "description": "Webpack plugin to subset the icon fonts used by @fluentui/react-icons based on which icons are used.",
+  "main": "lib/index.js",
+  "scripts": {
+    "test": "webpack -c test/webpack.config.js",
+    "build": "tsc"
+  },
+  "engines": {
+    "node": ">=14.5.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/microsoft/fluentui-system-icons.git",
+    "directory": "packages/react-icons-font-subsetting-webpack-plugin"
+  },
+  "author": "Michael Loughry <miclo@microsoft.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/microsoft/fluentui-system-icons/issues"
+  },
+  "homepage": "https://github.com/microsoft/fluentui-system-icons/packages/react-icons-font-subsetting-webpack-plugin#readme",
+  "devDependencies": {
+    "typescript": "^4.6.3",
+    "webpack": "^5.72.0",
+    "@fluentui/react-icons": "*"
+  },
+  "dependencies": {
+    "subset-font": "^1.4.0"
+  },
+  "peerDependencies": {
+    "webpack": ">=5.0.0"
+  },
+  "files": [
+    "lib/*"
+  ]
+}