@struggler/cli 1.0.2 → 1.0.5

package/.strugglerignore

@@ -0,0 +1,6 @@
+# macOS / editor noise
+.DS_Store
+Thumbs.db
+
+# source maps are often unnecessary on CDN refreshes
+*.map

package/Makefile

@@ -0,0 +1,81 @@
+SHELL := /bin/zsh
+
+NODE ?= node
+PNPM ?= pnpm
+CLI_ENTRY ?= ./index.js
+CONFIG ?= ./command/qiniu.json
+DIR ?= ./dist
+DRY_RUN ?=
+CONCURRENCY ?= 5
+EXCLUDE ?=
+MANIFEST ?=
+JSON ?=
+SKIP_INIT ?=
+SKIP_REFRESH ?=
+
+.PHONY: help install reinstall link unlink init upload refresh deploy add-version example-upload test
+
+help:
+	@echo "Available targets:"
+	@echo "  make install                    Install dependencies"
+	@echo "  make reinstall                  Reinstall dependencies from scratch"
+	@echo "  make link                       Link the CLI globally for local usage"
+	@echo "  make unlink                     Remove the global link"
+	@echo "  make init                       Generate/update upload config metadata"
+	@echo "  make upload                     Upload files from DIR using CONFIG"
+	@echo "  make refresh                    Refresh CDN for files from DIR using CONFIG"
+	@echo "  make deploy                     Run init, upload, and refresh in one go"
+	@echo "  make add-version                Run the package version bump script"
+	@echo "  make example-upload             Upload the sample test/dist3 directory"
+	@echo "  make test                       Run the automated test suite"
+	@echo ""
+	@echo "Variables:"
+	@echo "  CONFIG=$(CONFIG)"
+	@echo "  DIR=$(DIR)"
+	@echo "  CLI_ENTRY=$(CLI_ENTRY)"
+	@echo "  CONCURRENCY=$(CONCURRENCY)"
+	@echo "  DRY_RUN=$(DRY_RUN)"
+	@echo "  EXCLUDE=$(EXCLUDE)"
+	@echo "  MANIFEST=$(MANIFEST)"
+	@echo "  JSON=$(JSON)"
+	@echo ""
+	@echo "Example:"
+	@echo "  make upload DIR=./test/dist3 CONFIG=./test/command/qiniu.json DRY_RUN=--dry-run EXCLUDE=.DS_Store"
+
+install:
+	$(PNPM) install
+
+reinstall:
+	rm -rf node_modules
+	$(PNPM) install
+
+link:
+	@if ! $(PNPM) bin --global >/dev/null 2>&1; then \
+		echo "pnpm global bin not configured, running 'pnpm setup' first..."; \
+		$(PNPM) setup; \
+	fi
+	@$(PNPM) link --global
+
+unlink:
+	@$(PNPM) unlink --global @struggler/cli
+
+init:
+	$(NODE) $(CLI_ENTRY) --config $(CONFIG) --dir $(DIR) $(DRY_RUN) $(JSON) init
+
+upload:
+	$(NODE) $(CLI_ENTRY) --config $(CONFIG) --dir $(DIR) --concurrency $(CONCURRENCY) $(DRY_RUN) $(if $(EXCLUDE),--exclude $(EXCLUDE),) $(if $(MANIFEST),--manifest $(MANIFEST),) $(JSON) upload
+
+refresh:
+	$(NODE) $(CLI_ENTRY) --config $(CONFIG) --dir $(DIR) $(DRY_RUN) $(if $(EXCLUDE),--exclude $(EXCLUDE),) $(if $(MANIFEST),--manifest $(MANIFEST),) $(JSON) refresh
+
+deploy:
+	$(NODE) $(CLI_ENTRY) --config $(CONFIG) --dir $(DIR) --concurrency $(CONCURRENCY) $(DRY_RUN) $(if $(EXCLUDE),--exclude $(EXCLUDE),) $(if $(MANIFEST),--manifest $(MANIFEST),) $(JSON) $(SKIP_INIT) $(SKIP_REFRESH) deploy
+
+add-version:
+	$(PNPM) add-version
+
+example-upload:
+	$(NODE) $(CLI_ENTRY) --config ./test/command/qiniu.json --dir ./test/dist3 --concurrency $(CONCURRENCY) $(DRY_RUN) $(if $(EXCLUDE),--exclude $(EXCLUDE),) $(if $(MANIFEST),--manifest $(MANIFEST),) $(JSON) upload
+
+test:
+	$(PNPM) test

package/README.md

