dxfl 0.3.2 → 0.4.1

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.4.1
+
+- Define required node version
+- Replace cli-color by native styleText
+
+# v0.4.0
+
+- `deploy`: allow to specify a custom config file with `--config-file` or `-c`
+
 # v0.3.2
 
 - update `@aws-sdk/client-s3` 3.983.0 → 3.1004.0

package/README.md

@@ -40,6 +40,12 @@ Or only display the changes without applying them, with the `--dry-run` option:
 dxfl deploy example.com _public --dry-run
 ```
 
+You can also specify a custom TOML configuration file to use instead of the default `deuxfleurs.toml`, with the `--config-file` option:
+
+```
+dxfl deploy example.com _public --config-file custom.toml
+```
+
 Use the `empty` command to delete all files from a website (required before deleting it):
 
 ```
@@ -54,10 +60,10 @@ dxfl inspect example.com
 
 ## Website configuration
 
-`dxfl deploy` reads a `deuxfleurs.toml` configuration file (if it exists in the current directory).
+`dxfl deploy` reads a TOML configuration file, `deuxfleurs.toml` by default (if it exists in the current directory), or the one specified with the `--config-file` option.
 This file can be used to specify website configuration metadata such as redirections.
 
-Your `deuxfleurs.toml` should follow the following structure:
+Your configuration file should follow the following structure:
 
 ```toml
 # Filename added after URLs that point to directories.

package/dist/deploy.js

@@ -323,10 +323,8 @@ export function deploy(website, localFolder, options) {
         if (options.dryRun && options.yes) {
             throw new ErrorMsg("options --yes and --dry-run cannot be passed at the same time");
         }
-        // TODO: make this configurable
-        const website_config_path = "deuxfleurs.toml";
         // Read and validate the local configuration file before doing anything else
-        const localWebsiteConfig = yield readConfigFile(website_config_path);
+        const localWebsiteConfig = yield readConfigFile(options.configFile);
         process.stdout.write("Fetching the website configuration and metadata...\n");
         const [localFiles, [bucket, remoteFiles, remoteWebsiteConfig]] = yield Promise.all([
             // Get paths & size of the local files to deploy

package/dist/error.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { S3ServiceException } from "@aws-sdk/client-s3";
-import clc from "cli-color";
+import { styleText } from "node:util";
 export class ErrorCtx {
     constructor(ctx, error) {
         this.ctx = ctx;
@@ -83,10 +83,10 @@ export function wrapS3Call(context, expectedCodes, f) {
 // otherwise it is thrown as an exception.
 export function handleError(e) {
     if (e instanceof ErrorMsg) {
-        console.error(`${clc.red("Error:")} ${e.msg}`);
+        console.error(`${styleText("red", "Error:")} ${e.msg}`);
     }
     else if (e instanceof ErrorGuichet) {
-        let msg = clc.red("Error: ");
+        let msg = styleText("red", "Error: ");
         if (e.cause.kind == "Unauthorized") {
             msg +=
                 "failed to authenticate with Guichet. Is your password and login correct?";
@@ -97,7 +97,7 @@ export function handleError(e) {
         console.error(msg);
     }
     else {
-        console.error(clc.red("Unexpected error:") + "\n", e);
+        console.error(styleText("red", "Unexpected error:") + "\n", e);
     }
     process.exit(1);
 }

package/dist/guichet.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { WebsiteApi, } from "guichet-sdk-ts";
-import { textWarn } from "./utils.js";
+import { styleText } from "node:util";
 import { ErrorGuichet } from "./error.js";
 // The GuichetApi class wraps WebsiteApi (from the guichet sdk). It catches
 // errors that can happen in normal use, and it turn them into a dedicated error type
@@ -45,7 +45,7 @@ export class GuichetApi {
                     // the migration of websites *.web.deuxfleurs.fr to bucket
                     // names with the full domain name.
                     // We just warn that this is a working but deprecated name.
-                    console.log(`${textWarn("Warning")}: the name "${vhost}" is now deprecated for this website,` +
+                    console.log(`${styleText("yellow", "Warning")}: the name "${vhost}" is now deprecated for this website,` +
                         ` you should use "${vhost}.web.deuxfleurs.fr" instead.`);
                 }
                 return websiteInfo;

package/dist/index.js

@@ -6,7 +6,7 @@ import { deploy } from "./deploy.js";
 import { empty } from "./empty.js";
 import { vhostsList } from "./vhosts.js";
 import { inspect } from "./inspect.js";
-program.name("dxfl").description("Deuxfleurs CLI tool").version("0.3.2");
+program.name("dxfl").description("Deuxfleurs CLI tool").version("0.4.1");
 program
     .command("login")
     .description("Link your Deuxfleurs account with this tool.")
@@ -29,6 +29,7 @@ program
     .argument("<local_folder>", "your local folder")
     .option("-n, --dry-run", "do a trial run without making actual changes")
     .option("-y, --yes", "apply the changes without asking for confirmation")
+    .option("-c, --config-file <path>", "apply a custom TOML config file")
     .action((website, localFolder, options) => withHandleErrors(() => deploy(website, localFolder, options)));
 program
     .command("empty")

package/dist/inspect.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { WebsiteApi } from "guichet-sdk-ts";
 import { openApiConf } from "./auth.js";
-import { formatBytesHuman, separator, textGreen, textGrey, } from "./utils.js";
-import clc from "cli-color";
+import { formatBytesHuman, separator } from "./utils.js";
+import { styleText } from "node:util";
 export function inspect(website, options) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, _b, _c;
@@ -24,17 +24,18 @@ export function inspect(website, options) {
         if (!options.secret) {
             kSecret =
                 `**** ` +
-                    textGrey.italic(`(use \`dxfl inspect ${v === null || v === void 0 ? void 0 : v.name} --secret\` to reveal it)`);
+                    styleText(["gray", "italic"], `(use \`dxfl inspect ${v === null || v === void 0 ? void 0 : v.name} --secret\` to reveal it)`);
         }
