diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 536a6f49..288ec82c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -4,9 +4,11 @@ on: push: branches: - main + - 'v*' pull_request: branches: - main + - 'v*' jobs: lint: @@ -15,8 +17,8 @@ jobs: - name: Checkout uses: actions/checkout@v4 - - name: Enable Corepack - run: corepack enable + - name: Install pnpm + uses: pnpm/action-setup@v4.1.0 - name: Setup node uses: actions/setup-node@v4 @@ -34,20 +36,15 @@ jobs: strategy: matrix: os: [ubuntu-latest, macos-latest, windows-latest] - node: [18, 20, 22] + node: [18, 20, 22, 24] fail-fast: false steps: - name: Checkout uses: actions/checkout@v4 - - name: Set node version to ${{ matrix.node }} - uses: actions/setup-node@v4 - with: - node-version: ${{ matrix.node }} - - - name: Enable Corepack - run: corepack enable + - name: Install pnpm + uses: pnpm/action-setup@v4.1.0 - name: Set node version to ${{ matrix.node }} uses: actions/setup-node@v4 diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 1a690bf0..8fee4941 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -14,19 +14,23 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + + - name: Install pnpm + uses: pnpm/action-setup@v4.1.0 + - name: Set node uses: actions/setup-node@v4 with: node-version: lts/* - - run: corepack enable - - run: npm i -g @antfu/ni - - run: nci + cache: pnpm + + - run: pnpm i - name: Build unplugin - run: nr build + run: pnpm run build - name: Build docs - run: nr docs:build + run: pnpm run docs:build env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/publish-commit.yml b/.github/workflows/publish-commit.yml index f881f1fe..81e4671c 100644 --- a/.github/workflows/publish-commit.yml +++ b/.github/workflows/publish-commit.yml @@ -7,7 +7,10 @@ jobs: steps: - uses: actions/checkout@v4 - - run: corepack enable + + - name: Install pnpm + uses: pnpm/action-setup@v4.1.0 + - uses: actions/setup-node@v4 with: node-version: lts/* diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000..7b5ef185 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,6 @@ +{ + "recommendations": [ + "dbaeumer.vscode-eslint", + "antfu.pnpm-catalog-lens" + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json index 0967ef42..78994605 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1 +1,37 @@ -{} +{ + "prettier.enable": false, + "editor.formatOnSave": false, + + // Auto fix + "editor.codeActionsOnSave": { + "source.fixAll.eslint": "explicit", + "source.organizeImports": "never" + }, + + // Silent the stylistic rules in you IDE, but still auto fix them + "eslint.rules.customizations": [ + { "rule": "style/*", "severity": "off" }, + { "rule": "*-indent", "severity": "off" }, + { "rule": "*-spacing", "severity": "off" }, + { "rule": "*-spaces", "severity": "off" }, + { "rule": "*-order", "severity": "off" }, + { "rule": "*-dangle", "severity": "off" }, + { "rule": "*-newline", "severity": "off" }, + { "rule": "*quotes", "severity": "off" }, + { "rule": "*semi", "severity": "off" } + ], + + // Enable eslint for all supported languages + "eslint.validate": [ + "javascript", + "javascriptreact", + "typescript", + "typescriptreact", + "vue", + "html", + "markdown", + "json", + "jsonc", + "yaml" + ] +} diff --git a/README.md b/README.md index 4dae3169..2f7157fa 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,12 @@ Unified plugin system for build tools. Currently supports: -- [Vite](https://vitejs.dev/) +- [Vite](https://vite.dev/) - [Rollup](https://rollupjs.org/) - [Webpack](https://webpack.js.org/) - [esbuild](https://esbuild.github.io/) - [Rspack](https://www.rspack.dev/) -- [Rolldown](https://rolldown.rs/) (⚠️ experimental) +- [Rolldown](https://rolldown.rs/) - [Farm](https://www.farmfe.org/) - And every framework built on top of them. diff --git a/docs/guide/index.md b/docs/guide/index.md index 0d44cfac..082ff1e5 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -11,12 +11,12 @@ lastUpdated: false **Unplugin** current supports: -- [Vite](https://vitejs.dev/) +- [Vite](https://vite.dev/) - [Rollup](https://rollupjs.org/) -- [Webpack](https://webpack.js.org/) +- [webpack](https://webpack.js.org/) - [esbuild](https://esbuild.github.io/) - [Rspack](https://www.rspack.dev/) -- [Rolldown](https://rolldown.rs/) (⚠️ experimental) +- [Rolldown](https://rolldown.rs/) - [Farm](https://www.farmfe.org/) ## Trying It Online @@ -39,7 +39,7 @@ Check repositories above for more details. ### Pre-requisites - Node.js 18.12.0 or later. -- Webpack 5 or later, if you are using Webpack. +- webpack 5 or later, if you are using webpack. ### Install package @@ -193,14 +193,14 @@ export default defineConfig({ ## Supported Hooks -| Hook | Rollup | Vite | Webpack | esbuild | Rspack | Farm | Rolldown | +| Hook | Rollup | Vite | webpack | esbuild | Rspack | Farm | Rolldown | | --------------------------------------------------------------------------------- | :-------------: | :--: | :-----: | :-------------: | :-------------: | :--: | :------: | -| [`enforce`](https://vitejs.dev/guide/api-plugin.html#plugin-ordering) | ❌ 1 | ✅ | ✅ | ❌ 1 | ✅ | ✅ | ✅ | +| [`enforce`](https://vite.dev/guide/api-plugin.html#plugin-ordering) | ❌ 1 | ✅ | ✅ | ❌ 1 | ✅ | ✅ | ✅ | | [`buildStart`](https://rollupjs.org/plugin-development/#buildstart) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | [`resolveId`](https://rollupjs.org/plugin-development/#resolveid) | ✅ | ✅ | ✅ | ✅ | ✅ 5 | ✅ | ✅ | -| `loadInclude`2 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| ~~`loadInclude`~~2 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | [`load`](https://rollupjs.org/plugin-development/#load) | ✅ | ✅ | ✅ | ✅ 3 | ✅ | ✅ | ✅ | -| `transformInclude`2 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| ~~`transformInclude`~~2 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | [`transform`](https://rollupjs.org/plugin-development/#transform) | ✅ | ✅ | ✅ | ✅ 3 | ✅ | ✅ | ✅ | | [`watchChange`](https://rollupjs.org/plugin-development/#watchchange) | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | | [`buildEnd`](https://rollupjs.org/plugin-development/#buildend) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | @@ -209,11 +209,14 @@ export default defineConfig({ ::: details Notice 1. Rollup and esbuild do not support using `enforce` to control the order of plugins. Users need to maintain the order manually. -2. webpack's id filter is outside of loader logic; an additional hook is needed for better perf on webpack. In Rollup and Vite, this hook has been polyfilled to match the behaviors. See for the following usage examples. +2. Webpack's id filter is outside of loader logic; an additional hook is needed for better performance on Webpack and Rolldown. + However, it is now deprecated. Please use `transform/load/resolveId.filter` instead. + In Rollup, this hook has been polyfilled to match the behaviors. See the following usage examples for reference. 3. Although esbuild can handle both JavaScript and CSS and many other file formats, you can only return JavaScript in `load` and `transform` results. 4. Currently, `writeBundle` is only serves as a hook for the timing. It doesn't pass any arguments. 5. Rspack supports `resolveId` with a minimum required version of v1.0.0-alpha.1. - ::: + +::: ### Usage @@ -227,14 +230,14 @@ export interface Options { export const unpluginFactory: UnpluginFactory = options => ({ name: 'unplugin-starter', - // webpack's id filter is outside of loader logic, - // an additional hook is needed for better perf on webpack - transformInclude(id) { - return id.endsWith('main.ts') - }, - // just like rollup transform - transform(code) { - return code.replace(/