about-code · about-code · Aug 23, 2023 · Aug 23, 2023 · Aug 24, 2023 · Aug 25, 2023
diff --git a/.github/workflows/tests-functional.yml b/.github/workflows/tests-functional.yml
@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macOS-latest]
-        node-version: [16.x, 18.x, 19.x]
+        node-version: [16.x, 18.x, 20.x]
     steps:
     - uses: actions/checkout@v2
       with:

diff --git a/.github/workflows/tests-latest.yml b/.github/workflows/tests-latest.yml
@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macOS-latest]
-        node-version: [16.x, 18.x, 19.x]
+        node-version: [16.x, 18.x, 20.x]
     steps:
     - uses: actions/checkout@v2
       with:

diff --git a/bin/index.js b/bin/index.js
@@ -1,332 +1,6 @@
 #!/usr/bin/env node
-import merge from "deepmerge";
-import fs from "fs-extra";
-import minimist from "minimist";
-import nodeFs from "node:fs";
-import { createRequire } from "node:module";
-import path from "node:path";
 import proc from "node:process";
-import { NO_BASEDIR, NO_OUTDIR, OUTDIR_IS_BASEDIR, OUTDIR_IS_BASEDIR_WITH_DROP } from "../lib/cli/messages.js";
-import { upgrade } from "../lib/cli/upgrade.js";
-import * as main from "../lib/main.js";
-import { watch } from "chokidar";
+import { main } from "../lib/cli/main.js";
 
