Skip to content

feat!: move to ESM first with dual esm/cjs package exports #720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
userquin merged 3 commits into from
Dec 3, 2023
Merged

feat!: move to ESM first with dual esm/cjs package exports #720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09737ef
feat!: move to ESM first with dual esm/cjs package exports
userquin Nov 30, 2023
ad2d303
docs: update readme for webpack, vue-cli, rspack and esbuild
userquin Dec 2, 2023
f11fdf3
chore: include only code snippets for the latest version
userquin Dec 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export default {
module.exports = {
/* ... */
plugins: [
require('unplugin-vue-components/webpack')({ /* options */ }),
require('unplugin-vue-components/webpack').default({ /* options */ }),
],
}
```
Expand All @@ -89,7 +89,7 @@ module.exports = {
module.exports = {
/* ... */
plugins: [
require('unplugin-vue-components/rspack')({ /* options */ }),
require('unplugin-vue-components/rspack').default({ /* options */ }),
],
}
```
Expand All @@ -109,9 +109,22 @@ You might not need this plugin for Nuxt. Use [`@nuxt/components`](https://github
```ts
// vue.config.js
module.exports = {
/* ... */
plugins: [
require('unplugin-vue-components/webpack').default({ /* options */ }),
],
}
```

You can also rename the Vue configuration file to `vue.config.mjs` and use static import syntax (you should use latest `@vue/cli-service ^5.0.8`):
```ts
// vue.config.mjs
import Components from 'unplugin-vue-components/webpack'

export default {
configureWebpack: {
plugins: [
require('unplugin-vue-components/webpack')({ /* options */ }),
Components({ /* options */ }),
],
},
}
Expand All @@ -125,11 +138,12 @@ module.exports = {
```ts
// esbuild.config.js
import { build } from 'esbuild'
import Components from 'unplugin-vue-components/esbuild'

build({
/* ... */
plugins: [
require('unplugin-vue-components/esbuild')({
Components({
/* options */
}),
],
Expand Down
52 changes: 22 additions & 30 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "unplugin-vue-components",
"type": "module",
"version": "0.25.4",
"packageManager": "pnpm@8.7.5",
"description": "Components auto importing for Vue",
Expand All @@ -14,54 +15,45 @@
"bugs": "https://github.com/unplugin/unplugin-vue-components/issues",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.mjs",
"require": "./dist/index.js"
"import": "./dist/index.js",
"require": "./dist/index.cjs"
},
"./nuxt": {
"types": "./dist/nuxt.d.ts",
"import": "./dist/nuxt.mjs",
"require": "./dist/nuxt.js"
"import": "./dist/nuxt.js",
"require": "./dist/nuxt.cjs"
},
"./resolvers": {
"types": "./dist/resolvers.d.ts",
"import": "./dist/resolvers.mjs",
"require": "./dist/resolvers.js"
"import": "./dist/resolvers.js",
"require": "./dist/resolvers.cjs"
},
"./rollup": {
"types": "./dist/rollup.d.ts",
"import": "./dist/rollup.mjs",
"require": "./dist/rollup.js"
"import": "./dist/rollup.js",
"require": "./dist/rollup.cjs"
},
"./types": {
"types": "./dist/types.d.ts",
"import": "./dist/types.mjs",
"require": "./dist/types.js"
"import": "./dist/types.js",
"require": "./dist/types.cjs"
},
"./vite": {
"types": "./dist/vite.d.ts",
"import": "./dist/vite.mjs",
"require": "./dist/vite.js"
"import": "./dist/vite.js",
"require": "./dist/vite.cjs"
},
"./webpack": {
"types": "./dist/webpack.d.ts",
"import": "./dist/webpack.mjs",
"require": "./dist/webpack.js"
"import": "./dist/webpack.js",
"require": "./dist/webpack.cjs"
},
"./rspack": {
"types": "./dist/rspack.d.ts",
"import": "./dist/rspack.mjs",
"require": "./dist/rspack.js"
"import": "./dist/rspack.js",
"require": "./dist/rspack.cjs"
},
"./esbuild": {
"types": "./dist/esbuild.d.ts",
"import": "./dist/esbuild.mjs",
"require": "./dist/esbuild.js"
"import": "./dist/esbuild.js",
"require": "./dist/esbuild.cjs"
},
"./*": "./*"
},
"main": "dist/index.js",
"module": "dist/index.mjs",
"main": "dist/index.cjs",
"module": "dist/index.js",
"types": "index.d.ts",
"typesVersions": {
"*": {
Expand All @@ -77,7 +69,7 @@
"node": ">=14"
},
"scripts": {
"build": "tsup && esno scripts/postbuild.ts",
"build": "tsup",
"dev": "tsup --watch src",
"example:build": "npm -C examples/vite-vue3 run build",
"example:dev": "npm -C examples/vite-vue3 run dev",
Expand Down
21 changes: 0 additions & 21 deletions scripts/postbuild.ts
View file
Open in desktop

This file was deleted.