-        console.log(textGreen.bold(`${v === null || v === void 0 ? void 0 : v.name} details`));
+        console.log(styleText(["green", "bold"], `${v === null || v === void 0 ? void 0 : v.name} details`));
         console.log(separator());
-        console.log(`  ${clc.bold("id")}: ${v === null || v === void 0 ? void 0 : v.name}`);
-        console.log(`  ${clc.bold("url")}: ${clc.underline("https://" + (v === null || v === void 0 ? void 0 : v.domain))}`);
-        console.log(`  ${clc.bold("usage")}:`, `${formatBytesHuman((_a = q === null || q === void 0 ? void 0 : q.current) !== null && _a !== void 0 ? _a : 0)} / ${formatBytesHuman((_b = q === null || q === void 0 ? void 0 : q.max) !== null && _b !== void 0 ? _b : 0)}`, `(${Math.round(((_c = q === null || q === void 0 ? void 0 : q.ratio) !== null && _c !== void 0 ? _c : 0) * 100)}%)`);
-        console.log(`  ${clc.bold("S3 keys")}:`);
-        console.log(`    ${clc.bold("access_key_id")}: ${kId}`);
-        console.log(`    ${clc.bold("secret_access_key")}: ${kSecret}`);
+        console.log(`  ${styleText("bold", "id")}: ${v === null || v === void 0 ? void 0 : v.name}`);
+        console.log(`  ${styleText("bold", "url")}: ${styleText("underline", "https://" + (v === null || v === void 0 ? void 0 : v.domain))}`);
+        console.log(`  ${styleText("bold", "usage")}:`, `${formatBytesHuman((_a = q === null || q === void 0 ? void 0 : q.current) !== null && _a !== void 0 ? _a : 0)} / ${formatBytesHuman((_b = q === null || q === void 0 ? void 0 : q.max) !== null && _b !== void 0 ? _b : 0)}`, `(${Math.round(((_c = q === null || q === void 0 ? void 0 : q.ratio) !== null && _c !== void 0 ? _c : 0) * 100)}%)`);
+        console.log(`  ${styleText("bold", "S3 keys")}:`);
+        console.log(`    ${styleText("bold", "access_key_id")}: ${kId}`);
+        console.log(`    ${styleText("bold", "secret_access_key")}: ${kSecret}`);
         console.log(separator());
