Vite PSVG

├── .gitignore ├── pnpm-workspace.yaml ├── eslint.config.mjs ├── example ├── main.ts ├── vite.config.ts ├── index.html ├── App.vue ├── package.json └── psvgs │ ├── helloworld.psvg │ ├── sierpinski.psvg │ ├── tree.psvg │ ├── koch.psvg │ ├── textanim.psvg │ ├── vite.psvg │ ├── pythagoras.psvg │ ├── hilbert.psvg │ └── poisson.psvg ├── src ├── types.ts └── index.ts ├── .github └── workflows │ └── release.yml ├── tsconfig.json ├── README.md ├── LICENSE ├── .vscode └── settings.json ├── package.json └── assets └── vite.svg /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .DS_Store 3 | dist 4 | -------------------------------------------------------------------------------- /pnpm-workspace.yaml: -------------------------------------------------------------------------------- 1 | packages: 2 | - example 3 | -------------------------------------------------------------------------------- /eslint.config.mjs: -------------------------------------------------------------------------------- 1 | import antfu from '@antfu/eslint-config' 2 | 3 | export default antfu({ 4 | 5 | }) 6 | -------------------------------------------------------------------------------- /example/main.ts: -------------------------------------------------------------------------------- 1 | import { createApp } from 'vue' 2 | import App from './App.vue' 3 | 4 | createApp(App).mount('#app') 5 | -------------------------------------------------------------------------------- /src/types.ts: -------------------------------------------------------------------------------- 1 | export interface Options { 2 | /** 3 | * SVG minification, only work for build 4 | * 5 | * @default true 6 | */ 7 | minification?: boolean 8 | } 9 | 10 | export type ResolvedOptions = Required 11 | -------------------------------------------------------------------------------- /example/vite.config.ts: -------------------------------------------------------------------------------- 1 | import type { UserConfig } from 'vite' 2 | import Vue from '@vitejs/plugin-vue' 3 | import PSVG from '../src/index' 4 | 5 | const config: UserConfig = { 6 | plugins: [ 7 | Vue(), 8 | PSVG(), 9 | ], 10 | } 11 | 12 | export default config 13 | -------------------------------------------------------------------------------- /example/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Vite PSVG 7 | 8 | 9 |

