vite-plugin-svgr 0.1.0 → 0.5.0

package/README.md

@@ -1,16 +1,36 @@
 # vite-plugin-svgr
 
+[![npm](https://img.shields.io/npm/v/vite-plugin-svgr.svg)](https://www.npmjs.com/package/vite-plugin-svgr)
+
 Vite plugin to transform SVGs into React components. Uses [svgr](https://github.com/gregberge/svgr) under the hood.
 
 ## Usage
 
 ```js
 // vite.config.js
-import svgr from 'vite-plugin-svgr'
+import svgrPlugin from 'vite-plugin-svgr'
 
 export default {
   // ...
-  plugins: [svgr()],
+  plugins: [svgrPlugin()],
+}
+```
+
+Then SVG files can be imported as React components, just like [create-react-app](https://create-react-app.dev/docs/adding-images-fonts-and-files#adding-svgs) does:
+
+```js
+import { ReactComponent as Logo } from './logo.svg'
+```
+
+If you are using TypeScript, `vite-plugin-svgr/client` can be added to `tsconfig.json`:
+
+```json
+{
+  // ...
+  "compilerOptions": {
+    // ...
+    "types": ["vite-plugin-svgr/client"]
+  }
 }
 ```
 

package/client.d.ts

@@ -0,0 +1,9 @@
+// https://github.com/facebook/create-react-app/blob/0ee4765c39f820e5f4820abf4bf2e47b3324da7f/packages/react-scripts/lib/react-app.d.ts#L47-L56
+
+declare module '*.svg' {
+  import * as React from 'react'
+
+  export const ReactComponent: React.FunctionComponent<
+    React.SVGProps<SVGSVGElement> & { title?: string }
+  >
+}

package/lib/index.d.ts

@@ -1,3 +1,2 @@
-import type { Plugin } from 'vite';
-declare const _default: () => Plugin;
-export = _default;
+import { Plugin } from 'vite';
+export default function svgrPlugin(): Plugin;

package/lib/index.js

@@ -2,27 +2,29 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
-module.exports = function svgrPlugin() {
+const vite_1 = require("vite");
+function svgrPlugin() {
     // TODO: options
     return {
         name: 'vite:svgr',
         async transform(code, id) {
-            if (id.endsWith('.svg')) {
+            if (id.endsWith('.svg') && !id.includes('node_modules')) {
                 const svgr = require('@svgr/core').default;
-                const esbuild = require('esbuild');
-                const svg = await fs_1.default.promises.readFile(id, 'utf8');
-                const componentCode = await svgr(svg, {}, { componentName: 'ReactComponent' }).then((res) => {
-                    return res.replace('export default ReactComponent', `export { ReactComponent }`);
-                });
-                const res = await esbuild.transform(componentCode + '\n' + code, {
-                    loader: 'jsx',
-                });
+                const svgCode = await fs_1.default.promises.readFile(id, 'utf8');
+                const componentCode = await svgr(svgCode, {}, { componentName: 'ReactComponent' });
+                code =
+                    code +
+                        '\n' +
+                        componentCode.replace('export default ReactComponent', 'export { ReactComponent }');
+                const res = await (0, vite_1.transformWithEsbuild)(code, id, { loader: 'jsx' });
                 return {
                     code: res.code,
-                    map: res.map,
+                    map: null, // TODO:
                 };
             }
         },
     };
-};
+}
+exports.default = svgrPlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-svgr",
-  "version": "0.1.0",
+  "version": "0.5.0",
   "description": "Vite plugin to transform SVGs into React components",
   "main": "lib/index.js",
   "scripts": {
@@ -8,31 +8,26 @@
     "build": "tsc",
     "prepublish": "npm run build"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/pd4d10/vite-plugin-svgr.git"
-  },
+  "repository": "pd4d10/vite-plugin-svgr",
   "files": [
-    "lib"
+    "lib",
+    "client.d.ts"
   ],
   "keywords": [
-    "vite"
+    "vite",
+    "vite-plugin"
   ],
   "author": "Rongjian Zhang",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/pd4d10/vite-plugin-svgr/issues"
-  },
-  "homepage": "https://github.com/pd4d10/vite-plugin-svgr#readme",
   "devDependencies": {
-    "typescript": "^4.1.3",
-    "vite": "^2.0.0-beta.15",
-    "@types/node": "^14.14.20"
+    "@types/node": "^16.11.6",
+    "typescript": "^4.4.4",
+    "vite": "^2.6.13"
   },
   "peerDependencies": {
-    "vite": "^2.0.0-beta.1"
+    "vite": "^2.0.0"
   },
   "dependencies": {
-    "@svgr/core": "^5.5.0"
+    "@svgr/core": "^6.0.0-alpha.2"
   }
 }