vite-plugin-svgr 1.0.0 → 2.0.0

package/README.md

@@ -8,18 +8,11 @@ Vite plugin to transform SVGs into React components. Uses [svgr](https://github.
 
 ```js
 // vite.config.js
-import svgrPlugin from 'vite-plugin-svgr'
+import svgr from 'vite-plugin-svgr'
 
 export default {
   // ...
-  plugins: [
-    svgrPlugin({
-      svgrOptions: {
-        icon: true,
-        // ...svgr options (https://react-svgr.com/docs/options/)
-      },
-    }),
-  ],
+  plugins: [svgr()],
 }
 ```
 
@@ -29,16 +22,30 @@ Then SVG files can be imported as React components, just like [create-react-app]
 import { ReactComponent as Logo } from './logo.svg'
 ```
 
-If you are using TypeScript, `vite-plugin-svgr/client` can be added to `tsconfig.json`:
+If you are using TypeScript, there is also a declaration helper for better type inference:
 
-```json
-{
-  // ...
-  "compilerOptions": {
+```ts
+/// <reference types="vite-plugin-svgr/client" />
+```
+
+### Options
+
+```js
+svgr({
+  // Set it to `true` to export React component as default.
+  // Notice that it will overrides the default behavior of Vite.
+  exportAsDefault: false,
+
+  // svgr options: https://react-svgr.com/docs/options/
+  svgrOptions: {
     // ...
-    "types": ["vite-plugin-svgr/client"]
-  }
-}
+  },
+
+  // esbuild options, to transform jsx to js
+  esbuildOptions: {
+    // ...
+  },
+})
 ```
 
 ## License

package/lib/index.d.ts

@@ -0,0 +1,15 @@
+import type { Config } from '@svgr/core';
+import { transformWithEsbuild } from 'vite';
+import type { Plugin } from 'vite';
+export interface ViteSvgrOptions {
+    /**
+     * Export React component as default. Notice that it will overrides
+     * the default behavior of Vite, which exports the URL as default
+     *
+     * @default false
+     */
+    exportAsDefault?: boolean;
+    svgrOptions?: Config;
+    esbuildOptions?: Parameters<typeof transformWithEsbuild>[2];
+}
+export default function viteSvgr({ exportAsDefault, svgrOptions, esbuildOptions, }?: ViteSvgrOptions): Plugin;

package/lib/index.js

@@ -0,0 +1,53 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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"));
+const vite_1 = require("vite");
+function viteSvgr({ exportAsDefault, svgrOptions, esbuildOptions, } = {}) {
+    return {
+        name: 'vite-plugin-svgr',
+        async transform(code, id) {
+            if (id.endsWith('.svg')) {
+                const { transform } = await Promise.resolve().then(() => __importStar(require('@svgr/core')));
+                const svgCode = await fs_1.default.promises.readFile(id, 'utf8');
+                const componentCode = await transform(svgCode, svgrOptions, {
+                    filePath: id,
+                    caller: {
+                        previousExport: exportAsDefault ? null : code,
+                    },
+                });
+                const res = await (0, vite_1.transformWithEsbuild)(componentCode, id, Object.assign({ loader: 'jsx' }, esbuildOptions));
+                return {
+                    code: res.code,
+                    map: null, // TODO:
+                };
+            }
+        },
+    };
+}
+exports.default = viteSvgr;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "vite-plugin-svgr",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Vite plugin to transform SVGs into React components",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
     "dev": "tsc --watch",
     "build": "tsc",
-    "prepublish": "npm run build"
+    "prepare": "npm run build"
   },
   "repository": "pd4d10/vite-plugin-svgr",
   "files": [
@@ -20,14 +21,14 @@
   "author": "Rongjian Zhang",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^17.0.8",
-    "typescript": "^4.5.4",
-    "vite": "^2.7.10"
+    "@types/node": "^17.0.30",
+    "typescript": "^4.6.4",
+    "vite": "^2.9.6"
   },
   "peerDependencies": {
     "vite": "^2.6.0"
   },
   "dependencies": {
-    "@svgr/core": "^6.2.0"
+    "@svgr/core": "^6.2.1"
   }
 }