{"id":21101527,"url":"https://github.com/imba97/simple-zip-upload","last_synced_at":"2025-03-14T08:20:17.850Z","repository":{"id":62239894,"uuid":"484375169","full_name":"imba97/simple-zip-upload","owner":"imba97","description":"一个简单的打包上传工具","archived":false,"fork":false,"pushed_at":"2022-10-27T15:48:14.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-04T03:57:30.604Z","etag":null,"topics":["upload","zip"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imba97.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"License","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-22T09:32:10.000Z","updated_at":"2022-11-01T01:24:49.000Z","dependencies_parsed_at":"2022-10-29T01:31:50.779Z","dependency_job_id":null,"html_url":"https://github.com/imba97/simple-zip-upload","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imba97%2Fsimple-zip-upload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imba97%2Fsimple-zip-upload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imba97%2Fsimple-zip-upload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imba97%2Fsimple-zip-upload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imba97","download_url":"https://codeload.github.com/imba97/simple-zip-upload/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243544532,"owners_count":20308170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["upload","zip"],"created_at":"2024-11-19T23:46:48.410Z","updated_at":"2025-03-14T08:20:17.815Z","avatar_url":"https://github.com/imba97.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# simple-zip-upload\n\n一个简单的前端打包压缩上传工具\n\n可以一键压缩指定目录并上传到服务器并把下载链接推送到钉钉\n\n可自动维护本地及线下压缩包，非当天的自动删除\n\n# 安装\n\n```\npnpm i -D simple-zip-upload\n```\n\n# 导入\n\n```javascript\nimport ZipUpload from 'simple-zip-upload'\n```\n\n# 配置\n\n```javascript\nconst ZipUpload = require('simple-zip-upload')\nconst path = require('path')\nconst fs = require('fs')\n\nconst ZipUploadConfig = {\n  sftpOptions: {\n    // SFTP 连接信息\n    connect: {\n      host: '1.2.3.4',\n      port: 22,\n      username: 'root',\n      privateKey: fs.readFileSync('C:\\\\Users\\\\imba97\\\\.ssh\\\\id_rsa')\n    },\n\n    // 必填，上传的远程目录\n    remoteDir: '/www/download/upload'\n  },\n\n  // 应用名，唯一名称，会拼接在压缩文件名\n  app: 'simple-zip-upload',\n\n  // 版本号填充“0”的个数，可选，默认 2\n  fill: 3,\n\n  // 压缩目标文件夹\n  zipTargetDir: 'dist',\n\n  // 本地压缩文件存放目录\n  zipFileDir: 'build',\n\n  // 压缩文件下载连接，最后会与文件名拼接\n  host: 'https://download.imba97.cn/upload/',\n\n  // 钉钉推送卡片信息\n  cardInfo: {\n    title: '测试发布',\n    subTitle: '没啥事就是测试一下',\n\n    // 可选 默认是：\n    // 版本 20221027005\n    // 大小 1.00M\n    // 打包日期 2022-10-27 23:57:31\n    body(cardInfo) {\n      return `\n自定义内容\n开头顶格写，不然会有空格\n版本 ${cardInfo.version}\n大小 ${cardInfo.size}\n打包日期 ${cardInfo.date}`\n    }\n\n    // 可以是字符串\n    // body: '自定义内容'\n  },\n\n  // 钉钉连接 token、secret\n  dingTalk: {\n    accessToken: '',\n    secret: ''\n  }\n}\n```\n\n# 使用\n\n## 普通\n\n```javascript\n// 普通\nnew ZipUpload(ZipUploadConfig).start()\n```\n\n## Webpack\n\n```javascript\n// ...\n{\n  plugins: [new ZipUpload(ZipUploadConfig)]\n}\n```\n\n## vue.config.js\n\n```javascript\n// ...\n{\n  // ...\n  chainWebpack(config) {\n    // 添加插件\n    config\n      .plugin('ZipUploadPlugin')\n      .use(ZipUpload)\n      .tap(() =\u003e [ZipUploadConfig])\n  },\n  // ...\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimba97%2Fsimple-zip-upload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimba97%2Fsimple-zip-upload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimba97%2Fsimple-zip-upload/lists"}