10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | on: 4 | push: 5 | tags: 6 | - v* 7 | 8 | jobs: 9 | release: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v2 13 | - run: npx conventional-github-releaser -p angular 14 | env: 15 | CONVENTIONAL_GITHUB_RELEASER_TOKEN: ${{secrets.GITHUB_TOKEN}} 16 | -------------------------------------------------------------------------------- /example/App.vue: -------------------------------------------------------------------------------- 1 | 12 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "ESNext", 4 | "lib": ["ESNext", "DOM"], 5 | "module": "ESNext", 6 | "moduleResolution": "Bundler", 7 | "resolveJsonModule": true, 8 | "strict": true, 9 | "strictNullChecks": true, 10 | "esModuleInterop": true, 11 | "skipLibCheck": true 12 | }, 13 | "exclude": [ 14 | "**/dist", 15 | "**/node_modules", 16 | "**/test" 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /example/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "fixture", 3 | "type": "module", 4 | "version": "0.0.0", 5 | "private": true, 6 | "scripts": { 7 | "dev": "cross-env DEBUG=vite-plugin-psvg:* vite", 8 | "build": "cross-env DEBUG=vite-plugin-psvg:* vite build" 9 | }, 10 | "dependencies": { 11 | "vue": "^3.4.24" 12 | }, 13 | "devDependencies": { 14 | "@vitejs/plugin-vue": "^5.0.4", 15 | "@vue/compiler-sfc": "^3.4.24", 16 | "cross-env": "^7.0.3", 17 | "typescript": "^5.4.5", 18 | "vite": "^5.2.10", 19 | "vite-plugin-psvg": "workspace:*" 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /example/psvgs/helloworld.psvg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 10 | 11 | 12 | 13 | 14 | 17 | Hello World! 18 | 19 | 20 | 21 | 22 | 25 | PSVG 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | # PSVG Vite Plugin 4 | 5 | [PSVG - Programmable SVG](https://github.com/LingDong-/psvg) for [Vite](https://github.com/vitejs/vite) 6 | 7 | ## Install 8 | 9 | Install 10 | 11 | ```bash 12 | npm i vite-plugin-psvg -D # yarn add vite-plugin-psvg -D 13 | ``` 14 | 15 | Add it to `vite.config.js` 16 | 17 | ```ts 18 | // vite.config.js 19 | import PSVG from 'vite-plugin-psvg' 20 | 21 | export default { 22 | plugins: [ 23 | PSVG() 24 | ], 25 | } 26 | ``` 27 | 28 | Then use it as normal SVGs or images. 29 | 30 | ```html 31 |

32 | ``` 33 | 34 | ## Example 35 | 36 | See the [/example](./example). 37 | 38 | ## License 39 | 40 | MIT License © 2020 [Anthony Fu](https://github.com/antfu) 41 | -------------------------------------------------------------------------------- /example/psvgs/sierpinski.psvg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /example/psvgs/tree.psvg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /example/psvgs/koch.psvg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Anthony Fu 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | // Enable the ESlint flat config support 3 | "eslint.experimental.useFlatConfig": true, 4 | 5 | // Disable the default formatter, use eslint instead 6 | "prettier.enable": false, 7 | "editor.formatOnSave": false, 8 | 9 | // Auto fix 10 | "editor.codeActionsOnSave": { 11 | "source.fixAll.eslint": "explicit", 12 | "source.organizeImports": "never" 13 | }, 14 | 15 | // Silent the stylistic rules in you IDE, but still auto fix them 16 | "eslint.rules.customizations": [ 17 | { "rule": "style/*", "severity": "off" }, 18 | { "rule": "format/*", "severity": "off" }, 19 | { "rule": "*-indent", "severity": "off" }, 20 | { "rule": "*-spacing", "severity": "off" }, 21 | { "rule": "*-spaces", "severity": "off" }, 22 | { "rule": "*-order", "severity": "off" }, 23 | { "rule": "*-dangle", "severity": "off" }, 24 | { "rule": "*-newline", "severity": "off" }, 25 | { "rule": "*quotes", "severity": "off" }, 26 | { "rule": "*semi", "severity": "off" } 27 | ], 28 | 29 | // Enable eslint for all supported languages 30 | "eslint.validate": [ 31 | "javascript", 32 | "javascriptreact", 33 | "typescript", 34 | "typescriptreact", 35 | "vue", 36 | "html", 37 | "markdown", 38 | "json", 39 | "jsonc", 40 | "yaml", 41 | "toml", 42 | "astro" 43 | ] 44 | } 45 | -------------------------------------------------------------------------------- /example/psvgs/textanim.psvg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 10 | 11 | 12 | 13 | 14 | 17 | 22 | 27 | Draws itself! 28 | 29 | 30 | 31 | 32 | 35 | 40 | PSVG 41 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /example/psvgs/vite.psvg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 9 | 10 | 11 | 12 | 13 | 14 | 17 | 22 | 27 | Vite! 28 | 29 | 30 | 31 | 32 | 35 | 40 | PSVG 41 | 42 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /example/psvgs/pythagoras.psvg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | -------------------------------------------------------------------------------- /example/psvgs/hilbert.psvg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "vite-plugin-psvg", 3 | "version": "0.3.0", 4 | "packageManager": "pnpm@9.0.5", 5 | "description": "PSVG for Vite", 6 | "author": "antfu ", 7 | "license": "MIT", 8 | "homepage": "https://github.com/antfu/vite-plugin-psvg", 9 | "repository": { 10 | "type": "git", 11 | "url": "https://github.com/antfu/vite-plugin-psvg" 12 | }, 13 | "bugs": "https://github.com/antfu/vite-plugin-psvg/issues", 14 | "exports": { 15 | ".": { 16 | "import": "./dist/index.mjs", 17 | "require": "./dist/index.js" 18 | } 19 | }, 20 | "main": "dist/index.js", 21 | "module": "dist/index.mjs", 22 | "types": "dist/index.d.ts", 23 | "files": [ 24 | "dist" 25 | ], 26 | "scripts": { 27 | "dev": "npm run build -- --watch", 28 | "example:dev": "npm -C example run dev", 29 | "example:build": "npm -C example run build", 30 | "build": "tsup src/index.ts --dts --format cjs,esm", 31 | "prepublishOnly": "npm run build", 32 | "release": "npx bumpp && npm publish", 33 | "lint": "eslint ." 34 | }, 35 | "peerDependencies": { 36 | "@vue/compiler-sfc": "^3.0.2" 37 | }, 38 | "dependencies": { 39 | "@lingdong/psvg": "^0.0.2", 40 | "hash-sum": "^2.0.0", 41 | "slash": "^5.1.0", 42 | "svgo": "^3.2.0" 43 | }, 44 | "devDependencies": { 45 | "@antfu/eslint-config": "^2.15.0", 46 | "@types/hash-sum": "^1.0.2", 47 | "@types/node": "^20.12.7", 48 | "@types/svgo": "^3.0.0", 49 | "@typescript-eslint/eslint-plugin": "^7.7.1", 50 | "@vue/compiler-sfc": "^3.4.24", 51 | "eslint": "^9.1.1", 52 | "rollup": "^4.16.4", 53 | "tsup": "^8.0.2", 54 | "typescript": "^5.4.5", 55 | "vite": "^5.2.10" 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import { existsSync, promises as fs } from 'node:fs' 2 | import { basename, dirname, join, resolve } from 'node:path' 3 | import type { Plugin, ResolvedConfig } from 'vite' 4 | import { compilePSVG } from '@lingdong/psvg' 5 | import hash_sum from 'hash-sum' 6 | import slash from 'slash' 7 | import { optimize } from 'svgo' 8 | import type { Options } from './types' 9 | 10 | export function isPSVG(id: string) { 11 | return id.endsWith('.psvg') 12 | } 13 | 14 | function VitePluginPSVG(options: Options = {}): Plugin { 15 | let config: ResolvedConfig 16 | 17 | const { 18 | minification = true, 19 | } = options 20 | 21 | const assets = new Map() 22 | 23 | return { 24 | name: 'vite-plugin-psvg', 25 | configResolved(_config) { 26 | config = _config 27 | }, 28 | configureServer(server) { 29 | server.middlewares.use(async (req, res, next) => { 30 | const url = req.url 31 | if (url && isPSVG(url)) { 32 | const filepath = url.startsWith('/@fs/') 33 | ? url.slice(4) 34 | : join(config.root, url) 35 | if (!existsSync) 36 | return next() 37 | 38 | let svg = compilePSVG(await fs.readFile(filepath, 'utf-8')) 39 | if (minification) 40 | svg = (await optimize(svg)).data 41 | if (svg) { 42 | res.setHeader('Content-Type', 'image/svg+xml') 43 | res.end(svg) 44 | return 45 | } 46 | } 47 | next() 48 | }) 49 | }, 50 | resolveId(id, importer) { 51 | if (config.command !== 'build') 52 | return 53 | return isPSVG(id) 54 | ? resolve((importer && dirname(importer)) || '.', id) 55 | : null 56 | }, 57 | async load(id) { 58 | if (config.command !== 'build') 59 | return 60 | if (!isPSVG(id)) 61 | return 62 | 63 | let svg = compilePSVG(await fs.readFile(id, 'utf-8')) 64 | 65 | if (minification) 66 | svg = (await optimize(svg)).data 67 | 68 | const baseName = basename(id, '.psvg') 69 | const resolvedFileName = `${baseName}.${hash_sum(id)}.svg` 70 | const url = config.base + slash(join(config.build.assetsDir, resolvedFileName)) 71 | 72 | assets.set(resolvedFileName, svg) 73 | 74 | return `export default ${JSON.stringify(url)}` 75 | }, 76 | generateBundle(_options, bundle) { 77 | for (const [fileName, source] of assets) { 78 | bundle[fileName] = { 79 | name: fileName, 80 | type: 'asset', 81 | fileName: join(config.build.assetsDir, fileName), 82 | source, 83 | needsCodeReference: true, 84 | } 85 | } 86 | }, 87 | } 88 | } 89 | 90 | export default VitePluginPSVG 91 | -------------------------------------------------------------------------------- /example/psvgs/poisson.psvg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | -------------------------------------------------------------------------------- /assets/vite.svg: -------------------------------------------------------------------------------- 1 | 1607 | --------------------------------------------------------------------------------