@@ -0,0 +1,124 @@
+# struggler-cli
+
+`struggler-cli` is a small deployment CLI for front-end build assets on Qiniu Cloud. It can generate versioned paths, upload build output, refresh CDN URLs, and now supports `dry-run`, concurrent uploads, ignore rules, manifest export, JSON output, and a one-shot `deploy` command.
+
+## Install
+
+```bash
+pnpm install
+```
+
+For local command usage:
+
+```bash
+pnpm link --global
+```
+
+## Config Files
+
+The CLI expects two files in the same directory:
+
+- `qiniu.json`: Qiniu credentials and bucket metadata
+- `config.json`: generated deploy prefix metadata used by upload/refresh
+
+Example `qiniu.json`:
+
+```json
+{
+  "path": "your-project",
+  "accessKey": "",
+  "secretKey": "",
+  "Bucket": "",
+  "zone": "Zone_z1",
+  "domain": "https://cdn.example.com/"
+}
+```
+
+Optional ignore file:
+
+```text
+.strugglerignore
+```
+
+Example:
+
+```text
+.DS_Store
+*.map
+legacy/**
+```
+
+## Commands
+
+Initialize versioned config:
+
+```bash
+node ./index.js --config ./command/qiniu.json --dir ./dist init
+```
+
+Preview upload work without changing files or calling Qiniu:
+
+```bash
+node ./index.js --config ./command/qiniu.json --dir ./dist --dry-run upload
+```
+
+Upload with concurrency:
+
+```bash
+node ./index.js --config ./command/qiniu.json --dir ./dist --concurrency 8 upload
+```
+
+Upload with ignore patterns and a manifest:
+
+```bash
+node ./index.js --config ./command/qiniu.json --dir ./dist --exclude ".DS_Store,*.map" --manifest ./artifacts/upload-manifest.json upload
+```
+
+Refresh CDN for generated URLs:
+
+```bash
+node ./index.js --config ./command/qiniu.json --dir ./dist refresh
+```
+
+Run the full flow:
+
+```bash
+node ./index.js --config ./command/qiniu.json --dir ./dist --concurrency 8 deploy
+```
+
+Skip parts of deploy:
+
+```bash
+node ./index.js --config ./command/qiniu.json --dir ./dist --skip-refresh deploy
+```
+
+Machine-readable output:
+
+```bash
+node ./index.js --config ./command/qiniu.json --dir ./dist --json --dry-run deploy
+```
+
+Version bump script:
+
+```bash
+pnpm add-version
+```
+
+## Makefile Shortcuts
+
+```bash
+make init
+make upload
+make refresh
+make deploy
+make upload DIR=./test/dist3 CONFIG=./test/command/qiniu.json DRY_RUN=--dry-run
+make deploy MANIFEST=./artifacts/deploy.json JSON=--json SKIP_REFRESH=--skip-refresh
+```
+
+## Test
+
+```bash
+pnpm test
+```
+
+The automated tests cover config path resolution, init dry-run behavior, upload ignore handling, manifest generation, and deploy JSON summaries.

package/command/addVersion.js