-        console.log(textGrey.italic(`→ For more information and features, you can visit the web UI:`, `${clc.underline("https://guichet.deuxfleurs.fr/website/inspect/" + (v === null || v === void 0 ? void 0 : v.name))}`));
+        console.log(styleText(["gray", "italic"], `→ For more information and features, you can visit the web UI: ` +
+            `${styleText("underline", "https://guichet.deuxfleurs.fr/website/inspect/" + (v === null || v === void 0 ? void 0 : v.name))}`));
     });
 }

package/dist/utils.js

@@ -19,11 +19,7 @@ import crypto from "crypto";
 import { stdin, stdout } from "process";
 import readline from "readline/promises";
 import { ErrorMsg } from "./error.js";
-import clc from "cli-color";
-export const textGreen = clc.green;
-export const textWarn = clc.yellow;
-export const textError = clc.red;
-export const textGrey = clc.xterm(242);
+import { styleText } from "node:util";
 export function getFileMd5(file) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, e_1, _b, _c;
@@ -132,5 +128,5 @@ export function separator(size = 42) {
     for (let i = 0; i < size; i++) {
         dashes += "-";
     }
-    return textGrey(dashes);
+    return styleText("gray", dashes);
 }

package/dist/vhosts.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { WebsiteApi } from "guichet-sdk-ts";
 import { openApiConf } from "./auth.js";
-import { separator, textGreen } from "./utils.js";
-import clc from "cli-color";
+import { separator } from "./utils.js";
+import { styleText } from "node:util";
 export function vhostsList() {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, _b, _c;
@@ -24,9 +24,9 @@ export function vhostsList() {
             if (i === 0) {
                 console.log(separator());
             }
-            console.log(textGreen(v.name));
-            console.log(`  ${clc.bold("id")}: ${v.name}`);
-            console.log(`  ${clc.bold("url")}: ${clc.underline("https://" + v.domain)}`);
+            console.log(styleText("green", v.name || ""));
+            console.log(`  ${styleText("green", "id")}: ${v.name}`);
+            console.log(`  ${styleText("bold", "url")}: ${styleText("underline", "https://" + v.domain)}`);
             console.log(separator());
         });
     });

package/dist/website_config.js

@@ -54,7 +54,15 @@ export function equalCorsRules(c1, c2) {
 // Parsing: TOML -> untyped object
 function readConfigFileObject(filename) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!fs.existsSync(filename)) {
+        if (filename != undefined) {
+            if (!fs.existsSync(filename)) {
+                throw new ErrorMsg(`${filename} configuration file not found`);
+            }
+        }
+        else if (fs.existsSync("deuxfleurs.toml")) {
+            filename = "deuxfleurs.toml";
+        }
+        else {
             return {};
         }
         let strConf;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dxfl",
-  "version": "0.3.2",
+  "version": "0.4.1",
   "description": "",
   "license": "EUPL-1.2",
   "author": "Deuxfleurs Team <coucou@deuxfleurs.fr>",
@@ -13,6 +13,9 @@
   "bin": {
     "dxfl": "dist/index.js"
   },
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "scripts": {
     "prepare": "npx tsc",
     "prettier": "npx prettier . --write",
@@ -24,7 +27,6 @@
     "@commander-js/extra-typings": "^14.0.0",
     "@supercharge/promise-pool": "^3.2.0",
     "@types/node": "^25.2.1",
-    "cli-color": "^2.0.4",
     "commander": "^14.0.3",
     "fast-uri": "^3.1.0",
     "guichet-sdk-ts": "^0.1.0",
@@ -36,7 +38,6 @@
     "zod-validation-error": "^3.4.1"
   },
   "devDependencies": {
-    "@types/cli-color": "^2.0.6",
     "onchange": "^7.1.0",
     "prettier": "3.5.3"
   }