-const require_ = createRequire(import.meta.url);
-const confSchema = require_("../conf/v5/schema.json");
-const packageJson = require_("../package.json");
-const version = packageJson.version;
-const CWD = proc.cwd();
-const banner =
-`┌──────────────────────────┐
-│   glossarify-md v${version}   │
-└──────────────────────────┘
-`;
-
-// _/ CLI \_____________________________________________________________________
-const cli = {
-    "config": {
-        alias: "c"
-        ,description: "Path to config file, e.g. './glossarify-md.conf.json'."
-        ,type: "string"
-        ,default: "./glossarify-md.conf.json"
-    }
-    ,"deep": {
-        alias: ""
-        ,description: "Deeply merge the given JSON configuration string with the configuration file or default configuration. This will _extend_ nested arrays and replace only those keys exactly matching with the given structure. Use --shallow to shallow-merge."
-        ,type: "string"
-        ,default: ""
-    }
-    ,"help": {
-        alias: "h"
-        ,description: "Show this help."
-        ,type: "boolean"
-        ,default: false
-    }
-    ,"init": {
-        alias: ""
-        ,description: "Generate a configuration file with default values. Usage: 'glossarify-md --init > glossarify-md.conf.json'"
-        ,type: "boolean"
-        ,default: false
-    }
-    ,"local": {
-        alias: ""
-        ,description: "When used with --init generates a configuration using a local node_modules path to the config schema."
-        ,type: "boolean"
-        ,default: false
-    }
-    ,"logfile": {
-        alias: ""
-        ,description: "Where to write console logs into. Used for testing."
-        ,type: "string"
-        ,default: ""
-    }
-    ,"more": {
-        alias: ""
-        ,description: "When used with --init generates an extended configuration with default values otherwise applied in the background."
-        ,type: "boolean"
-        ,default: false
-    }
-    ,"new": {
-        alias: ""
-        ,description: "When used with --init generates a file ./docs/glossary.md"
-        ,type: "boolean"
-        ,default: false
-    }
-    ,"shallow": {
-        alias: ""
-        ,description: "A JSON string for an object to be shallow-merged with the default configuration or a configuration file provided with --config. Usage: `glossarify-md --shallow \"{'baseDir': './input'}\"`. Shallow merging _replaces_ nested property values. Use --deep to deep-merge."
-        ,type: "string"
-        ,default: ""
-    }
-    ,"watch": {
-        alias: "w"
-        ,description: "Watch the base directory"
-        ,type: "boolean"
-        ,default: false
-    }
-};
-const argv = minimist(proc.argv.slice(2), cli);
-
-// --logfile
-if (argv.logfile) {
-    try {
-        nodeFs.unlinkSync(argv.logfile);
-    } catch (err) {
-        /* ignore */
-    }
-    nodeFs.mkdirSync(path.dirname(argv.logfile), { recursive: true });
-    const logfile = path.resolve(argv.logfile);
-    const logError = console.error;
-    const logger = (txt) => {
-        try {
-            nodeFs.writeFileSync(logfile, `${txt}\n`, { flag: "a"});
-        } catch (err) {
-            logError(err);
-        }
-    };
-    console.log = logger;
-    console.warn = logger;
-    console.error = logger;
-    console.info = logger;
-}
-
-// --init
-// Show banner only in absence of --init; Prevents writing banner
-// to file for 'glossarify-md --init >> glossarify-md.conf.json'
-if (!argv.init) {
-    console.log(banner);
-}
-
-// --help (or no args at all)
-if (argv.help || proc.argv.length === 2) {
-    printHelp(cli);
-    proc.exit(0);
-}
-
-/**
- *
- * @param {*} argv key value map of CLI args
- * @param {*} cwd current working directory
- * @returns
- */
-async function configure(argv, cwd) {
-
-    const confSchemaProps = confSchema.properties;
-    const confDefault = Object
-        .keys(confSchemaProps)
-        .reduce((obj, key) => {
-            // Set up a default config from default values in the config schema.
-            obj[key] = confSchemaProps[key].default;
-            return obj;
-        }, { "$schema": confSchema.$id });
-
-    // --config
-    let confPath = argv.config || "";
-    let confDir  = cwd;
-    let confUser = {};
-    if (confPath) {
-        try {
-            confPath = path.resolve(cwd, confPath);
-            confDir  = path.dirname(confPath);
-            const confFile = await fs.readFile(confPath);
-            const confData = JSON.parse(confFile);
-            // --noupgrade
-            if (!argv.noupgrade) {
-                confUser = await upgrade(confData, confPath, confDefault);
-            }
-        } catch (e) {
-            console.error(`Failed to read config '${confPath}'.\nReason:\n  ${e.message}\n`);
-            proc.exit(1);
-        }
-    }
-
-    // --deep
-    if (argv.deep) {
-        try {
-            const confUserCli = JSON.parse(argv.deep.replace(/'/g, "\""));
-            confUser = merge(confUser, confUserCli);
-        } catch (e) {
-            console.error(`Failed to parse value for --deep.\nReason:\n  ${e.message}\n`);
-            proc.exit(1);
-        }
-    }
-    // --shallow
-    if (argv.shallow) {
-        try {
-            const confUserCli = JSON.parse(argv.shallow.replace(/'/g, "\""));
-            confUser = Object.assign(confUser, confUserCli);
-        } catch (e) {
-            console.error(`Failed to parse value for --shallow.\nReason:\n  ${e.message}\n`);
-            proc.exit(1);
-        }
-    }
-
-    // Merge custom conf with default conf
-    const conf = merge(confDefault, confUser, {
-        clone: false
-        , arrayMerge: (_default, curConf) => {
-            return curConf && curConf.length > 0 ? curConf : _default;
-        }
-    });
-
-    return { confDir, conf };
-}
-
-
-// _/ Helpers \_________________________________________________________________
-function validateConf(conf) {
-
-    if (conf.baseDir === "") {
-        console.log(NO_BASEDIR);
-        console.log("ABORTED.\n");
-        proc.exit(0);
-    }
-
-    if (conf.outDir === "") {
-        console.log(NO_OUTDIR);
-        console.log("ABORTED.\n");
-        proc.exit(0);
-    }
-
-    console.log(`☛ Reading from: ${conf.baseDir}`);
-    console.log(`☛ Writing to:   ${conf.outDir}\n`);
-
-    if (conf.outDir === conf.baseDir) {
-        if (conf.outDirDropOld) {
-            console.log(OUTDIR_IS_BASEDIR_WITH_DROP);
-            console.log("ABORTED.\n");
-            proc.exit(0);
-        } else if (!argv.force) {
-            console.log(OUTDIR_IS_BASEDIR);
-            console.log("ABORTED.\n");
-            proc.exit(0);
-        }
-    }
-}
-
-// --init
-function writeConf(conf, argv) {
-
-    let fileOpts = null;
-    let replacer = null;
-
-    // --local
-    if (argv.local) {
-        // append version path segment from schema URI to local path
-        conf.$schema = `./node_modules/glossarify-md/conf/${conf.$schema.split("/conf/")[1]}`;
-    } else {
-        conf.$schema = conf.$schema.replace(/\/v(\.?\d){3}\/conf/, `/v${version}/conf`);
-    }
-    // --more
-    if (argv.more) {
-        delete conf.dev;
-        fileOpts = { spaces: 2 };
-    } else {
-        // generate a minimal configuration
-        replacer = (that, keyVal) => {
-            if (typeof keyVal === "object") {
-                const {$schema, baseDir, outDir} = keyVal;
-                return {$schema, baseDir, outDir};
-            } else {
-                return keyVal;
-            }
-        };
-        fileOpts = { spaces: 2, replacer };
-    }
-
-    // --new
-    if (argv.new) {
-        const glossaryFile = path.resolve(conf.baseDir, "glossary.md");
-        const configFile = path.resolve(conf.baseDir, "../glossarify-md.conf.json");
-        if (fs.pathExistsSync(glossaryFile)) {
-            console.log(`⚠ Warning: ${glossaryFile} already exists. Nothing written.`);
-        } else {
-            fs.outputFileSync(glossaryFile, "# Glossary", "utf8");
-        }
-        if (fs.pathExistsSync(configFile)) {
-            console.log(`⚠ Warning: ${configFile} already exists. Nothing written.`);
-        } else {
-            fs.writeJsonSync(configFile, conf, fileOpts);
-        }
-    } else {
-        console.log(JSON.stringify(conf, replacer, 2));
-    }
-}
-
-// --help
-function printHelp(parameters) {
-    console.log("Options:\n");
-    console.log(
-        Object
-            .keys(parameters)
-            .filter(key => key !== "dev")
-            .sort((a, b) => a.localeCompare(b, "en"))
-            .map(key => {
-                const {alias, type, description, default:_default} = parameters[key];
-                return `--${key}${alias ? ", --" + alias : ""} (${type})\n  Default: ${JSON.stringify(_default)}\n\n${description}\n\n`;
-            })
-            .join("")
-    );
-}
-
-// _/ Run \_____________________________________________________________________
-async function run() {
-
-    const { confDir, conf } = await configure(argv, CWD);
-
-    // --init
-    if (argv.init) {
-        writeConf(conf, argv);
-        proc.exit(0);
-    }
-
-    // Resolve baseDir relative to confDir and outDir relative to baseDir
-    conf.baseDir = path.resolve(confDir, conf.baseDir);
-    conf.outDir  = path.resolve(conf.baseDir, conf.outDir);
-    validateConf(conf, argv);
-    try {
-        // --watch
-        if (argv.watch) {
-            await main.run(conf);
-            // Do not drop 'outDir' while watching. Dropping it would cause some
-            // subsequent 3rd-party watchers on it to break (e.g. vuepress 1.x)
-            conf.outDirDropOld = false;
-            console.log(`Start watching ${conf.baseDir}...`);
-            const watcher = watch(conf.baseDir, { ignoreInitial: true, interval: 200 })
-                .on("add",    path => { console.log(`${path} added.`);   main.run(conf); })
-                .on("change", path => { console.log(`${path} changed.`); main.run(conf); })
-                .on("unlink", path => { console.log(`${path} deleted.`); main.run(conf); });
-            const stopWatching = async () => {
-                await watcher.close();
-                console.log("Stopped watching.");
-            };
-            process.on("SIGINT", stopWatching);
-        } else {
-            await main.run(conf);
-        }
-    } catch (err) {
-        console.error(err);
-        proc.exit(1);
-    }
-}
-run();
+const cliArgv = proc.argv.slice(2);
+main(cliArgv);
diff --git a/lib/api.js b/lib/api.js
@@ -0,0 +1 @@
+export  {runViaApi as run, getSlugger} from "./main.js";