vite-plugin-zip-file 1.0.2 → 1.1.0

package/README.md

@@ -1,4 +1,7 @@
 # vite-plugin-zip-file
+[![MIT LICENSE](https://img.shields.io/badge/LICENSE-MIT-green)](./LICENSE)
+[![downloads](https://img.shields.io/npm/dw/vite-plugin-zip-file)](https://www.npmjs.com/package/vite-plugin-zip-file)
+
 Zip files at build time.
 
 # Install
@@ -16,11 +19,14 @@ npm install vite-plugin-zip-file --save-dev
 # Optons
 
 
-| Param      | Types        | Rquired | Default | Desc                           |
-| :--------- | ------------ | ------- | ------- | ------------------------------ |
-| folderPath | String\|Path | true    | -       | Path to the compressed folder  |
-| outPath    | String\|Path | true    | -       | Compressed package output path |
-| zipName    | String       | false   | dist    | Package name                   |
+| Param      | Types        | Rquired | Default | Desc                                                         |
+| :--------- | ------------ | ------- | ------- | ------------------------------------------------------------ |
+| folderPath | String\|Path | true    | -       | Path to the compressed folder                                |
+| outPath    | String\|Path | true    | -       | Compressed package output path                               |
+| zipName    | String       | false   | dist    | Package name                                                 |
+| enabled  | Boolean      | false   | true    | This parameter is used to control whether the plugin is enabled. It is usually used to determine whether to compress files according to the environment |
+
+
 
 
 # Usage
@@ -29,6 +35,7 @@ import { defineConfig } from 'vite';
 import { viteZip } from 'vite-plugin-zip-file';
 import path from 'path';
 import { fileURLToPath } from 'url';
+import { env } from 'node:process';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 // https://vitejs.dev/config/
@@ -37,7 +44,8 @@ export default defineConfig({
     viteZip({
       folderPath: path.resolve(__dirname, 'dist'),
       outPath: path.resolve(__dirname),
-      zipName: 'Test.zip'
+      zipName: 'Test.zip',
+      enabled: env.NODE_ENV === 'production'? true: false
     })
   ]
 })

package/lib/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const v=require("path"),g=require("fs"),j=require("node:module"),m=e=>e&&typeof e=="object"&&"default"in e?e:{default:e},r=m(v),i=m(g),q=j.createRequire(typeof document>"u"?new(require("url")).URL("file:"+__filename).href:document.currentScript&&document.currentScript.src||new URL("index.cjs",document.baseURI).href),b=(e={folderPath:null,outPath:null,zipName:null})=>{let{folderPath:l,outPath:u,zipName:t}=e;if(!l||!u)throw new Error("config.folderPath and config.outPath is required.");l=r.default.resolve(l),u=r.default.resolve(u),t=t||l.split("/").pop()+".zip";const y=()=>{const h=q("jszip"),f=new h,a=function(n,o,c=""){const _=i.default.readdirSync(o);c+=o.split("/").pop()+"/",_.forEach(p=>{const s=r.default.join(o,"/",p);i.default.statSync(s).isDirectory()?a(n,s,c):n.file(c+p,i.default.readFileSync(s))})},d=(n=t)=>{const o=r.default.join(u,"/"+n);i.default.existsSync(o)&&i.default.unlinkSync(o)},S=function(){a(f,l),f.generateAsync({type:"nodebuffer",compression:"DEFLATE",compressionOptions:{level:9}}).then(n=>{d(t),i.default.writeFileSync(r.default.join(u,"/",t),n)})};d(t),S()};return{name:"vite-plugin-zip-file",apply:"build",closeBundle(){y()}}};exports.viteZip=b;
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const j=require("path"),q=require("fs"),w=require("node:module"),y=e=>e&&typeof e=="object"&&"default"in e?e:{default:e},r=y(j),i=y(q),P=w.createRequire(typeof document>"u"?new(require("url")).URL("file:"+__filename).href:document.currentScript&&document.currentScript.src||new URL("index.cjs",document.baseURI).href),l=r.default.sep,Z={enabled:!0,folderPath:"",outPath:"",zipName:""},z=e=>{let S={...Z,...e},{enabled:s,folderPath:u,outPath:c,zipName:t}=S;if(s=Boolean(s),!u||!c)throw new Error("config.folderPath and config.outPath is required.");u=r.default.resolve(u),c=r.default.resolve(c),t=t||u.split(l).pop()+".zip";const _=()=>{const g=P("jszip"),d=new g,p=function(n,o,a=""){const b=i.default.readdirSync(o);a+=o.split(l).pop()+l,b.forEach(m=>{const f=r.default.join(o,l,m);i.default.statSync(f).isDirectory()?p(n,f,a):n.file(a+m,i.default.readFileSync(f))})},h=(n=t)=>{const o=r.default.join(c,l+n);i.default.existsSync(o)&&i.default.unlinkSync(o)},v=function(){p(d,u),d.generateAsync({type:"nodebuffer",compression:"DEFLATE",compressionOptions:{level:9}}).then(n=>{h(t),i.default.writeFileSync(r.default.join(c,l,t),n)})};h(t),v()};return{name:"vite-plugin-zip-file",apply:"build",closeBundle(){!s||_()}}};exports.viteZip=z;

package/lib/index.mjs

@@ -1,42 +1,50 @@
-import s from "path";
+import r from "path";
 import n from "fs";
-import { createRequire as v } from "node:module";
-const z = v(import.meta.url), w = (m = { folderPath: null, outPath: null, zipName: null }) => {
-  let { folderPath: i, outPath: r, zipName: e } = m;
-  if (!i || !r)
+import { createRequire as P } from "node:module";
+const Z = P(import.meta.url), i = r.sep, b = {
+  enabled: !0,
+  folderPath: "",
+  outPath: "",
+  zipName: ""
+}, F = (h) => {
+  let y = {
+    ...b,
+    ...h
+  }, { enabled: p, folderPath: s, outPath: c, zipName: e } = y;
+  if (p = Boolean(p), !s || !c)
     throw new Error("config.folderPath and config.outPath is required.");
-  i = s.resolve(i), r = s.resolve(r), e = e || i.split("/").pop() + ".zip";
-  const d = () => {
-    const y = z("jszip"), p = new y(), f = function(o, t, l = "") {
-      const S = n.readdirSync(t);
-      l += t.split("/").pop() + "/", S.forEach((u) => {
-        const c = s.join(t, "/", u);
-        n.statSync(c).isDirectory() ? f(o, c, l) : o.file(l + u, n.readFileSync(c));
+  s = r.resolve(s), c = r.resolve(c), e = e || s.split(i).pop() + ".zip";
+  const S = () => {
+    const g = Z("jszip"), f = new g(), u = function(o, t, l = "") {
+      const z = n.readdirSync(t);
+      l += t.split(i).pop() + i, z.forEach((m) => {
+        const a = r.join(t, i, m);
+        n.statSync(a).isDirectory() ? u(o, a, l) : o.file(l + m, n.readFileSync(a));
       });
-    }, a = (o = e) => {
-      const t = s.join(r, "/" + o);
+    }, d = (o = e) => {
+      const t = r.join(c, i + o);
       n.existsSync(t) && n.unlinkSync(t);
-    }, h = function() {
-      f(p, i), p.generateAsync({
+    }, v = function() {
+      u(f, s), f.generateAsync({
         type: "nodebuffer",
         compression: "DEFLATE",
         compressionOptions: {
           level: 9
         }
       }).then((o) => {
-        a(e), n.writeFileSync(s.join(r, "/", e), o);
+        d(e), n.writeFileSync(r.join(c, i, e), o);
       });
     };
-    a(e), h();
+    d(e), v();
   };
   return {
     name: "vite-plugin-zip-file",
     apply: "build",
     closeBundle() {
-      d();
+      !p || S();
     }
   };
 };
 export {
-  w as viteZip
+  F as viteZip
 };

package/package.json

@@ -1,9 +1,15 @@
 {
   "name": "vite-plugin-zip-file",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "zip files at build time.",
   "type": "module",
   "main": "lib/index.cjs",
+  "files": [
+    "lib/*",
+    "LICENSE",
+    "package.json",
+    "README.md"
+  ],
   "module": "lib/index.mjs",
   "scripts": {
     "dev": "vite",
@@ -30,7 +36,8 @@
     "vite": "^3.0.7"
   },
   "dependencies": {
-    "jszip": "^3.10.1"
+    "jszip": "^3.10.1",
+    "vite-plugin-zip-file": "^1.0.3"
   },
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^13.3.0"

package/index.html

@@ -1,20 +0,0 @@
-<!--
- * @Author: xiangfu.wu
- * @Date: 2022-08-18 16:24:33
- * @Description: 🚀
- * @FilePath: /vite-plugin-zip/index.html
--->
-
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Document</title>
-</head>
-<body>
-  <div id="app"></div>
-  <script type="module" src="/src/main.js"></script>
-</body>
-</html>

package/plugin.config.js

@@ -1,26 +0,0 @@
-/*
- * @Author: xiangfu.wu
- * @Date: 2022-08-18 16:59:00
- * @Description: 🚀
- * @FilePath: /vite-plugin-zip-file/plugin.config.js
- */
-
-import { defineConfig } from 'vite'
-import path from 'path';
-import { fileURLToPath } from 'url';
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-export default defineConfig({
-  publicDir: false,
-  build: {
-    lib: {
-      entry: path.resolve(__dirname, 'src/utils/vite-plugin-zip-flie.js'),
-      name: 'index',
-      fileName: (format) => format === 'cjs'? 'index.cjs': 'index.mjs',
-      formats: ['cjs', 'es']
-    },
-    rollupOptions: {
-      external: ['node:module', 'fs', 'path', 'url'] //忽略处理node内置依赖
-    },
-    outDir: "./lib"
-  }
-})

package/src/main.js

@@ -1,8 +0,0 @@
-/*
- * @Author: xiangfu.wu
- * @Date: 2022-08-18 16:37:47
- * @Description: 🚀
- * @FilePath: /vite-plugin-zip-file/src/main.js
- */
-
-document.querySelector('#app').innerHTML = 'vite-plugin-zip';

package/src/utils/vite-plugin-zip-flie.js

@@ -1,75 +0,0 @@
-/*
- * @Author: xiangfu.wu
- * @Date: 2022-08-18 15:30:35
- * @Description: 🚀
- * @FilePath: /vite-plugin-zip-file/src/utils/vite-plugin-zip-flie.js
- */
-import path from 'path';
-import fs from 'fs';
-import { createRequire } from 'node:module'
-const requireds = createRequire(import.meta.url);
-
-export const viteZip = (config = { folderPath: null, outPath: null, zipName: null }) => {
-  let { folderPath, outPath, zipName } = config;
-  if (!folderPath || !outPath) {
-    throw new Error('config.folderPath and config.outPath is required.');
-  }
-  folderPath = path.resolve(folderPath);
-  outPath = path.resolve(outPath);
-  zipName = zipName? zipName: folderPath.split('/').pop() + '.zip';
-  const makeZip = () => {
-    const JSZip = requireds('jszip');
-    const zip = new JSZip();
-    
-
-    const readDir = function (zip, dirPath, fileDir = '') {
-      // 读取组件下的根文件目录
-      const files = fs.readdirSync(dirPath);
-      fileDir += dirPath.split('/').pop() + '/';
-      files.forEach(fileName => {
-        const fillPath = path.join(dirPath, "/", fileName)
-        const file = fs.statSync(fillPath);
-        // 如果是文件夹的话需要递归遍历下面的子文件
-        if (file.isDirectory()) {
-          // const dirZip = zip.folder(fileName);
-          readDir(zip, fillPath, fileDir);
-        } else {
-          // 读取每个文件为buffer存到zip中，带上文件夹，保证压缩后文件目录不变
-          zip.file(fileDir + fileName, fs.readFileSync(fillPath))
-        }
-      });
-    }
-    
-    const removeZip = (name = zipName) => {
-      const dest = path.join(outPath, '/' + name)
-      if (fs.existsSync(dest)) {
-        fs.unlinkSync(dest)
-      }
-    }
-
-    const doZip = function () {
-
-      readDir(zip, folderPath);
-      zip.generateAsync({
-        type: "nodebuffer", // 压缩类型
-        compression: "DEFLATE", // 压缩算法
-        compressionOptions: { // 压缩级别
-          level: 9
-        }
-      }).then(content => {
-        removeZip(zipName)
-        fs.writeFileSync(path.join(outPath,'/' ,zipName), content);
-      });
-    }
-
-    removeZip(zipName)
-    doZip()
-  };
-  return {
-    name: 'vite-plugin-zip-file',
-    apply: 'build',
-    closeBundle() {
-      makeZip();
-    }
-  }
-}

package/vite.config.js

@@ -1,28 +0,0 @@
-/*
- * @Author: xiangfu.wu
- * @Date: 2022-08-18 16:31:25
- * @Description: 🚀
- * @FilePath: /vite-plugin-zip-file/vite.config.js
- */
-
-
-import { defineConfig } from 'vite'
-import path from 'path';
-import { fileURLToPath } from 'url';
-// import { vitePluginZip } from './src/utils/vite-plugin-zip-file.js';
-import { vitePluginZip } from './lib/index.es.js';
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-export default defineConfig({
-  publicDir: false,
-  plugins: [
-    vitePluginZip({
-      folderPath: path.resolve(__dirname, 'dist'),
-      outPath: path.resolve(__dirname)
-    })
-  ],
-  server: {
-    port: '4321'
-  }
-})
-
-