@douyinfe/semi-rspack-plugin 0.0.1-alpha.0

package/README.md

@@ -0,0 +1,169 @@
+> A webpack plugin for Semi Design to custom theme、replace prefix and so on.
+
+## Introduction
+The plugin is designed for Semi Design, support webpack4 and webpack5, provides two major abilities:
+- Custom theme
+- Replace prefix of CSS selector 
+
+## Usage 
+
+### Install 
+Install `@douyinfe/semi-webpack-plugin` as a development dependency:
+
+``` shell
+npm install --save-dev @douyinfe/semi-webpack-plugin
+# or
+yarn add --dev @douyinfe/semi-webpack-plugin
+```
+
+### Custom theme
+Semi Design uses the Scss variables to extract thousands of Design Tokens. You can replace Token through this plugin to achieve theme customization. [More info](https://semi.design/dsm/)
+
+You can custom theme through three ways:
+- npm package for custom theme
+- Local Scss file in your project
+- Pass key-value pair parameters to plugin 
+Priority from low to high.
+#### Through npm package 
+
+In order to use the npm package, you need to customize the theme through [Semi Design System](https://semi.design/dsm/).After finishing the customization, Semi DSM will generate a npm package for you, and then you can use it like this.
+
+``` js
+// webpack.config.js
+const SemiPlugin = require('@douyinfe/semi-webpack-plugin').default;
+
+module.exports = {
+    // ...
+    plugins: [
+        new SemiPlugin({
+            theme: '@douyinfe/semi-theme-default'
+        })
+    ]
+    // ...
+};
+```
+
+#### Through local Scss file
+
+You can check which tokens can be customized on the [Semi WebSite](https://semi.design/zh-CN/basic/tokens).
+
+- step1: add a local file
+``` scss
+// local.scss
+$font-size-small: 16px;
+
+```
+- step2: config webpack
+``` js
+// webpack.config.js
+const path = require('path');
+const SemiPlugin = require('@douyinfe/semi-webpack-plugin').default;
+
+module.exports = {
+    // ...
+    plugins: [
+        new SemiPlugin({
+            include: path.join(__dirname, 'local.scss')
+        })
+    ]
+};
+```
+
+#### Through parameters
+``` js
+// webpack.config.js
+const SemiPlugin = require('@douyinfe/semi-webpack-plugin').default;
+
+module.exports = {
+    // ...
+    plugins: [
+        new SemiPlugin({
+            variables: {
+                "$font-size-small": '16px'
+            }
+        })
+    ]
+};
+```
+
+### Replace prefix of CSS selector
+The CSS selectors used by Semi Design is prefixed with semi by default(e.g, `.semi-button`).You can replace the prefix through this plugin.
+
+``` js
+// webpack.config.js
+const SemiPlugin = require('@douyinfe/semi-webpack-plugin').default;
+
+module.exports = {
+    // ...
+    plugins: [
+        new SemiPlugin({
+            prefixCls: 'custom'
+        })
+    ]
+    // ...
+};
+```
+
+Then you get the replaced CSS selectors(e.g, `.custom-button`).
+
+## Api
+### new SemiPlugin(options)
+
+#### options.prefixCls
+
+Type: `String`
+
+The prefix of CSS selector.
+
+#### options.theme
+
+Type: `String` or `Object`
+
+When the type is string, it represents the name of npm for custom theme.You can use [Semi Design System](https://semi.design) to custom theme.
+
+##### options.theme.name
+
+Same performance as when the type of `options.theme` is string.
+
+##### options.include
+
+Type: `String`
+
+The absolute path of the local Scss file.
+
+##### options.variables
+
+Type: `Object`
+
+The key-value pair of Scss token.
+
+##### options.omitCss
+
+Type: `Boolean`
+
+In the compilation phase, whether to exclude css references.Used to solve the problem that Next.js does not support the global introduction of css in third-party code.See this [discussion](https://github.com/vercel/next.js/discussions/27953).
+
+##### options.webpackContext.NormalModule
+
+Type: `webpack NormalModule`
+
+##### options.extractCssOptions.loader
+
+Type: `String`
+
+The path of webpack loader that extract css.
+
+##### options.extractCssOptions.loaderOptions
+
+Type: `Object`
+
+The options of webpack loader that extract css.
+
+#### options.overrideStylesheetLoaders
+
+Type: `(loaderList:any[])=>any[]`
+
+You can customize how webpack process semi related styles by override the loader with this option. The function will receive the loader list of default loaders(include options.extractCssOptions) and you should return your new loader list. The best practice is just only add your loader to the list rather than delete or change the default loaders since some core logic is in there.
+
+
+In webpack@5, some hooks need to be obtained through api `NormalModule.getCompilationHooks`. But in some scenarios, webpack will not be installed, such as Next.js. Therefore, the user is required to pass in NormalModule as a parameter.

package/lib/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const SOURCE_SUFFIX_LOADER: string;
+export declare const THEME_LOADER: string;
+export declare const OMIT_CSS_LOADER: string;
+export declare const PREFIX_LOADER: string;

package/lib/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PREFIX_LOADER = exports.OMIT_CSS_LOADER = exports.THEME_LOADER = exports.SOURCE_SUFFIX_LOADER = void 0;
+const path_1 = __importDefault(require("path"));
+exports.SOURCE_SUFFIX_LOADER = path_1.default.resolve(__dirname, './loaders/semi-source-suffix-loader');
+exports.THEME_LOADER = path_1.default.resolve(__dirname, './loaders/semi-theme-loader');
+exports.OMIT_CSS_LOADER = path_1.default.resolve(__dirname, './loaders/semi-omit-css-loader');
+exports.PREFIX_LOADER = path_1.default.resolve(__dirname, './loaders/semi-prefix-loader');

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+export * from './types';
+export * from './plugin';
+export * from './rule';
+export { default as semiThemeLoader } from './loaders/semi-theme-loader';
+export { default as semiPrefixLoader } from './loaders/semi-prefix-loader';
+export { default as semiSourceSuffixLoader } from './loaders/semi-source-suffix-loader';
+export { default as semiOmitCssLoader } from './loaders/semi-omit-css-loader';

package/lib/index.js

@@ -0,0 +1,31 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.semiOmitCssLoader = exports.semiSourceSuffixLoader = exports.semiPrefixLoader = exports.semiThemeLoader = void 0;
+__exportStar(require("./types"), exports);
+__exportStar(require("./plugin"), exports);
+__exportStar(require("./rule"), exports);
+var semi_theme_loader_1 = require("./loaders/semi-theme-loader");
+Object.defineProperty(exports, "semiThemeLoader", { enumerable: true, get: function () { return __importDefault(semi_theme_loader_1).default; } });
+var semi_prefix_loader_1 = require("./loaders/semi-prefix-loader");
+Object.defineProperty(exports, "semiPrefixLoader", { enumerable: true, get: function () { return __importDefault(semi_prefix_loader_1).default; } });
+var semi_source_suffix_loader_1 = require("./loaders/semi-source-suffix-loader");
+Object.defineProperty(exports, "semiSourceSuffixLoader", { enumerable: true, get: function () { return __importDefault(semi_source_suffix_loader_1).default; } });
+var semi_omit_css_loader_1 = require("./loaders/semi-omit-css-loader");
+Object.defineProperty(exports, "semiOmitCssLoader", { enumerable: true, get: function () { return __importDefault(semi_omit_css_loader_1).default; } });

package/lib/loaders/semi-omit-css-loader.d.ts

@@ -0,0 +1,2 @@
+import { LoaderContext } from 'webpack';
+export default function semiOmitCssLoader(this: LoaderContext<void>, source: string): string;

package/lib/loaders/semi-omit-css-loader.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function semiOmitCssLoader(source) {
+    return source
+        .replace(/(import\s+['"][^'"]+\.css['"])/g, '// $1')
+        .replace(/(require\(['"][^'"]+\.css['"]\))/g, '// $1');
+}
+exports.default = semiOmitCssLoader;

package/lib/loaders/semi-prefix-loader.d.ts

@@ -0,0 +1,5 @@
+import { LoaderContext } from 'webpack';
+export interface SemiPrefixLoaderOptions {
+    replacers?: Record<string, string>;
+}
+export default function semiPrefixLoader(this: LoaderContext<SemiPrefixLoaderOptions>, source: string): string;

package/lib/loaders/semi-prefix-loader.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@babel/core");
+const assert_1 = __importDefault(require("assert"));
+function semiPrefixLoader(source) {
+    const query = this.getOptions();
+    const transformer = {
+        visitor: {
+            VariableDeclarator(path) {
+                const { node } = path;
+                const replacerKeys = Object.keys(query.replacers || {});
+                if (replacerKeys.includes(node.id.name)) {
+                    node.init.value = query.replacers[node.id.name];
+                }
+            },
+        },
+    };
+    const file = (0, core_1.transformSync)(source, {
+        sourceType: 'module',
+        plugins: [transformer],
+    });
+    const ret = file.code;
+    (0, assert_1.default)(ret, '');
+    return ret;
+}
+exports.default = semiPrefixLoader;

package/lib/loaders/semi-source-suffix-loader.d.ts

@@ -0,0 +1,2 @@
+import { LoaderContext } from 'webpack';
+export default function semiSourceSuffixLoader(this: LoaderContext<void>, source: string): string;

package/lib/loaders/semi-source-suffix-loader.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function semiSourceSuffixLoader(source) {
+    return source.replace(/(import\s+)['"]([^'"]+)(\.css)['"]/g, '$1\'$2.scss\'');
+}
+exports.default = semiSourceSuffixLoader;

package/lib/loaders/semi-theme-loader.d.ts

@@ -0,0 +1,8 @@
+import { LoaderContext } from 'webpack';
+export interface SemiThemeLoaderOptions {
+    prefixCls: string;
+    variables: string;
+    include: string;
+    name?: string;
+}
+export default function SemiThemeLoader(this: LoaderContext<SemiThemeLoaderOptions>, source: string): string;

package/lib/loaders/semi-theme-loader.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const enhanced_resolve_1 = __importDefault(require("enhanced-resolve"));
+function SemiThemeLoader(source) {
+    const query = this.getOptions();
+    const theme = query.name || '@douyinfe/semi-theme-default';
+    // always inject
+    const scssVarStr = `@import "~${theme}/scss/index.scss";\n`;
+    // inject once
+    const cssVarStr = `@import "~${theme}/scss/global.scss";\n`;
+    let animationStr = `@import "~${theme}/scss/animation.scss";\n`;
+    try {
+        require.resolve(`${theme}/scss/animation.scss`);
+    }
+    catch (e) {
+        animationStr = ''; // fallback to empty string
+    }
+    const shouldInject = source.includes('semi-base');
+    let fileStr = source;
+    let componentVariables;
+    try {
+        componentVariables = enhanced_resolve_1.default.sync(this.context, `${theme}/scss/local.scss`);
+    }
+    catch (e) { }
+    if (query.include || query.variables || componentVariables) {
+        let localImport = '';
+        if (componentVariables) {
+            localImport += `\n@import "~${theme}/scss/local.scss";`;
+        }
+        if (query.include) {
+            localImport += `\n@import "${query.include}";`;
+        }
+        if (query.variables) {
+            localImport += `\n${query.variables}`;
+        }
+        try {
+            const regex = /(@import '.\/variables.scss';?|@import ".\/variables.scss";?)/g;
+            const fileSplit = source.split(regex).filter(item => Boolean(item));
+            if (fileSplit.length > 1) {
+                fileSplit.splice(fileSplit.length - 1, 0, localImport);
+                fileStr = fileSplit.join('');
+            }
+        }
+        catch (error) { }
+    }
+    // inject prefix
+    const prefixCls = query.prefixCls || 'semi';
+    const prefixClsStr = `$prefix: '${prefixCls}';\n`;
+    if (shouldInject) {
+        return `${animationStr}${cssVarStr}${scssVarStr}${prefixClsStr}${fileStr}`;
+    }
+    else {
+        return `${scssVarStr}${prefixClsStr}${fileStr}`;
+    }
+}
+exports.default = SemiThemeLoader;

package/lib/plugin.d.ts

@@ -0,0 +1,7 @@
+import { Compiler } from 'webpack';
+import { SemiWebpackPluginOptions } from './types';
+export declare class SemiRspackPlugin {
+    opts: SemiWebpackPluginOptions;
+    constructor(options?: SemiWebpackPluginOptions);
+    apply(compiler: Compiler): void;
+}

package/lib/plugin.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SemiRspackPlugin = void 0;
+const rule_1 = require("./rule");
+class SemiRspackPlugin {
+    constructor(options) {
+        this.opts = options;
+    }
+    apply(compiler) {
+        const rules = (0, rule_1.applySemiRules)(this.opts);
+        compiler.options.module.rules.push(...rules);
+    }
+}
+exports.SemiRspackPlugin = SemiRspackPlugin;

package/lib/rule.d.ts

@@ -0,0 +1,38 @@
+import { RuleSetRule } from 'webpack';
+import { SemiWebpackPluginOptions } from './types';
+export declare function createSourceSuffixLoaderRule(_opts?: SemiWebpackPluginOptions): {
+    test: RegExp;
+    use: {
+        loader: string;
+    }[];
+};
+export declare function createThemeLoaderRule(opts?: SemiWebpackPluginOptions): {
+    test: RegExp;
+    use: {
+        loader: string;
+        options: {
+            prefixCls: string;
+            variables: string;
+            include: string;
+            name?: string;
+        };
+    }[];
+};
+export declare function createOmitCssLoaderRule(_opts?: SemiWebpackPluginOptions): {
+    test: RegExp;
+    use: {
+        loader: string;
+    }[];
+};
+export declare function createPrefixLoaderRule(opts?: SemiWebpackPluginOptions): {
+    test: RegExp;
+    use: {
+        loader: string;
+        options: {
+            replacers: {
+                BASE_CLASS_PREFIX: string;
+            };
+        };
+    }[];
+};
+export declare function applySemiRules(opts?: SemiWebpackPluginOptions): RuleSetRule[];

package/lib/rule.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applySemiRules = exports.createPrefixLoaderRule = exports.createOmitCssLoaderRule = exports.createThemeLoaderRule = exports.createSourceSuffixLoaderRule = void 0;
+const constants_1 = require("./constants");
+const utils_1 = require("./utils");
+function createSourceSuffixLoaderRule(_opts) {
+    return {
+        test: /@douyinfe\/semi-(ui|icons)\/lib\/.+\.js$/,
+        use: [{ loader: constants_1.SOURCE_SUFFIX_LOADER }],
+    };
+}
+exports.createSourceSuffixLoaderRule = createSourceSuffixLoaderRule;
+function createThemeLoaderRule(opts) {
+    const themeOptions = {};
+    if (typeof opts.theme === 'object') {
+        Object.assign(themeOptions, opts.theme);
+    }
+    else {
+        themeOptions.name = opts.theme;
+    }
+    const options = Object.assign(Object.assign({}, themeOptions), { prefixCls: opts.prefixCls, variables: (0, utils_1.stringifyVariableRecord)(opts.variables), include: opts.include });
+    return {
+        test: /@douyinfe\/semi-(ui|icons|foundation)\/lib\/.+\.scss$/,
+        use: [{ loader: constants_1.THEME_LOADER, options }],
+    };
+}
+exports.createThemeLoaderRule = createThemeLoaderRule;
+function createOmitCssLoaderRule(_opts) {
+    return {
+        test: /@douyinfe\/semi-[^/]+\/.+env\.js$/,
+        use: [{ loader: constants_1.OMIT_CSS_LOADER }],
+    };
+}
+exports.createOmitCssLoaderRule = createOmitCssLoaderRule;
+function createPrefixLoaderRule(opts) {
+    const options = {
+        replacers: { BASE_CLASS_PREFIX: opts.prefixCls },
+    };
+    return {
+        test: /@douyinfe\/semi-[^/]+\/.+env\.js$/,
+        use: [{ loader: constants_1.PREFIX_LOADER, options }],
+    };
+}
+exports.createPrefixLoaderRule = createPrefixLoaderRule;
+function applySemiRules(opts) {
+    const rules = [];
+    if (opts.omitCss) {
+        rules.push(createOmitCssLoaderRule(opts));
+        return rules;
+    }
+    rules.push(createSourceSuffixLoaderRule(opts));
+    rules.push(createThemeLoaderRule(opts));
+    if (opts.prefixCls) {
+        rules.push(createPrefixLoaderRule(opts));
+    }
+    return rules;
+}
+exports.applySemiRules = applySemiRules;

package/lib/types.d.ts

@@ -0,0 +1,10 @@
+export interface SemiWebpackPluginOptions {
+    theme?: SemiThemeOptions | SemiThemeOptions['name'];
+    prefixCls?: string;
+    variables?: Record<string, string | number>;
+    include?: string;
+    omitCss?: boolean;
+}
+export interface SemiThemeOptions {
+    name?: string;
+}

package/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils.d.ts

@@ -0,0 +1,2 @@
+import { SemiWebpackPluginOptions } from './types';
+export declare function stringifyVariableRecord(map?: SemiWebpackPluginOptions['variables']): string;

package/lib/utils.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringifyVariableRecord = void 0;
+function stringifyVariableRecord(map = {}) {
+    let ret = '';
+    for (const [k, v] of Object.entries(map)) {
+        ret += `${k}: ${v};\n`;
+    }
+    return ret;
+}
+exports.stringifyVariableRecord = stringifyVariableRecord;

package/package.json

@@ -0,0 +1,34 @@
+{
+    "name": "@douyinfe/semi-rspack-plugin",
+    "version": "0.0.1-alpha.0",
+    "description": "",
+    "author": "伍浩威 <wuhaowei.whw@bytedance.com>",
+    "homepage": "",
+    "license": "MIT",
+    "main": "lib/index.js",
+    "directories": {
+        "lib": "lib"
+    },
+    "files": [
+        "lib",
+        "README.md"
+    ],
+    "scripts": {
+        "build:lib": "rimraf lib && tsc",
+        "dev": "tsc -w --sourceMap"
+    },
+    "dependencies": {
+        "@babel/core": "^7.15.4",
+        "enhanced-resolve": "^5.8.3"
+    },
+    "peerDependencies": {
+        "webpack": "^5"
+    },
+    "devDependencies": {
+        "@types/loader-utils": "^2.0.3",
+        "rimraf": "^3.0.2",
+        "typescript": "^4",
+        "webpack": "^5.77.0"
+    },
+    "gitHead": "3ac52f8f6f711d525534036ec9be58e81a8eeebd"
+}