dxfl 0.3.2 → 0.4.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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/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.0");
 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/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.0",
   "description": "",
   "license": "EUPL-1.2",
   "author": "Deuxfleurs Team <coucou@deuxfleurs.fr>",