@keeex/projectconfig 4.1.2 → 4.2.0

package/README.md

@@ -4,31 +4,30 @@ Load project for a project from the following places, whichever works first:
 
 - Command line argument, as a JSON string
 - Command line argument, as a path to a JSON/JS file
-- From a file at the root of the project
+- From a file at the root of the project, or in the parent directory of the root of the project
 
-Additionaly, it will automatically sideload a "secrets" file, for settings that
-should not remain in a shared configuration file.
-The secrets file is expected to be named "secrets.js[on]" at the root of the
-project.
-It can be a symlink.
-If no secret file is found at the root of the project, this library will try to
-load it one directory above the project.
+Additionaly, it will automatically sideload a "secrets" file, for settings that should not remain in a shared configuration file.
 
 ## Usage
 
 ### Configuration location
 
-The main configuration should be placed at the root of the project, in a file
-named `config.js` or `config.json`.
-Same for the secrets, using a file named `secrets.js` or `secrets.json`.
+When loading configuration from files without providing the path to the file, the following locations/names are checked:
+
+- `<projectRoot>/config.*`
+- `<projectRoot>/../config.*`
+
+The file extensions `.js`, `.json`, `.ts`, `.cjs`, `.mjs`, `.cts`, `.mts` are checked, the first one found is used.
+For JavaScript/TypeScript files, the default export is expected to contain the configuration.
+If there is no default export, all other exports are handled as if they were a top-level object.
+
+Secrets file can be placed in the same location (project root or one directory above), and follow the same rules regarding file extensions.
 
 #### Overriding default file names
 
 For testing purpose it can be useful to override the file names locally.
-If `NODE_ENV` is set to `test`, file names will be `config-test.js[on]` and
-`secrets-test.js[on]`.
-Alternatively, if `KEEEX_CONFIG_SUFFIX` is set, it will be appended to the base
-names (with no dash).
+If `NODE_ENV` is set to `test`, file names will be `config-test.*` and `secrets-test.*`.
+Alternatively, if `KEEEX_CONFIG_SUFFIX` is set, it will be appended to the base names (with no dash).
 The `KEEEX_CONFIG_SUFFIX` option takes precedence over `NODE_ENV`.
 
 In any case, the default names (without any suffix) will be used as fallback.
@@ -38,10 +37,9 @@ In any case, the default names (without any suffix) will be used as fallback.
 It is possible to load a different configuration from command line.
 Passing `--config <some json>` will load that JSON instead of the config file.
 
-One can also pass `--config <path to json file>` to load a different config from
-another file.
+One can also pass `--config <path to json file>` to load a different config from another file.
 
-It is not possible to specify a different secret file from command line.
+The same can be done for secrets with `--secrets`.
 
 ### Accessing the configuration
 

package/lib/env.d.ts

@@ -25,11 +25,7 @@
  * <mailto: contact@keeex.net>
  * 
  */
-/**
- * Return the config suffix from env value
- */
+/** Return the config suffix from env value */
 export declare const getConfigSuffix: () => string | undefined;
-/**
- * Return the current NODE_ENV value (default to `production`)
- */
+/** Return the current NODE_ENV value (default to `production`) */
 export declare const getNodeEnv: () => string;

package/lib/env.js

@@ -25,11 +25,7 @@
  * <mailto: contact@keeex.net>
  * 
  */
-/**
- * Return the config suffix from env value
- */
+/** Return the config suffix from env value */
 export const getConfigSuffix = () => process.env.KEEEX_CONFIG_SUFFIX;
-/**
- * Return the current NODE_ENV value (default to `production`)
- */
+/** Return the current NODE_ENV value (default to `production`) */
 export const getNodeEnv = () => process.env.NODE_ENV ?? "production";

package/lib/index.d.ts

@@ -25,6 +25,6 @@
  * <mailto: contact@keeex.net>
  * 
  */
