feat(build): add zip packing script

Author: brownsugar

.gitignore

@@ -1,3 +1,4 @@
+/build/*.zip
 /node_modules
 /dist
 .DS_Store

build/.gitkeep

@@ -4,7 +4,9 @@
   "description": "Daily sign in 94 EZ.",
   "scripts": {
     "dev": "webpack --env development --watch --config config/webpack.config.ts",
-    "build": "webpack --env production --config config/webpack.config.ts",
+    "build": "yarn build:ext && yarn build:zip",
+    "build:ext": "webpack --env production --config config/webpack.config.ts",
+    "build:zip": "ts-node scripts/buildZip.ts",
     "lint": "eslint src/**/* --ext .ts"
   },
   "repository": {
@@ -19,9 +21,11 @@
   "homepage": "https://github.com/brownsugar/baha-auto-sign#readme",
   "private": true,
   "devDependencies": {
+    "@types/adm-zip": "^0.5.0",
     "@types/chrome": "^0.0.188",
     "@typescript-eslint/eslint-plugin": "^5.26.0",
     "@typescript-eslint/parser": "^5.26.0",
+    "adm-zip": "^0.5.9",
     "copy-webpack-plugin": "^11.0.0",
     "css-loader": "^6.7.1",
     "eslint": "^8.16.0",
@@ -34,6 +38,7 @@
     "sass-loader": "^13.0.0",
     "ts-loader": "^9.3.0",
     "ts-node": "^10.8.0",
+    "type-fest": "^2.13.0",
     "typescript": "^4.7.2",
     "webpack": "^5.72.1",
     "webpack-cli": "^4.9.2",

package.json

@@ -0,0 +1,26 @@
+import { readFileSync, writeFileSync, existsSync } from 'fs'
+import * as Zip from 'adm-zip'
+import { PackageJson } from 'type-fest'
+
+const packageJsonPath = './package.json'
+const packageJson: PackageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'))
+const version = packageJson.version
+if (version === undefined) {
+  console.error('Could not fetch package version.')
+  process.exit(1)
+}
+
+const manifestPath = './dist/manifest.json'
+if (!existsSync(manifestPath)) {
+  console.error('Could not find manifest file, please run `yarn build` first.')
+  process.exit(1)
+}
+
+const manifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))
+manifest.version = version
+writeFileSync(manifestPath, JSON.stringify(manifest, null, 2))
+
+const zip = new Zip()
+zip.addLocalFolder('./dist', '')
+const zipName = `${packageJson.name as string}-v${version}`
+zip.writeZip(`./build/${zipName}.zip`)

scripts/buildZip.ts

@@ -12,6 +12,7 @@
     ".eslintrc.js",
     "config/*.ts",
     "src/**/*.ts",
+    "scripts/*.ts",
     "types/*.ts"
   ]
 }

tsconfig.json

@@ -132,6 +132,13 @@
   resolved "https://registry.yarnpkg.com/@tsconfig/node16/-/node16-1.0.2.tgz#423c77877d0569db20e1fc80885ac4118314010e"
   integrity sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==
 
+"@types/adm-zip@^0.5.0":
+  version "0.5.0"
+  resolved "https://registry.yarnpkg.com/@types/adm-zip/-/adm-zip-0.5.0.tgz#94c90a837ce02e256c7c665a6a1eb295906333c1"
+  integrity sha512-FCJBJq9ODsQZUNURo5ILAQueuA8WJhRvuihS3ke2iI25mJlfV2LK8jG2Qj2z2AWg8U0FtWWqBHVRetceLskSaw==
+  dependencies:
+    "@types/node" "*"
+
 "@types/chrome@^0.0.188":
   version "0.0.188"
   resolved "https://registry.yarnpkg.com/@types/chrome/-/chrome-0.0.188.tgz#ed73feca28a6d84f796ec50a2dbe7e41510175b3"
@@ -485,6 +492,11 @@ acorn@^8.4.1, acorn@^8.5.0, acorn@^8.7.1:
   resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.7.1.tgz#0197122c843d1bf6d0a5e83220a788f278f63c30"
   integrity sha512-Xx54uLJQZ19lKygFXOWsscKUbsBZW0CPykPhVQdhIeIwrbPmJzqeASDInc8nKBnp/JT6igTs82qPXz069H8I/A==
 
+adm-zip@^0.5.9:
+  version "0.5.9"
+  resolved "https://registry.yarnpkg.com/adm-zip/-/adm-zip-0.5.9.tgz#b33691028333821c0cf95c31374c5462f2905a83"
+  integrity sha512-s+3fXLkeeLjZ2kLjCBwQufpI5fuN+kIGBxu6530nVQZGVol0d7Y/M88/xw9HGGUcJjKf8LutN3VPRUBq6N7Ajg==
+
 ajv-formats@^2.1.1:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-2.1.1.tgz#6e669400659eb74973bbf2e33327180a0996b520"
@@ -2325,6 +2337,11 @@ type-fest@^0.20.2:
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.20.2.tgz#1bf207f4b28f91583666cb5fbd327887301cd5f4"
   integrity sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==
 
+type-fest@^2.13.0:
+  version "2.13.0"
+  resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-2.13.0.tgz#d1ecee38af29eb2e863b22299a3d68ef30d2abfb"
+  integrity sha512-lPfAm42MxE4/456+QyIaaVBAwgpJb6xZ8PRu09utnhPdWwcyj9vgy6Sq0Z5yNbJ21EdxB5dRU/Qg8bsyAMtlcw==
+
 typescript@^4.7.2:
   version "4.7.2"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.7.2.tgz#1f9aa2ceb9af87cca227813b4310fff0b51593c4"