@rsbuild/plugin-vue2 1.0.1-beta.8 → 1.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+Copyright (c) 2024 Rspack Contrib
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,19 +1,125 @@
-<p align="center">
-  <a href="https://rsbuild.dev" target="blank"><img src="https://github.com/web-infra-dev/rsbuild/assets/7237365/84abc13e-b620-468f-a90b-dbf28e7e9427" alt="Rsbuild Logo" /></a>
+# @rsbuild/plugin-vue2
+
+Provides support for Vue 2 SFC (Single File Components). The plugin internally integrates [vue-loader](https://vue-loader.vuejs.org/) v15.
+
+> @rsbuild/plugin-vue2 only supports Vue >= 2.7.0.
+
+<p>
+  <a href="https://npmjs.com/package/@rsbuild/plugin-vue2">
+   <img src="https://img.shields.io/npm/v/@rsbuild/plugin-vue2?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
+  </a>
+  <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
 </p>
 
-# Rsbuild
+## Usage
+
+Install:
+
+```bash
+npm add @rsbuild/plugin-vue2 -D
+```
+
+Add plugin to your `rsbuild.config.ts`:
+
+```ts
+// rsbuild.config.ts
+import { pluginVue2 } from "@rsbuild/plugin-vue2";
+
+export default {
+  plugins: [pluginVue2()],
+};
+```
+
+After registering the plugin, you can import `*.vue` files in your code.
+
+## Options
+
+If you need to customize the compilation behavior of Vue, you can use the following configs.
+
+### vueLoaderOptions
+
+Options passed to `vue-loader`, please refer to the [vue-loader documentation](https://vue-loader.vuejs.org/) for detailed usage.
+
+- **Type:** `VueLoaderOptions`
+- **Default:**
+
+```js
+const defaultOptions = {
+  compilerOptions: {
+    whitespace: "condense",
+  },
+  experimentalInlineMatchResource: true,
+};
+```
+
+- **Example:**
+
+```ts
+pluginVue2({
+  vueLoaderOptions: {
+    hotReload: false,
+  },
+});
+```
+
+> The Vue 2 plugin is using the `vue-loader` v15. Please be aware that there may be configuration differences between v15 and the latest version.
+
+### splitChunks
+
+When [chunkSplit.strategy](/config/performance/chunk-split) set to `split-by-experience`, Rsbuild will automatically split `vue` and `router` related packages into separate chunks by default:
+
+- `lib-vue.js`: includes vue, vue-loader.
+- `lib-router.js`: includes vue-router.
+
+This option is used to control this behavior and determine whether the `vue` and `router` related packages need to be split into separate chunks.
+
+- **Type:**
+
+```ts
+type SplitVueChunkOptions = {
+  vue?: boolean;
+  router?: boolean;
+};
+```
+
+- **Default:**
+
+```ts
+const defaultOptions = {
+  vue: true,
+  router: true,
+};
+```
+
+- **Example:**
+
+```ts
+pluginVue({
+  splitChunks: {
+    vue: false,
+    router: false,
+  },
+});
+```
+
+## FAQ
 
-The Rspack-based build tool. It's fast, out-of-the-box and extensible.
+### /deep/ selector causes compilation error
 
-## Documentation
+`/deep/` is a deprecated usage as of Vue v2.7. Since it is not a valid CSS syntax, CSS compilation tools like Lightning CSS will fail to compile it.
 
-https://rsbuild.dev/
+You can use `:deep()` instead. See [Vue - Deep Selectors](https://vuejs.org/api/sfc-css-features.html#deep-selectors) for more details.
 
-## Contributing
+```html
+<style scoped>
+  .a :deep(.b) {
+    /* ... */
+  }
+</style>
+```
 
-Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
+> You can also refer to [Vue - RFC 0023](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0023-scoped-styles-changes.md) for more details.
 
 ## License
 
-Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
+[MIT](./LICENSE).

package/dist/index.cjs

@@ -1,11 +1,8 @@
 "use strict";
-var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -18,19 +15,7 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 
 // src/index.ts
 var src_exports = {};
@@ -39,19 +24,25 @@ __export(src_exports, {
   pluginVue2: () => pluginVue2
 });
 module.exports = __toCommonJS(src_exports);
+
+// node_modules/.pnpm/tsup@8.2.3_postcss@8.4.38_typescript@5.5.4/node_modules/tsup/assets/cjs_shims.js
+var getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
+var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
+
+// src/index.ts
+var import_node_module = require("module");
 var import_vue_loader = require("vue-loader");
 
 // src/VueLoader15PitchFixPlugin.ts
 var VueLoader15PitchFixPlugin = class {
   constructor() {
-    __publicField(this, "name", "VueLoader15PitchFixPlugin");
+    this.name = "VueLoader15PitchFixPlugin";
   }
   apply(compiler) {
     const { NormalModule } = compiler.webpack;
     compiler.hooks.compilation.tap(this.name, (compilation) => {
       const isExpCssOn = compilation.compiler.options?.experiments?.css;
-      if (!isExpCssOn)
-        return;
+      if (!isExpCssOn) return;
       NormalModule.getCompilationHooks(compilation).loader.tap(
         this.name,
         (loaderContext) => {
@@ -124,6 +115,7 @@ var applySplitChunksRule = (api, options = {
 };
 
 // src/index.ts
+var require2 = (0, import_node_module.createRequire)(importMetaUrl);
 var PLUGIN_VUE2_NAME = "rsbuild:vue2";
 function pluginVue2(options = {}) {
   return {
@@ -159,7 +151,7 @@ function pluginVue2(options = {}) {
           compilerOptions
         };
         const rule = chain.module.rule(CHAIN_ID.RULE.VUE);
-        rule.test(VUE_REGEXP).use(CHAIN_ID.USE.VUE).loader(require.resolve("vue-loader")).options(vueLoaderOptions);
+        rule.test(VUE_REGEXP).use(CHAIN_ID.USE.VUE).loader(require2.resolve("vue-loader")).options(vueLoaderOptions);
         if (chain.module.rules.has(CHAIN_ID.RULE.JS)) {
           applyResolveConfig(rule, chain.module.rule(CHAIN_ID.RULE.JS));
         }

package/dist/index.d.cts

@@ -0,0 +1,30 @@
+import { RsbuildPlugin } from '@rsbuild/core';
+import { VueLoaderOptions } from 'vue-loader';
+
+type SplitVueChunkOptions = {
+    /**
+     * Whether to enable split chunking for Vue-related dependencies (e.g., vue, vue-loader).
+     * @default true
+     */
+    vue?: boolean;
+    /**
+     * Whether to enable split chunking for vue-router.
+     * @default true
+     */
+    router?: boolean;
+};
+type PluginVueOptions = {
+    /**
+     * Options passed to `vue-loader`.
+     * @see https://vue-loader.vuejs.org/
+     */
+    vueLoaderOptions?: VueLoaderOptions;
+    /**
+     * This option is used to control the split chunks behavior.
+     */
+    splitChunks?: SplitVueChunkOptions;
+};
+declare const PLUGIN_VUE2_NAME = "rsbuild:vue2";
+declare function pluginVue2(options?: PluginVueOptions): RsbuildPlugin;
+
+export { PLUGIN_VUE2_NAME, type PluginVueOptions, type SplitVueChunkOptions, pluginVue2 };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-import type { RsbuildPlugin } from '@rsbuild/core';
-import { type VueLoaderOptions } from 'vue-loader';
-export type SplitVueChunkOptions = {
+import { RsbuildPlugin } from '@rsbuild/core';
+import { VueLoaderOptions } from 'vue-loader';
+
+type SplitVueChunkOptions = {
     /**
      * Whether to enable split chunking for Vue-related dependencies (e.g., vue, vue-loader).
      * @default true
@@ -12,7 +13,7 @@ export type SplitVueChunkOptions = {
      */
     router?: boolean;
 };
-export type PluginVueOptions = {
+type PluginVueOptions = {
     /**
      * Options passed to `vue-loader`.
      * @see https://vue-loader.vuejs.org/
@@ -23,5 +24,7 @@ export type PluginVueOptions = {
      */
     splitChunks?: SplitVueChunkOptions;
 };
-export declare const PLUGIN_VUE2_NAME = "rsbuild:vue2";
-export declare function pluginVue2(options?: PluginVueOptions): RsbuildPlugin;
+declare const PLUGIN_VUE2_NAME = "rsbuild:vue2";
+declare function pluginVue2(options?: PluginVueOptions): RsbuildPlugin;
+
+export { PLUGIN_VUE2_NAME, type PluginVueOptions, type SplitVueChunkOptions, pluginVue2 };

package/dist/index.js

@@ -1,38 +1,17 @@
-import { createRequire } from 'module';
-var require = createRequire(import.meta['url']);
-
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined")
-    return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-
-// ../../node_modules/.pnpm/@modern-js+module-tools@2.56.2_typescript@5.5.2/node_modules/@modern-js/module-tools/shims/esm.js
-import { fileURLToPath } from "url";
-import path from "path";
-
 // src/index.ts
+import { createRequire } from "node:module";
 import { VueLoaderPlugin } from "vue-loader";
 
 // src/VueLoader15PitchFixPlugin.ts
 var VueLoader15PitchFixPlugin = class {
   constructor() {
-    __publicField(this, "name", "VueLoader15PitchFixPlugin");
+    this.name = "VueLoader15PitchFixPlugin";
   }
   apply(compiler) {
     const { NormalModule } = compiler.webpack;
     compiler.hooks.compilation.tap(this.name, (compilation) => {
       const isExpCssOn = compilation.compiler.options?.experiments?.css;
-      if (!isExpCssOn)
-        return;
+      if (!isExpCssOn) return;
       NormalModule.getCompilationHooks(compilation).loader.tap(
         this.name,
         (loaderContext) => {
@@ -105,6 +84,7 @@ var applySplitChunksRule = (api, options = {
 };
 
 // src/index.ts
+var require2 = createRequire(import.meta.url);
 var PLUGIN_VUE2_NAME = "rsbuild:vue2";
 function pluginVue2(options = {}) {
   return {
@@ -114,11 +94,11 @@ function pluginVue2(options = {}) {
       const CSS_MODULES_REGEX = /\.modules?\.\w+$/i;
       api.modifyEnvironmentConfig((config) => {
         if (config.output.cssModules.auto === true) {
-          config.output.cssModules.auto = (path2, query) => {
-            if (VUE_REGEXP.test(path2)) {
+          config.output.cssModules.auto = (path, query) => {
+            if (VUE_REGEXP.test(path)) {
               return query.includes("type=style") && query.includes("module=true");
             }
-            return CSS_MODULES_REGEX.test(path2);
+            return CSS_MODULES_REGEX.test(path);
           };
         }
         return config;
@@ -140,7 +120,7 @@ function pluginVue2(options = {}) {
           compilerOptions
         };
         const rule = chain.module.rule(CHAIN_ID.RULE.VUE);
-        rule.test(VUE_REGEXP).use(CHAIN_ID.USE.VUE).loader(__require.resolve("vue-loader")).options(vueLoaderOptions);
+        rule.test(VUE_REGEXP).use(CHAIN_ID.USE.VUE).loader(require2.resolve("vue-loader")).options(vueLoaderOptions);
         if (chain.module.rules.has(CHAIN_ID.RULE.JS)) {
           applyResolveConfig(rule, chain.module.rule(CHAIN_ID.RULE.JS));
         }

package/package.json

@@ -1,13 +1,7 @@
 {
   "name": "@rsbuild/plugin-vue2",
-  "version": "1.0.1-beta.8",
-  "description": "Vue 2 plugin of Rsbuild",
-  "homepage": "https://rsbuild.dev",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/web-infra-dev/rsbuild",
-    "directory": "packages/plugin-vue2"
-  },
+  "version": "1.0.1",
+  "repository": "https://github.com/rspack-contrib/rsbuild-plugin-vue2",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -17,31 +11,54 @@
       "require": "./dist/index.cjs"
     }
   },
-  "main": "./dist/index.cjs",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
+  "simple-git-hooks": {
+    "pre-commit": "npx nano-staged"
+  },
+  "nano-staged": {
+    "*.{js,jsx,ts,tsx,mjs,cjs}": [
+      "biome check --write --no-errors-on-unmatched"
+    ]
+  },
   "dependencies": {
     "vue-loader": "^15.11.1",
     "webpack": "^5.93.0"
   },
   "devDependencies": {
-    "typescript": "^5.5.2",
-    "webpack": "^5.93.0",
-    "@rsbuild/core": "1.0.1-beta.8",
-    "@scripts/test-helper": "1.0.1-beta.8"
+    "@biomejs/biome": "^1.8.3",
+    "@playwright/test": "^1.45.3",
+    "@rsbuild/core": "^1.0.1-beta.16",
+    "@rsbuild/plugin-less": "1.0.1-beta.16",
+    "@types/node": "^20.14.13",
+    "nano-staged": "^0.8.0",
+    "playwright": "^1.45.3",
+    "simple-git-hooks": "^2.11.1",
+    "tsup": "^8.2.3",
+    "typescript": "^5.5.4",
+    "vue": "^2.7.14"
   },
   "peerDependencies": {
-    "@rsbuild/core": "^1.0.1-beta.8"
+    "@rsbuild/core": "1.x || ^1.0.1-beta.0"
+  },
+  "peerDependenciesMeta": {
+    "@rsbuild/core": {
+      "optional": true
+    }
   },
   "publishConfig": {
     "access": "public",
-    "provenance": true,
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "modern build",
-    "dev": "modern build --watch"
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "biome check .",
+    "lint:write": "biome check . --write",
+    "test": "playwright test"
   }
 }

package/dist/VueLoader15PitchFixPlugin.d.ts

@@ -1,8 +0,0 @@
-import type { Rspack } from '@rsbuild/core';
-/**
- * this plugin is a quick fix for issue https://github.com/web-infra-dev/rsbuild/issues/2093
- */
-export declare class VueLoader15PitchFixPlugin implements Rspack.RspackPluginInstance {
-    readonly name = "VueLoader15PitchFixPlugin";
-    apply(compiler: Rspack.Compiler): void;
-}

package/dist/splitChunks.d.ts

@@ -1,3 +0,0 @@
-import type { RsbuildPluginAPI } from '@rsbuild/core';
-import type { SplitVueChunkOptions } from '.';
-export declare const applySplitChunksRule: (api: RsbuildPluginAPI, options?: SplitVueChunkOptions) => void;