-import { type BaseConfig } from "./types.js";
-declare const _default: BaseConfig;
+import type * as types from "./types.js";
+declare const _default: types.BaseConfig;
 export default _default;

package/lib/index.js

@@ -25,178 +25,113 @@
  * <mailto: contact@keeex.net>
  * 
  */
-/**
- * Load configuration from three places, whichever works first:
- * - command line, as a JSON after "--config"
- * - command line, as the path to a JSON file after "--config"
- * - config file, `${CWD}/config.js`
- *
- * It will automatically append a "secrets" property to the config object read
- * from `${CWD}/secrets.js[on]`.
- */
-import { existsSync } from "fs";
-import { readFile } from "fs/promises";
-import { join, resolve, extname } from "path";
-import { getConfigSuffix, getNodeEnv } from "./env.js";
-const defaultCliArgName = "--config";
-const defaultConfigBasename = "config";
-const defaultSecretsBasename = "secrets";
-const acceptableExtensions = [".js", ".json", ".ts"];
-const configSuffix = (useSuffix) => {
-    if (!useSuffix) {
-        return "";
-    }
-    const suffixFromEnv = getConfigSuffix();
-    if (suffixFromEnv !== undefined) {
+import * as nodeFs from "node:fs";
+import * as nodePath from "node:path";
+import * as env from "./env.js";
+/** Return the suffix to use, if any */
+const configSuffix = () => {
+    const suffixFromEnv = env.getConfigSuffix();
+    if (suffixFromEnv !== undefined)
         return suffixFromEnv;
-    }
-    const nodeEnvValue = getNodeEnv();
-    if (nodeEnvValue === "test") {
-        return "-test";
-    }
-    return "";
+    const nodeEnvValue = env.getNodeEnv();
+    return nodeEnvValue === "test" ? "-test" : null;
 };
-/**
- * Config basename with suffix
- */
-const configBasename = (withSuffix) => `${defaultConfigBasename}${configSuffix(withSuffix)}`;
-/**
- * Secrets basename with suffix
- */
-const secretsBasename = (withSuffix) => `${defaultSecretsBasename}${configSuffix(withSuffix)}`;
-/**
- * Initial directory of the app. Hopefully the project root.
- */
-const projectRoot = process.cwd();
-/**
- * Try multiple suffix for a file path, return the first one that exist.
- */
-const getFirstFileFound = (basepath, basename, extensions) => {
-    for (const extension of extensions) {
-        const candidate = join(basepath, `${basename}${extension}`);
-        if (existsSync(candidate)) {
-            return candidate;
-        }
-    }
+/** Suffix to use for default file name */
+const suffix = configSuffix();
+/** If a suffix is present, return both the name without and with the suffix */
+const applySuffix = (basestr) => suffix ? [basestr, `${basestr}${suffix}`] : [basestr];
+/** Basename for config file */
+const configBasename = applySuffix("config");
+/** Basename for secret file */
+const secretsBasename = applySuffix("secrets");
+/** Compute the default directories to look through */
+const getDefaultDirs = () => {
+    /** Initial directory of the app. Hopefully the project root */
+    const projectRoot = process.cwd();
+    const parentDir = nodePath.resolve(projectRoot, "..");
+    return parentDir !== projectRoot && parentDir ? [projectRoot, parentDir] : [projectRoot];
 };
-/**
- * Return path to the config file
- */
-const getConfigPath = () => {
-    const configPath = getFirstFileFound(projectRoot, configBasename(true), acceptableExtensions);
-    if (configPath === undefined) {
-        const configPathNoSuffix = getFirstFileFound(projectRoot, configBasename(false), acceptableExtensions);
-        if (configPathNoSuffix === undefined) {
-            throw new Error("No configuration file found");
+/** Directories to search for config/secrets into */
+const checkDirs = getDefaultDirs();
+/** Returns the first file found in `checkDirs`, filenames, and configured extensions */
+const getFirstFileFound = (filenames) => {
+    for (const filepath of checkDirs) {
+        for (const filename of filenames) {
+            for (const extension of [".js", ".json", ".ts", ".cjs", ".mjs", ".cts", ".mts"]) {
+                const candidate = nodePath.resolve(filepath, `${filename}${extension}`);
+                if (nodeFs.existsSync(candidate))
+                    return candidate;
+            }
         }
-        return configPathNoSuffix;
-    }
-    return configPath;
-};
-/**
- * Return path to the secrets file
- */
-const getSecretsPath = () => {
-    const secretsPathWithSuffix = getFirstFileFound(projectRoot, secretsBasename(true), acceptableExtensions);
-    if (secretsPathWithSuffix) {
-        return secretsPathWithSuffix;
-    }
-    const secretsPathNoSuffix = getFirstFileFound(projectRoot, secretsBasename(false), acceptableExtensions);
-    if (secretsPathNoSuffix) {
-        return secretsPathNoSuffix;
-    }
-    const secretsPathAbove = getFirstFileFound(resolve(projectRoot, ".."), secretsBasename(false), acceptableExtensions);
-    if (secretsPathAbove) {
-        return secretsPathAbove;
     }
 };
+/** Path to the default config file */
+const configPath = getFirstFileFound(configBasename);
+/** Path to the default secrets file */
+const secretsPath = getFirstFileFound(secretsBasename);
 const loadFile = async (path) => {
-    const suffix = extname(path);
-    if ([".js", ".ts"].includes(suffix)) {
+    const fileSuffix = nodePath.extname(path);
+    if ([".js", ".ts", ".cjs", ".mjs", ".cts", ".mts"].includes(fileSuffix)) {
         const module = (await import(path));
-        if (module.default) {
+        if (module.default)
             return module.default;
-        }
         return module;
     }
-    if (suffix === ".json") {
-        return JSON.parse(await readFile(path, "utf8"));
-    }
-    throw new Error(`Unexpected suffix: ${suffix}`);
+    if (fileSuffix === ".json")
+        return JSON.parse(await nodeFs.promises.readFile(path, "utf8"));
+    throw new Error(`Unexpected suffix: ${fileSuffix}`);
 };
-/**
- * Return the secrets data
- */
-const getSecrets = async () => {
-    const secretsPath = getSecretsPath();
-    if (secretsPath === undefined) {
+/** Return the content of a file */
+const getFromFile = async (filepath) => {
+    if (filepath === undefined)
         return;
-    }
-    return loadFile(secretsPath);
+    return loadFile(filepath);
 };
 /**
- * Return the configuration object from the command line arguments
+ * Get config from the CLI.
+ *
+ * Check if `--${argName}` is present, and if so, tries to interpret it as JSON or as a file path to load.
+ *
+ * @returns
+ * The loaded content, or `null` if the argument is not present.
  */
-const getConfigFromCLI = async () => {
-    const cliArgName = defaultCliArgName;
-    const configArgIndex = process.argv.indexOf(cliArgName);
-    if (configArgIndex !== -1) {
-        const configFromArgs = process.argv[configArgIndex + 1];
-        const valuesExtracted = 2;
-        process.argv.splice(configArgIndex, valuesExtracted);
-        // eslint-disable-next-line @typescript-eslint/init-declarations
-        let configObj;
-        try {
-            configObj = JSON.parse(configFromArgs);
-        }
-        catch {
-            configObj = JSON.parse(await readFile(configFromArgs, "utf8"));
-        }
+const getFromCli = async (argv, argName) => {
+    const configArgIndex = argv.indexOf(`--${argName}`);
+    if (configArgIndex === -1)
+        return null;
+    const valueIndex = configArgIndex + 1;
+    if (argv.length <= valueIndex)
+        throw new Error(`--${argName} requires a string argument`);
+    const value = argv[valueIndex];
+    const valuesExtracted = 2;
+    argv.splice(configArgIndex, valuesExtracted);
+    if (value.startsWith("{")) {
+        const configObj = JSON.parse(value);
         return configObj;
     }
-    return null;
+    return JSON.parse(await nodeFs.promises.readFile(value, "utf8"));
 };
-/**
- * Load the project configuration from a file
- */
-const getConfigFromFile = async () => {
-    const filePath = getConfigPath();
-    return loadFile(filePath);
-};
-/**
- * Return the configuration object from the first available source
- */
-const getBaseProjectConfig = async () => {
-    const configFromCLI = await getConfigFromCLI();
-    if (configFromCLI !== null) {
-        return configFromCLI;
-    }
-    return getConfigFromFile();
-};
-/**
- * Merge the base configuration and the secrets
- */
-const getProjectConfig = async () => {
-    const baseConfig = await getBaseProjectConfig();
-    const secrets = await getSecrets();
+/** Return the specified object from the first available source */
+const getBaseData = async (argv, argName, filepath) => (await getFromCli(argv, argName)) ?? getFromFile(filepath);
+/** Merge the base configuration and the secrets */
+const getProjectConfig = async (argv) => {
+    const baseConfig = await getBaseData(argv, "config", configPath);
+    if (!baseConfig)
+        throw new Error("Missing base project configuration");
+    const secrets = await getBaseData(argv, "secrets", secretsPath);
     if (secrets) {
-        const merged = {
-            ...baseConfig,
-            secrets,
-        };
+        const merged = { ...baseConfig, secrets };
         return merged;
     }
     return baseConfig;
 };
-/**
- * Cache of the loaded configuration
- */
+/** Cache of the loaded configuration */
 let config = null;
 /** Load the project configuration */
-const loadConfig = () => {
+const loadConfig = (argv) => {
     config ??= (async () => {
         try {
-            const cfg = await getProjectConfig();
+            const cfg = await getProjectConfig(argv);
             return cfg;
         }
         catch (error) {
@@ -206,4 +141,4 @@ const loadConfig = () => {
     })();
     return config;
 };
-export default await loadConfig();
+export default await loadConfig(process.argv);

package/lib/types.d.ts

@@ -25,7 +25,5 @@
  * <mailto: contact@keeex.net>
  * 
  */
-/**
- * Base for any returned configuration
- */
+/** Base for any returned configuration */
 export type BaseConfig = Record<string, any>;

package/package.json

@@ -1 +1 @@
-{"name":"@keeex/projectconfig","version":"4.1.2","description":"Load project configuration with separate secrets","main":"./lib/index.js","scripts":{},"type":"module","author":"KeeeX SAS","contributors":[{"email":"gabriel@keeex.net","name":"Gabriel Paul \"Cley Faye\" Risterucci"}],"license":"SEE LICENSE IN LICENSE","files":["lib"],"exports":{".":"./lib/index.js","./env.js":"./lib/env.js","./index.js":"./lib/index.js","./lib/env.js":"./lib/env.js","./lib/index.js":"./lib/index.js","./lib/types.js":"./lib/types.js","./types.js":"./lib/types.js"},"homepage":"https://keeex.me/oss"}
+{"name":"@keeex/projectconfig","version":"4.2.0","description":"Load project configuration with separate secrets","main":"./lib/index.js","scripts":{},"type":"module","author":"KeeeX SAS","contributors":[{"email":"gabriel@keeex.net","name":"Gabriel Paul \"Cley Faye\" Risterucci"}],"license":"SEE LICENSE IN LICENSE","files":["lib"],"exports":{".":"./lib/index.js","./env.js":"./lib/env.js","./index.js":"./lib/index.js","./lib/env.js":"./lib/env.js","./lib/index.js":"./lib/index.js","./lib/types.js":"./lib/types.js","./types.js":"./lib/types.js"},"homepage":"https://keeex.me/oss"}