refactor!: rename package to unplugin-vue2-script-setup

antfu · antfu · commit 4af8ae4afcb4 · 2021-08-24T16:21:41.000+08:00
diff --git a/.npmrc b/.npmrc
@@ -1 +1,2 @@
 shamefully-hoist=true
+ignore-workspace-root-check=true
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
-# vue2-script-setup-transform
+# unplugin-vue2-script-setup
 
-[![NPM version](https://img.shields.io/npm/v/vue2-script-setup-transform?color=a1b858&label=)](https://www.npmjs.com/package/vue2-script-setup-transform)
+[![NPM version](https://img.shields.io/npm/v/unplugin-vue2-script-setup?color=a1b858&label=)](https://www.npmjs.com/package/unplugin-vue2-script-setup)
 
 Bring [`<script setup>`](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to Vue 2.
 
 ## Install
 
 ```bash
-npm i -D vue2-script-setup-transform
+npm i -D unplugin-vue2-script-setup
 npm i @vue/composition-api
 ```
 
@@ -27,7 +27,7 @@ Vue.use(VueCompositionAPI)
 // vite.config.ts
 import { defineConfig } from 'vite'
 import { createVuePlugin as Vue2 } from 'vite-plugin-vue2'
-import ScriptSetup from 'vue2-script-setup-transform/vite-plugin'
+import ScriptSetup from 'unplugin-vue2-script-setup/vite'
 
 export default defineConfig({
   plugins: [
@@ -53,7 +53,7 @@ npm i @nuxtjs/composition-api
 export default {
   buildModules: [
     '@nuxtjs/composition-api/module',
-    'vue2-script-setup-transform/nuxt',
+    'unplugin-vue2-script-setup/nuxt',
   ],
 }
 ```
@@ -76,7 +76,7 @@ export default {
   buildModules: [
     ['@nuxt/typescript-build', { typeCheck: false }],
     '@nuxtjs/composition-api/module',
-    'vue2-script-setup-transform/nuxt',
+    'unplugin-vue2-script-setup/nuxt',
   ],
 }
 ```
@@ -104,7 +104,7 @@ And then use [`vue-tsc`](https://github.com/johnsoncodehk/volar) to do the type
 module.exports = {
   configureWebpack: {
     plugins: [
-      require('vue2-script-setup-transform/webpack-plugin').default(),
+      require('unplugin-vue2-script-setup/webpack')(),
     ],
   },
 }
@@ -124,7 +124,7 @@ npm i -D @vue/cli-plugin-typescript vue-tsc
 module.exports = {
   configureWebpack: {
     plugins: [
-      require('vue2-script-setup-transform/webpack-plugin').default(),
+      require('unplugin-vue2-script-setup/webpack')(),
     ],
   },
   chainWebpack(config) {
@@ -156,7 +156,7 @@ And then use [`vue-tsc`](https://github.com/johnsoncodehk/volar) to do the type
 module.exports = {
   /* ... */
   plugins: [
-    require('vue2-script-setup-transform/webpack-plugin').default()
+    require('unplugin-vue2-script-setup/webpack')()
   ]
 }
 ```
@@ -167,7 +167,7 @@ module.exports = {
 <summary>JavaScript API</summary><br>
 
 ```ts
-import { transform } from 'vue2-script-setup-transform'
+import { transform } from 'unplugin-vue2-script-setup'
 
 const Vue2SFC = transform(`
 <template>
@@ -202,7 +202,7 @@ If the global types are missing for your IDE, update your `tsconfig.json` with:
 {
   "compilerOptions": {
     "types": [
-      "vue2-script-setup-transform/types"
+      "unplugin-vue2-script-setup/types"
     ]
   }
 }
diff --git a/examples/nuxt/nuxt.config.js b/examples/nuxt/nuxt.config.js
@@ -5,6 +5,6 @@ export default {
     // @vue/composition-api support
     '@nuxtjs/composition-api/module',
     // install the transformer
-    'vue2-script-setup-transform/nuxt',
+    'unplugin-vue2-script-setup/nuxt',
   ],
 }
diff --git a/examples/nuxt/package.json b/examples/nuxt/package.json
@@ -17,6 +17,6 @@
     "@nuxtjs/composition-api": "^0.27.0",
     "@vue/runtime-dom": "^3.2.4",
     "vue-tsc": "^0.3.0",
-    "vue2-script-setup-transform": "workspace:*"
+    "unplugin-vue2-script-setup": "workspace:*"
   }
 }
diff --git a/examples/nuxt/tsconfig.json b/examples/nuxt/tsconfig.json
@@ -26,7 +26,7 @@
     "types": [
       "@types/node",
       "@nuxt/types",
-      "vue2-script-setup-transform/types"
+      "unplugin-vue2-script-setup/types"
     ]
   },
   "exclude": [
diff --git a/examples/vue-cli/package.json b/examples/vue-cli/package.json
@@ -17,6 +17,6 @@
     "typescript": "~4.1.5",
     "vue-template-compiler": "^2.6.11",
     "vue-tsc": "^0.3.0",
-    "vue2-script-setup-transform": "workspace:*"
+    "unplugin-vue2-script-setup": "workspace:*"
   }
 }
diff --git a/examples/vue-cli/tsconfig.json b/examples/vue-cli/tsconfig.json
@@ -13,7 +13,7 @@
     "baseUrl": ".",
     "types": [
       "webpack-env",
-      "vue2-script-setup-transform/types"
+      "unplugin-vue2-script-setup/types"
     ],
     "paths": {
       "@/*": [
diff --git a/examples/vue-cli/vue.config.js b/examples/vue-cli/vue.config.js
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 
-const ScriptSetup = require('vue2-script-setup-transform/webpack-plugin').default
+const ScriptSetup = require('unplugin-vue2-script-setup/webpack')
 
 /**
  * @type {import('@vue/cli-service').ProjectOptions}
diff --git a/nuxt.d.ts b/nuxt.d.ts
@@ -1,3 +1 @@
-import './shims'
-export * from './dist/nuxt'
 export { default } from './dist/nuxt'
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "vue2-script-setup-transform",
+  "name": "unplugin-vue2-script-setup",
   "version": "0.3.5",
-  "description": "",
+  "description": "Bring <script setup> to Vue 2",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "index.d.ts",
@@ -10,21 +10,17 @@
       "require": "./dist/index.js",
       "import": "./dist/index.mjs"
     },
-    "./vite-plugin": {
-      "require": "./dist/vite-plugin.js",
-      "import": "./dist/vite-plugin.mjs"
+    "./vite": {
+      "require": "./dist/vite.js",
+      "import": "./dist/vite.mjs"
     },
-    "./webpack-plugin": {
-      "require": "./dist/webpack-plugin.js",
-      "import": "./dist/webpack-plugin.mjs"
+    "./webpack": {
+      "require": "./dist/webpack.js",
+      "import": "./dist/webpack.mjs"
     },
-    "./rollup-plugin": {
-      "require": "./dist/rollup-plugin.js",
-      "import": "./dist/rollup-plugin.mjs"
-    },
-    "./unplugin": {
-      "require": "./dist/unplugin.js",
-      "import": "./dist/unplugin.mjs"
+    "./rollup": {
+      "require": "./dist/rollup.js",
+      "import": "./dist/rollup.mjs"
     },
     "./nuxt": {
       "require": "./dist/nuxt.js",
@@ -40,12 +36,12 @@
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/antfu/vue2-script-setup-transform/issues"
+    "url": "https://github.com/antfu/unplugin-vue2-script-setup/issues"
   },
-  "homepage": "https://github.com/antfu/vue2-script-setup-transform#readme",
+  "homepage": "https://github.com/antfu/unplugin-vue2-script-setup#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/antfu/vue2-script-setup-transform.git"
+    "url": "git+https://github.com/antfu/unplugin-vue2-script-setup.git"
   },
   "keywords": [],
   "files": [
@@ -54,8 +50,8 @@
   ],
   "scripts": {
     "prepublishOnly": "nr build",
-    "dev": "nr build --watch",
-    "build": "rimraf dist && tsup 'src/*.ts' --format cjs,esm --dts",
+    "build": "rimraf dist && tsup 'src/*.ts' --format cjs,esm --dts && esno scripts/postbuild.ts",
+    "dev": "tsup 'src/*.ts' --watch src",
     "play": "npm -C playground run dev",
     "release": "bumpp --commit --push --tag && pnpm publish",
     "lint": "eslint \"{src,test}/**/*.ts\"",
diff --git a/playground/vite.config.ts b/playground/vite.config.ts
@@ -1,7 +1,7 @@
 import { defineConfig } from 'vite'
 import { createVuePlugin as Vue2 } from 'vite-plugin-vue2'
 import Inspect from 'vite-plugin-inspect'
-import ScriptSetup from '../src/vite-plugin'
+import ScriptSetup from '../src/vite'
 
 export default defineConfig({
   plugins: [
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/rollup-plugin.d.ts b/rollup-plugin.d.ts
diff --git a/rollup.d.ts b/rollup.d.ts
@@ -0,0 +1 @@
+export { default } from './dist/rollup'
diff --git a/scripts/postbuild.ts b/scripts/postbuild.ts
@@ -0,0 +1,25 @@
+import { resolve } from 'path'
+import { promises as fs } from 'fs'
+import { basename } from 'path/posix'
+import fg from 'fast-glob'
+
+async function run() {
+  // fix cjs exports
+  const files = await fg('*.js', {
+    ignore: ['index.js', 'chunk-*'],
+    absolute: true,
+    cwd: resolve(__dirname, '../dist'),
+  })
+  for (const file of files) {
+    // eslint-disable-next-line no-console
+    console.log('[postbuild]', basename(file))
+    const name = basename(file, '.js')
+    let code = await fs.readFile(file, 'utf8')
+    code = code.replace('exports.default =', 'module.exports =')
+    code += 'exports.default = module.exports;'
+    await fs.writeFile(file, code)
+    await fs.writeFile(`${name}.d.ts`, `export { default } from './dist/${name}'\n`)
+  }
+}
+
+run()
diff --git a/src/index.ts b/src/index.ts
@@ -1,2 +1,25 @@
+import { createUnplugin } from 'unplugin'
+import { ScriptSetupTransformOptions } from './types'
+import { transform } from '.'
+
 export * from './core/transform'
 export * from './types'
+
+const scriptSetupRE = /<script\s+setup/
+
+export default createUnplugin<ScriptSetupTransformOptions>(options => ({
+  name: 'unplugin-vue2-script-setup',
+  enforce: 'pre',
+  transformInclude(id) {
+    return id.endsWith('.vue')
+  },
+  transform(code, id) {
+    try {
+      if (scriptSetupRE.test(code))
+        return transform(code, id, options)
+    }
+    catch (e) {
+      this.error(e)
+    }
+  },
+}))
diff --git a/src/nuxt.ts b/src/nuxt.ts
@@ -1,4 +1,4 @@
-import unplugin from './unplugin'
+import unplugin from '.'
 
 export default function(this: any) {
   // install webpack plugin
diff --git a/src/rollup-plugin.ts b/src/rollup-plugin.ts
diff --git a/src/rollup.ts b/src/rollup.ts
@@ -0,0 +1,3 @@
+import unplugin from '.'
+
+export default unplugin.rollup
diff --git a/src/unplugin.ts b/src/unplugin.ts
diff --git a/src/vite-plugin.ts b/src/vite-plugin.ts
diff --git a/src/vite.ts b/src/vite.ts
@@ -0,0 +1,3 @@
+import unplugin from '.'
+
+export default unplugin.vite
diff --git a/src/webpack-plugin.ts b/src/webpack-plugin.ts
diff --git a/src/webpack.ts b/src/webpack.ts
@@ -0,0 +1,3 @@
+import unplugin from '.'
+
+export default unplugin.webpack
diff --git a/types.d.ts b/types.d.ts
@@ -1,2 +1 @@
-import './shims'
-export * from './dist/types'
+export { default } from './dist/types'
diff --git a/unplugin.d.ts b/unplugin.d.ts
diff --git a/vite-plugin.d.ts b/vite-plugin.d.ts
diff --git a/vite.d.ts b/vite.d.ts
@@ -0,0 +1 @@
+export { default } from './dist/vite'
diff --git a/webpack-plugin.d.ts b/webpack-plugin.d.ts
diff --git a/webpack.d.ts b/webpack.d.ts
@@ -0,0 +1 @@
+export { default } from './dist/webpack'

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`shamefully-hoist=true`
	`2`	`+ignore-workspace-root-check=true`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,6 @@ export default {`
`5`	`5`	`// @vue/composition-api support`
`6`	`6`	`'@nuxtjs/composition-api/module',`
`7`	`7`	`// install the transformer`
`8`		`- 'vue2-script-setup-transform/nuxt',`
	`8`	`+ 'unplugin-vue2-script-setup/nuxt',`
`9`	`9`	`],`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,6 @@`
`17`	`17`	`"@nuxtjs/composition-api": "^0.27.0",`
`18`	`18`	`"@vue/runtime-dom": "^3.2.4",`
`19`	`19`	`"vue-tsc": "^0.3.0",`
`20`		`- "vue2-script-setup-transform": "workspace:*"`
	`20`	`+ "unplugin-vue2-script-setup": "workspace:*"`
`21`	`21`	`}`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`"types": [`
`27`	`27`	`"@types/node",`
`28`	`28`	`"@nuxt/types",`
`29`		`- "vue2-script-setup-transform/types"`
	`29`	`+ "unplugin-vue2-script-setup/types"`
`30`	`30`	`]`
`31`	`31`	`},`
`32`	`32`	`"exclude": [`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1 @@`
`1`		`-import './shims'`
`2`		`-export * from './dist/nuxt'`
`3`	`1`	`export { default } from './dist/nuxt'`