@datatruck/cli 0.0.6 → 0.3.0

package/package.json

@@ -1,22 +1,21 @@
 {
   "name": "@datatruck/cli",
-  "version": "0.0.6",
+  "version": "0.3.0",
   "dependencies": {
-    "ajv": "^8.10.0",
+    "ajv": "^8.11.0",
     "chalk": "^4.1.2",
-    "cli-table3": "^0.6.1",
-    "commander": "^9.0.0",
-    "concurrently": "^7.0.0",
-    "dayjs": "^1.10.7",
+    "cli-table3": "^0.6.2",
+    "commander": "^9.2.0",
+    "dayjs": "^1.11.2",
     "fast-glob": "^3.2.11",
-    "fs-extra": "^10.0.1",
-    "micromatch": "^4.0.4",
-    "sqlite": "^4.0.23",
-    "sqlite3": "^5.0.2"
+    "fs-extra": "^10.1.0",
+    "micromatch": "^4.0.5",
+    "sqlite": "^4.1.1",
+    "sqlite3": "^5.0.8"
   },
   "optionalDependencies": {
-    "ts-node": "^10.5.0",
-    "yaml": "^1.10.2"
+    "ts-node": "^10.7.0",
+    "yaml": "^2.1.0"
   },
   "engine": {
     "node": ">=16.0.0"

package/util/DataFormat.d.ts

@@ -1,4 +1,4 @@
-export declare type FormatType = "json" | "pjson" | "table" | "yaml";
+export declare type FormatType = "json" | "pjson" | "table" | "yaml" | "custom";
 export declare class DataFormat<TItem extends Record<string, unknown>> {
     readonly options: {
         items: TItem[];

package/util/DataFormat.js

@@ -4,8 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataFormat = void 0;
+const AppError_1 = require("../Error/AppError");
 const cli_table3_1 = __importDefault(require("cli-table3"));
 const util_1 = require("util");
+const customPrefix = "custom=";
 class DataFormat {
     constructor(options) {
         this.options = options;
@@ -45,6 +47,16 @@ class DataFormat {
         else if (format === "yaml") {
             return this.formatToYaml();
         }
+        else if (format.startsWith(customPrefix)) {
+            const code = format.slice(customPrefix.length);
+            return runCustomCode(this.options.items, code);
+        }
+        else {
+            throw new AppError_1.AppError(`Invalid output format: ${format}`);
+        }
     }
 }
 exports.DataFormat = DataFormat;
+function runCustomCode($, __code) {
+    return eval(__code);
+}

package/util/ResticUtil.d.ts

@@ -1,4 +1,4 @@
-import { ExecSettingsInterface } from "./process-util";
+import { ExecResultType, ExecSettingsInterface } from "./process-util";
 import { UriType } from "./string-util";
 export declare type RepositoryType = {
     name?: string;
@@ -43,7 +43,7 @@ export declare class ResticUtil {
     static formatRepository(input: RepositoryType, hidePassword?: boolean): Promise<string>;
     exec(args: string[], settings?: ExecSettingsInterface, options?: {
         cwd?: string;
-    }): Promise<import("./process-util").ExecResultType>;
+    }): Promise<ExecResultType>;
     checkRepository(): Promise<boolean>;
     forget(options: {
         snapshotId?: string;
@@ -81,12 +81,14 @@ export declare class ResticUtil {
         paths: string[];
         setPaths?: string[];
         exclude?: string[];
+        excludeFile?: string[];
         parent?: string;
+        allowEmptySnapshot?: boolean;
         onStream?: (data: BackupStreamType) => Promise<void>;
-    }): Promise<import("./process-util").ExecResultType>;
+    }): Promise<ExecResultType>;
     restore(options: {
         id: string;
         target: string;
         onStream?: (data: BackupStreamType) => Promise<void>;
-    }): Promise<import("./process-util").ExecResultType>;
+    }): Promise<ExecResultType>;
 }

package/util/ResticUtil.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResticUtil = void 0;
+const fs_util_1 = require("./fs-util");
 const process_util_1 = require("./process-util");
 const string_util_1 = require("./string-util");
 const fs_extra_1 = require("fs-extra");
+const promises_1 = require("fs/promises");
 const path_1 = require("path");
 class ResticUtil {
     constructor(options) {
@@ -13,7 +15,7 @@ class ResticUtil {
         if (input.backend === "local") {
             if (typeof input.path !== "string")
                 throw new Error(`Invalid path at "${input.name}" repository: ${input.path}`);
-            return (0, path_1.normalize)(input.path);
+            return (0, path_1.resolve)(input.path);
         }
         if (input.passwordFile)
             input = {
@@ -36,7 +38,7 @@ class ResticUtil {
                     stderr: true,
                     colorize: true,
                     allToStderr: true,
-                    envNames: ["RESTIC_REPOSITORY"],
+                    envNames: ["RESTIC_REPOSITORY", "RESTIC_PASSWORD_FILE"],
                 }
                 : {},
             ...(settings ?? {}),
@@ -99,10 +101,11 @@ class ResticUtil {
         return result.stderr.includes("flag needs an argument");
     }
     async backup(options) {
-        return await this.exec([
+        const exec = async () => await this.exec([
             "backup",
             "--json",
             ...(options.exclude?.flatMap((v) => ["-e", v]) ?? []),
+            ...(options.excludeFile?.flatMap((v) => ["--exclude-file", v]) ?? []),
             ...(options.tags?.flatMap((v) => ["--tag", v]) ?? []),
             ...(options.setPaths?.flatMap((v) => ["--set-path", v]) ?? []),
             ...(options.parent ? ["--parent", options.parent] : []),
@@ -123,6 +126,25 @@ class ResticUtil {
         }, {
             cwd: options.cwd,
         });
+        try {
+            return await exec();
+        }
+        catch (error) {
+            if (options.allowEmptySnapshot &&
+                error.message.includes("unable to save snapshot: snapshot is empty")) {
+                const emptyPath = await (0, fs_util_1.mkTmpDir)("empty");
+                await (0, promises_1.writeFile)(`${emptyPath}/.empty`, "");
+                return await this.backup({
+                    ...options,
+                    cwd: emptyPath,
+                    allowEmptySnapshot: false,
+                    paths: ["."],
+                    exclude: [],
+                    excludeFile: [],
+                });
+            }
+            throw error;
+        }
     }
     async restore(options) {
         return await this.exec(["restore", "--json", options.id, "--target", options.target], {

package/util/datatruck/config-util.d.ts

@@ -18,6 +18,7 @@ declare type ResolveDatabaseNameParamsType = ResolvePackageParamsType & {
 export declare function resolveDatabaseName(value: string, params: ResolveDatabaseNameParamsType): string;
 declare type ResolvePackageParamsType = {
     snapshotId: string;
+    snapshotDate: string;
     action: "backup" | "restore";
 };
 export declare function resolvePackage(pkg: PackageConfigType, params: ResolvePackageParamsType): PackageConfigType;
@@ -25,6 +26,20 @@ export declare function resolvePackages(packages: PackageConfigType[], params: R
 export declare const pkgPathParams: {
     [name in "temp" | Exclude<keyof ResolvePackagePathParamsType, "path">]: string;
 };
+export declare const pkgIncludeParams: {
+    snapshotDate: string;
+    packageName: string;
+    temp: string;
+    snapshotId: string;
+    action: string;
+};
+export declare const pkgExcludeParams: {
+    snapshotDate: string;
+    packageName: string;
+    temp: string;
+    snapshotId: string;
+    action: string;
+};
 export declare const pkgRestorePathParams: {
     [name in "temp" | keyof ResolvePackagePathParamsType]: string;
 };
@@ -33,20 +48,37 @@ export declare const dbNameParams: {
 };
 export declare const params: {
     pkgPath: {
+        snapshotDate: string;
         packageName: string;
         temp: string;
         snapshotId: string;
         action: string;
     };
     pkgRestorePath: {
+        snapshotDate: string;
         packageName: string;
         path: string;
         temp: string;
         snapshotId: string;
         action: string;
     };
+    pkgInclude: {
+        snapshotDate: string;
+        packageName: string;
+        temp: string;
+        snapshotId: string;
+        action: string;
+    };
+    pkgExclude: {
+        snapshotDate: string;
+        packageName: string;
+        temp: string;
+        snapshotId: string;
+        action: string;
+    };
     dbName: {
         snapshotId: string;
+        snapshotDate: string;
         action: string;
         packageName: string;
         database: string;

package/util/datatruck/config-util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.params = exports.dbNameParams = exports.pkgRestorePathParams = exports.pkgPathParams = exports.resolvePackages = exports.resolvePackage = exports.resolveDatabaseName = exports.resolvePackagePath = exports.filterPackages = exports.findRepositoryOrFail = void 0;
+exports.params = exports.dbNameParams = exports.pkgRestorePathParams = exports.pkgExcludeParams = exports.pkgIncludeParams = exports.pkgPathParams = exports.resolvePackages = exports.resolvePackage = exports.resolveDatabaseName = exports.resolvePackagePath = exports.filterPackages = exports.findRepositoryOrFail = void 0;
 const AppError_1 = require("../../Error/AppError");
 const fs_util_1 = require("../fs-util");
 const string_util_1 = require("../string-util");
@@ -53,6 +53,10 @@ function resolvePackage(pkg, params) {
         packageName: pkg.name,
         path: undefined,
     };
+    if (pkg.include)
+        pkg.include = pkg.include.map((v) => typeof v === "string" ? (0, string_util_1.render)(v, pkgParams) : v);
+    if (pkg.exclude)
+        pkg.exclude = pkg.exclude.map((v) => typeof v === "string" ? (0, string_util_1.render)(v, pkgParams) : v);
     if (pkg.path)
         pkg.path = resolvePackagePath(pkg.path, pkgParams);
     if (pkg.restorePath)
@@ -71,23 +75,30 @@ exports.pkgPathParams = {
     action: "{action}",
     packageName: "{packageName}",
     snapshotId: "{snapshotId}",
+    snapshotDate: "{snapshotDate}",
     temp: "{temp}",
 };
+exports.pkgIncludeParams = exports.pkgPathParams;
+exports.pkgExcludeParams = exports.pkgPathParams;
 exports.pkgRestorePathParams = {
     action: "{action}",
     packageName: "{packageName}",
     path: "{path}",
     snapshotId: "{snapshotId}",
+    snapshotDate: "{snapshotDate}",
     temp: "{temp}",
 };
 exports.dbNameParams = {
     action: "{action}",
     packageName: "{packageName}",
     snapshotId: "{snapshotId}",
+    snapshotDate: "{snapshotDate}",
     database: "{database}",
 };
 exports.params = {
     pkgPath: exports.pkgPathParams,
     pkgRestorePath: exports.pkgRestorePathParams,
+    pkgInclude: exports.pkgIncludeParams,
+    pkgExclude: exports.pkgExcludeParams,
     dbName: exports.dbNameParams,
 };

package/util/fs-util.d.ts

@@ -23,6 +23,9 @@ export declare function readPartialFile(path: string, positions: [number, number
 export declare function checkFile(path: string): Promise<boolean>;
 export declare function checkDir(path: string): Promise<boolean>;
 export declare function forEachFile(dirPath: string, cb: (path: string, dir: boolean) => void, includeDir?: boolean): Promise<void>;
+export declare function writeGitIgnoreList(options: {
+    paths: NodeJS.ReadableStream | string[];
+}): Promise<string>;
 export declare function writePathLists(options: {
     paths: NodeJS.ReadableStream | string[];
     packs?: {

package/util/fs-util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writePathLists = exports.forEachFile = exports.checkDir = exports.checkFile = exports.readPartialFile = exports.mkTmpDir = exports.tmpDir = exports.sessionTmpDir = exports.parentTmpDir = exports.existsFile = exports.findFile = exports.parsePackageFile = exports.parseFile = exports.parseFileExtensions = exports.readdirIfExists = exports.writeJSONFile = exports.existsDir = exports.ensureEmptyDir = exports.mkdirIfNotExists = exports.isDirEmpty = exports.isLocalDir = void 0;
+exports.writePathLists = exports.writeGitIgnoreList = exports.forEachFile = exports.checkDir = exports.checkFile = exports.readPartialFile = exports.mkTmpDir = exports.tmpDir = exports.sessionTmpDir = exports.parentTmpDir = exports.existsFile = exports.findFile = exports.parsePackageFile = exports.parseFile = exports.parseFileExtensions = exports.readdirIfExists = exports.writeJSONFile = exports.existsDir = exports.ensureEmptyDir = exports.mkdirIfNotExists = exports.isDirEmpty = exports.isLocalDir = void 0;
 const path_util_1 = require("./path-util");
 const crypto_1 = require("crypto");
 const fs_1 = require("fs");
@@ -190,6 +190,40 @@ async function forEachFile(dirPath, cb, includeDir) {
     }
 }
 exports.forEachFile = forEachFile;
+async function writeGitIgnoreList(options) {
+    const tempDir = await mkTmpDir("gitignore-list");
+    const path = (0, path_1.join)(tempDir, `.gitignore`);
+    const stream = (0, fs_2.createWriteStream)(path);
+    const dirs = new Set();
+    stream.write("*\n");
+    for await (const value of options.paths) {
+        const dir = (0, path_1.dirname)(value.toString());
+        if (dir !== ".") {
+            let parentPath;
+            for (const value of dir.split("/")) {
+                if (!parentPath) {
+                    parentPath = `!${value}`;
+                }
+                else {
+                    parentPath += `/${value}`;
+                }
+                if (!dirs.has(parentPath)) {
+                    stream.write(`${parentPath}\n`);
+                    stream.write(`${parentPath.slice(1)}/*\n`);
+                    dirs.add(parentPath);
+                }
+            }
+        }
+        stream.write(`!${value}\n`);
+    }
+    await new Promise((resolve, reject) => {
+        stream.close();
+        stream.on("close", resolve);
+        stream.on("error", reject);
+    });
+    return path;
+}
+exports.writeGitIgnoreList = writeGitIgnoreList;
 async function writePathLists(options) {
     const tempDir = await mkTmpDir("path-lists");
     const includedPaths = [];

package/util/string-util.js

@@ -21,7 +21,13 @@ function snakeCase(value, char = "_") {
 }
 exports.snakeCase = snakeCase;
 function render(subject, vars) {
-    return subject.replace(/{(\w+)}/g, function (match, name) {
+    return subject.replace(/{([\w/]*)}/g, function (match, name) {
+        if (!name.length) {
+            return "{";
+        }
+        else if (name === "/") {
+            return "}";
+        }
         const value = vars[name];
         if (typeof value === "undefined")
             throw new AppError_1.AppError(`Variable is not defined: '${subject}' (${name})`);