@@ -14,16 +14,22 @@ function getPackageJson() {
 function main(){
     let packageData = getPackageJson();//获取package的json
     let arr = packageData.version.split('.');//切割后的版本号数组
+    if (arr.length !== 3 || arr.some((item) => Number.isNaN(parseInt(item, 10)))) {
+        throw new Error(`Invalid semver version: ${packageData.version}`)
+    }
     arr[2] = parseInt(arr[2]) + 1;
     packageData.version = arr.join('.');//转换为以"."分割的字符串
-    //用packageData覆盖package.json内容
-    fs.writeFile(
+    fs.writeFileSync(
         packagePath,
         JSON.stringify(packageData, null, "\t"
-        ),
-        (err) => { }
+        )
     )
+    console.log(`Version updated to ${packageData.version}`)
 }
 
 
-module.exports = main
+module.exports = main
+
+if (require.main === module) {
+    main()
+}

package/command/deploy.js

@@ -0,0 +1,75 @@
+const init = require('./init');
+const upload = require('./upload');
+const refresh = require('./refresh');
+const { collectDeployFiles, createSummary, finalizeOutput } = require('../lib/deploy');
+const { getDir } = require('../lib/config');
+const { createIgnoreMatcher } = require('../lib/ignore');
+const { printMessage } = require('../lib/output');
+
+async function main(options) {
+    const startedAt = Date.now();
+    const dir = getDir(options);
+    const ignoreMatcher = createIgnoreMatcher(dir, options);
+    const files = await collectDeployFiles(dir, options);
+    const manifestExtra = {
+        command: 'deploy',
+        skippedSteps: {
+            init: Boolean(options.skipInit),
+            refresh: Boolean(options.skipRefresh),
+        },
+    };
+
+    let initConfig = null;
+    if (!options.skipInit) {
+        initConfig = await init(options);
+    }
+
+    const prefix = initConfig ? initConfig.publicPath : undefined;
+    const uploadSummary = await upload(options, {
+        files,
+        prefix,
+        excludePatterns: ignoreMatcher.patterns,
+        suppressOutput: true,
+    });
+
+    let refreshSummary = createSummary('refresh', Boolean(options.dryRun), [], startedAt, {
+        skipped: Boolean(options.skipRefresh),
+        prefix: uploadSummary.prefix,
+        excludedPatterns: ignoreMatcher.patterns,
+    });
+
+    if (!options.skipRefresh) {
+        const refreshFiles = uploadSummary.succeeded.map((item) => item.localFile);
+        refreshSummary = await refresh(options, {
+            files: refreshFiles,
+            prefix: uploadSummary.prefix,
+            excludePatterns: ignoreMatcher.patterns,
+            suppressOutput: true,
+        });
+    } else {
+        printMessage(options, '[deploy] refresh step skipped');
+    }
+
+    const deploySummary = finalizeOutput(createSummary('deploy', Boolean(options.dryRun), [
+        {
+            ok: uploadSummary.failedCount === 0,
+            step: 'upload',
+            detail: uploadSummary,
+        },
+        {
+            ok: options.skipRefresh || refreshSummary.failedCount === 0,
+            step: 'refresh',
+            detail: refreshSummary,
+        },
+    ], startedAt, {
+        upload: uploadSummary,
+        refresh: refreshSummary,
+        prefix: uploadSummary.prefix,
+        excludedPatterns: ignoreMatcher.patterns,
+    }), options, manifestExtra);
+
+    printMessage(options, `[deploy] upload=${uploadSummary.succeededCount}/${uploadSummary.total} refresh=${refreshSummary.succeededCount}/${refreshSummary.total}`);
+    return deploySummary;
+}
+
+module.exports = main

package/command/index.js

@@ -1,7 +1,9 @@
 var init = require('./init');
 var upload = require('./upload');
-var addVersion = require('./addVersion');
+var refresh = require('./refresh');
+var deploy = require('./deploy');
 
 exports.init = init;
 exports.upload = upload;
-exports.addVersion = addVersion;
+exports.refresh = refresh;
+exports.deploy = deploy;

package/command/init.js

@@ -2,22 +2,17 @@ let { getConfig, getQiniuConfig } = require('../lib/config')
 const chalk = require('chalk');
 let { getJsonData, setJsonData, setSyncJsonData, directoryExists } = require('../lib/files')
 let path = require('path')
+const { formatDate } = require('../lib/date');
+const { printMessage } = require('../lib/output');
 
-function formatDate(date) {
-    date = date || new Date()
-    const year = date.getFullYear()
-    const month = date.getMonth() + 1
-    const day = date.getDate()
-    const hours = date.getHours()
-    const minutes = date.getMinutes()
-
-    return `${year}${month < 10 ? `0${month}` : month}${day < 10 ? `0${day}` : day}${hours < 10 ? `0${hours}` : hours}${minutes < 10 ? `0${minutes}` : minutes}`
-}
-
-function init(qiniuConfigPath, configPath){
+function init(qiniuConfigPath, options){
     if (!directoryExists(qiniuConfigPath)){
-        console.log(chalk.red("七牛配置不存在 正在生成模版 请稍后在下面的文件里填写必要的信息!"))
-        console.log(chalk.blue(qiniuConfigPath))
+        printMessage(options, chalk.red("七牛配置不存在 正在生成模版 请稍后在下面的文件里填写必要的信息!"))
+        printMessage(options, chalk.blue(qiniuConfigPath))
+        if (options.dryRun) {
+            printMessage(options, `[dry-run] init would create template ${qiniuConfigPath}`)
+            return
+        }
         setSyncJsonData(qiniuConfigPath, getJsonData(path.resolve(__dirname, '../def/qiniu.json')))
     }
 
@@ -26,16 +21,21 @@ function init(qiniuConfigPath, configPath){
 function main(options){
     let configPath = getConfig(options)
     let qiniuConfigPath = getQiniuConfig(options)
-    init(qiniuConfigPath, configPath)
+    init(qiniuConfigPath, options)
     const qiniuConfig = getJsonData(qiniuConfigPath)
     let domain = qiniuConfig.domain
-    
+    const versionPrefix = formatDate()
     let config = getJsonData(configPath)
-    config.publicPath = qiniuConfig.path + '/' + formatDate() + '/'
-    config.base = domain + qiniuConfig.path + '/' + formatDate() + '/'
-    //用packageData覆盖package.json内容
-    console.log(config)
+    config.publicPath = `${qiniuConfig.path || ''}/${versionPrefix}/`
+    config.base = `${domain || ''}${qiniuConfig.path || ''}/${versionPrefix}/`
+    if (options.dryRun) {
+        printMessage(options, `[dry-run] init would write ${configPath}`)
+        printMessage(options, JSON.stringify(config, null, 2))
+        return config
+    }
+    printMessage(options, JSON.stringify(config, null, 2))
     setJsonData(configPath, config)
+    return config
 }
 
 module.exports = main

package/command/refresh.js

@@ -0,0 +1,111 @@
+var qiniu = require("qiniu");
+
+var qiniuPrefix = require("../lib/prefix")
+
+let { getQiniuConfig, getDir } = require('../lib/config')
+let { getJsonData } = require('../lib/files')
+const { createIgnoreMatcher } = require('../lib/ignore');
+const {
+    collectDeployFiles,
+    createSummary,
+    ensureRequiredConfig,
+    finalizeOutput,
+    logPlan,
+    toRemoteKey,
+} = require('../lib/deploy');
+const { printMessage } = require('../lib/output');
+
+async function main(options, runtime = {}) {
+    const qiniuConfig = getJsonData(getQiniuConfig(options))
+    const prefix = runtime.prefix || qiniuPrefix.prefix(options);
+    let dir = getDir(options)
+    const startedAt = Date.now();
+    const ignoreMatcher = createIgnoreMatcher(dir, options);
+    const excludedPatterns = runtime.excludePatterns || ignoreMatcher.patterns;
+    const files = runtime.files || await collectDeployFiles(dir, options);
+    const plans = files.map((localFile) => {
+        const key = toRemoteKey(prefix, dir, localFile);
+        return {
+            localFile,
+            key,
+            target: `${qiniuConfig.domain || ''}${key}`,
+        };
+    });
+
+    if (options.dryRun) {
+        if (!runtime.suppressOutput) {
+            logPlan('refresh', plans, options);
+        }
+        const summary = createSummary('refresh', true, plans.map((plan) => ({
+            ok: true,
+            localFile: plan.localFile,
+            key: plan.key,
+            target: plan.target,
+        })), startedAt, {
+            prefix,
+            excludedPatterns,
+        });
+        return runtime.suppressOutput ? summary : finalizeOutput(summary, options, runtime.manifestExtra);
+    }
+
+    ensureRequiredConfig(
+        { ...qiniuConfig, 'publicPath(config.json)': prefix },
+        ['accessKey', 'secretKey', 'domain', 'publicPath(config.json)']
+    );
+
+    var accessKey = qiniuConfig.accessKey
+    var secretKey = qiniuConfig.secretKey;
+    var mac = new qiniu.auth.digest.Mac(accessKey, secretKey);
+    var cdnManager = new qiniu.cdn.CdnManager(mac);
+
+    function refresh(plan) {
+        return new Promise((resolve, reject) => {
+            cdnManager.refreshUrls([plan.target], function (respErr, respBody, respInfo) {
+                if (respErr || respInfo.statusCode !== 200) {
+                    const errorMessage = respErr || (respBody && respBody.error) || `statusCode=${respInfo && respInfo.statusCode}`;
+                    reject(new Error(errorMessage));
+                    return;
+                }
+
+                resolve(respBody);
+            });
+        });
+    }
+
+    const results = [];
+    for (const plan of plans) {
+        try {
+            await refresh(plan);
+            if (!runtime.suppressOutput) {
+                printMessage(options, `[refreshed] ${plan.target}`);
+            }
+            results.push({
+                ok: true,
+                localFile: plan.localFile,
+                key: plan.key,
+                target: plan.target,
+            });
+        } catch (error) {
+            results.push({
+                ok: false,
+                localFile: plan.localFile,
+                key: plan.key,
+                target: plan.target,
+                error: error.message,
+            });
+        }
+    }
+
+    const summary = createSummary('refresh', false, results, startedAt, {
+        prefix,
+        excludedPatterns,
+    });
+    const finalSummary = runtime.suppressOutput ? summary : finalizeOutput(summary, options, runtime.manifestExtra);
+    if (finalSummary.failedCount > 0) {
+        throw new Error(`Refresh finished with ${summary.failedCount} failures`);
+    }
+
+    return finalSummary;
+}
+
+module.exports = main