@digigov/cli 2.0.0-2177f152 → 2.0.0-264e5fff

package/index.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
-import { DigigovCommand } from "./lib/command.js";
-import { loadCommands } from "./load-commands.js";
+import { DigigovCommand } from './lib/command.js';
+import { loadCommands } from './load-commands.js';
 
-const program = new DigigovCommand("digigov", import.meta.url);
+const program = new DigigovCommand('digigov', import.meta.url);
 
 await loadCommands(program);
 

package/lib/command.js

@@ -1,10 +1,10 @@
-import fs from "fs-extra";
-import path from "path";
-import * as execa from "execa";
-import * as commander from "commander";
-import { fileURLToPath } from "url";
-import { logger } from "./logger.js";
-import { findPackageJson } from "./project-utils.cjs";
+import fs from 'fs-extra';
+import path from 'path';
+import * as execa from 'execa';
+import * as commander from 'commander';
+import { fileURLToPath } from 'url';
+import { logger } from './logger.js';
+import { findPackageJson } from './project-utils.cjs';
 
 /**
  * A class that extends the Commander Command class with additional
@@ -15,7 +15,6 @@ import { findPackageJson } from "./project-utils.cjs";
 export class DigigovCommand extends commander.Command {
   /**
    * The id of the command used for logging
-   * @private
    * @type {string}
    */
   #id;
@@ -34,14 +33,14 @@ export class DigigovCommand extends commander.Command {
       ? path.dirname(fileURLToPath(importMetaUrl))
       : null;
 
-    this.option("-d, --debug", "display debug information");
+    this.option('-d, --debug', 'display debug information');
 
     this.configureOutput({
-      writeErr: (str) => logger.error(str.replace(/^error: /i, "")),
+      writeErr: (str) => logger.error(str.replace(/^error: /i, '')),
     });
 
     if (this.context) {
-      if (this.context.endsWith("dist")) {
+      if (this.context.endsWith('dist')) {
         this.context = path.dirname(this.context);
       }
       const pkgPath = findPackageJson(this.context);
@@ -57,6 +56,7 @@ export class DigigovCommand extends commander.Command {
    * @override
    * @param {string} message - The message to log
    * @param {commander.ErrorOptions} [errorOptions] - The error options
+   * @returns {never}
    */
   error(message, errorOptions) {
     logger.error(message);
@@ -66,7 +66,7 @@ export class DigigovCommand extends commander.Command {
   /**
    * @override
    * @param {(...args: any[]) => void | Promise<void>} fn - The function to run
-   * @returns {DigigovCommand} `this` command for chaining
+   * @returns {this} `this` command for chaining
    */
   action(fn) {
     return super.action(async (...args) => {
@@ -91,39 +91,42 @@ export class DigigovCommand extends commander.Command {
     const __dirname =
       this.context ?? path.dirname(fileURLToPath(import.meta.url));
     const binLocation = [process.cwd(), __dirname].find((location) => {
-      return fs.existsSync(path.join(location, "node_modules", ".bin", script));
+      return fs.existsSync(path.join(location, 'node_modules', '.bin', script));
     });
     if (!binLocation || !fs.existsSync(binLocation)) {
       this.#throwError(`Executable ${script} not installed`);
     }
     const executablePath = path.join(
       binLocation,
-      "node_modules",
-      ".bin",
-      script,
+      'node_modules',
+      '.bin',
+      script
     );
     const executableName = path.basename(executablePath);
-    logger.log(`Running: ${executableName} ${args.join(" ")}`);
+    logger.log(`Running: ${executableName} ${args.join(' ')}`);
     try {
       return execa.execa(executablePath, args, {
         ...config,
-        stdio: "inherit",
+        stdio: 'inherit',
       });
     } catch (error) {
-      this.#throwError(error.message);
+      this.#throwError(error);
     }
   }
 
   /**
-   * @private
+   * @param {unknown} error - The error to log
+   * @returns {never}
    */
   #throwError(error) {
-    if (typeof error === "string") logger.error(error);
-    if (typeof error === "object" && error) {
-      logger.error("stack" in error ? error.stack : error);
-      if ("exitCode" in error && typeof error.exitCode === "number") {
-        process.exit(error.exitCode);
-      }
+    if (typeof error === 'string') logger.error(error);
+    if (
+      typeof error === 'object' &&
+      error &&
+      'exitCode' in error &&
+      typeof error.exitCode === 'number'
+    ) {
+      process.exit(error.exitCode);
     }
     process.exit(1);
   }

package/lib/index.js

@@ -1,3 +1,3 @@
-export * from "./command.js";
-export * from "./project-utils.cjs";
-export * from "./logger.js";
+export * from './command.js';
+export * from './project-utils.cjs';
+export * from './logger.js';

package/lib/logger.js

@@ -1,44 +1,63 @@
-import chalk from "chalk";
+import chalk from 'chalk';
 
 const args = process.argv.slice(2);
-const IS_DEBUG = args.includes("--debug") || args.includes("-d");
+const IS_DEBUG = args.includes('--debug') || args.includes('-d');
 
+/**
+ * @param {any[]} data - The data to log
+ */
 function log(...data) {
-  console.log(chalk.bgWhite.black(" LOG "), ...data);
+  console.log(chalk.bgWhite.black(' LOG '), ...data);
 }
 
+/**
+ * @param {any[]} data - The data to log
+ */
 function info(...data) {
-  console.log(chalk.bgBlue(" INFO "), chalk.blue(...data));
+  console.log(chalk.bgBlue(' INFO '), chalk.blue(...data));
 }
+
+/**
+ * @param {any[]} data - The data to log
+ */
 function error(...data) {
-  console.error(chalk.bgRed(" ERROR "), chalk.red(...data));
+  console.error(chalk.bgRed(' ERROR '), chalk.red(...data));
 }
 
+/**
+ * @param {any[]} data - The data to log
+ */
 function success(...data) {
-  console.log("✅ ", chalk.green(...data));
+  console.log('✅ ', chalk.green(...data));
 }
 
+/**
+ * @param {any[]} data - The data to log
+ */
 function warn(...data) {
-  console.log(chalk.bgYellow.black(" WARN "), chalk.yellow(...data));
+  console.log(chalk.bgYellow.black(' WARN '), chalk.yellow(...data));
 }
 
+/**
+ * @param {any[]} data - The data to log
+ */
 function debug(...data) {
   if (IS_DEBUG)
-    console.log(chalk.dim.bgWhite.black(" DEBUG "), chalk.dim(...data));
+    console.log(chalk.dim.bgWhite.black(' DEBUG '), chalk.dim(...data));
 }
 
 /**
  * @param {string} label - The label for the timer
  */
 function time(label) {
-  console.time(chalk.bgMagenta("⏱️ " + label));
+  console.time(chalk.bgMagenta('⏱️ ' + label));
 }
 
 /**
  * @param {string} label - The label for the timer
  */
 function timeEnd(label) {
-  console.timeEnd(chalk.bgMagenta("⏱️ " + label));
+  console.timeEnd(chalk.bgMagenta('⏱️ ' + label));
 }
 
 export const logger = {

package/lib/project-utils.cjs

@@ -1,7 +1,7 @@
-const fs = require("fs-extra");
-const path = require("path");
-const merge = require("deepmerge");
-const rushLib = require("@microsoft/rush-lib");
+const fs = require('fs-extra');
+const path = require('path');
+const merge = require('deepmerge');
+const rushLib = require('@microsoft/rush-lib');
 
 /**
  * Resolve the project configuration from the nearest package.json
@@ -10,21 +10,21 @@ const rushLib = require("@microsoft/rush-lib");
  */
 function resolveProject(dir) {
   const pkg = findPackageJson(dir);
-  if (!pkg) throw new Error("No package.json found"); // TODO: reconsider this
+  if (!pkg) throw new Error('No package.json found'); // TODO: reconsider this
   const root = path.dirname(pkg);
   let externalLockFile = false;
   if (
-    fs.existsSync(path.join(root, "yarn.lock")) ||
-    fs.existsSync(path.join(root, "package-lock.json"))
+    fs.existsSync(path.join(root, 'yarn.lock')) ||
+    fs.existsSync(path.join(root, 'package-lock.json'))
   ) {
     externalLockFile = true;
   }
-  let distDir = "dist";
-  let src = "src";
+  let distDir = 'dist';
+  let src = 'src';
 
   if (!fs.existsSync(path.join(root, src))) {
-    src = ".";
-    distDir = ".";
+    src = '.';
+    distDir = '.';
   }
   // project type heuristics
   let isLib = false;
@@ -33,18 +33,18 @@ function resolveProject(dir) {
   let isDocs = false;
 
   if (
-    fs.existsSync(path.join(root, "next.config.js")) ||
-    fs.existsSync(path.join(root, "pages"))
+    fs.existsSync(path.join(root, 'next.config.js')) ||
+    fs.existsSync(path.join(root, 'pages'))
   ) {
     isApp = true;
   }
   if (
-    fs.existsSync(path.join(root, "docusaurus.config.js")) &&
-    fs.existsSync(path.join(root, "docs"))
+    fs.existsSync(path.join(root, 'docusaurus.config.js')) &&
+    fs.existsSync(path.join(root, 'docs'))
   ) {
     isDocs = true;
   }
-  if (fs.existsSync(path.join(root, "src")) && !isApp) {
+  if (fs.existsSync(path.join(root, 'src')) && !isApp) {
     isLib = true;
   }
 
@@ -61,9 +61,9 @@ function resolveProject(dir) {
   const isNodeLib = !isLib && !isApp && !isWorkspace && !isDocs;
 
   /** @type {string | null} */
-  let ignore = path.resolve(root, ".gitignore");
+  let ignore = path.resolve(root, '.gitignore');
   if (!fs.existsSync(ignore) && workspace.root) {
-    ignore = path.resolve(workspace.root, ".gitignore");
+    ignore = path.resolve(workspace.root, '.gitignore');
   }
 
   if (!fs.existsSync(ignore)) {
@@ -71,11 +71,11 @@ function resolveProject(dir) {
   }
 
   let digigov = {};
-  if (fs.existsSync(path.join(root, "digigovrc.json"))) {
-    digigov = fs.readJSONSync(path.join(root, "digigovrc.json"));
+  if (fs.existsSync(path.join(root, 'digigovrc.json'))) {
+    digigov = fs.readJSONSync(path.join(root, 'digigovrc.json'));
   }
-  if (fs.existsSync(path.join(root, "digigovrc.js"))) {
-    digigov = require(path.join(root, "digigovrc.js"));
+  if (fs.existsSync(path.join(root, 'digigovrc.js'))) {
+    digigov = require(path.join(root, 'digigovrc.js'));
   }
 
   const packageJS = fs.readJSONSync(pkg);
@@ -83,7 +83,7 @@ function resolveProject(dir) {
   const devDependencies = packageJS.devDependencies || {};
   const dependencies = packageJS.dependencies || {};
   const peerDependencies = packageJS.peerDependencies || {};
-  const isTs = Object.keys(devDependencies).includes("typescript");
+  const isTs = Object.keys(devDependencies).includes('typescript');
   const allDependencies = {
     ...dependencies,
     ...devDependencies,
@@ -121,16 +121,16 @@ function findPackageJson(startDir = process.cwd()) {
 
   if (!fs.existsSync(currentDir) || !fs.lstatSync(currentDir).isDirectory()) {
     throw new Error(
-      `The start directory "${startDir}" is not a valid directory.`,
+      `The start directory "${startDir}" is not a valid directory.`
     );
   }
 
   while (true) {
-    const packageJsonPath = path.join(currentDir, "package.json");
+    const packageJsonPath = path.join(currentDir, 'package.json');
     if (fs.existsSync(packageJsonPath)) {
       return packageJsonPath;
     }
-    const parentDir = path.resolve(currentDir, "..");
+    const parentDir = path.resolve(currentDir, '..');
     if (parentDir === currentDir) return undefined;
 
     currentDir = parentDir;
@@ -146,17 +146,18 @@ function localRequire(file) {
   const project = resolveProject();
   const filePath = path.join(project.root, file);
   if (!fs.existsSync(filePath)) return {};
-  if (file.endsWith(".json")) return fs.readJSONSync(filePath);
+  if (file.endsWith('.json')) return fs.readJSONSync(filePath);
   else return require(filePath);
 }
+
 function makeConfig(file, cfg = {}) {
   let hook = {};
-  if (file && typeof file !== "string") {
+  if (file && typeof file !== 'string') {
     hook = file;
-  } else if (typeof file === "string") {
+  } else if (typeof file === 'string') {
     hook = localRequire(file);
   }
-  if (typeof hook === "function") {
+  if (typeof hook === 'function') {
     return hook(cfg);
   }
   if (hook) {
@@ -174,11 +175,11 @@ function resolveWorkspace() {
     const rushConfiguration = rushLib.RushConfiguration.loadFromDefaultLocation(
       {
         startingFolder: process.cwd(),
-      },
+      }
     );
     return rushConfiguration;
-  } catch (err) {
-    console.error(err);
+  } catch {
+    // No rush config, ignore error
   }
   return null;
 }
@@ -189,13 +190,14 @@ function resolveWorkspace() {
  */
 function resolveLocalPackages(dependencies) {
   const rush = resolveWorkspace();
+  /** @type {{ [key: string]: ReturnType<typeof resolveProject> }} */
   let localPackages = {};
   if (rush) {
     const rushProjects = rush.projects;
     for (const project of rushProjects) {
       if (dependencies.includes(project.packageName)) {
         localPackages[project.packageName] = resolveProject(
-          project.projectFolder,
+          project.projectFolder
         );
       }
     }
@@ -212,20 +214,24 @@ function resolveLocalPackages(dependencies) {
  *
  */
 function aliases(absolute = false) {
+  /** @type {{ [key: string]: string }} */
   const aliases = {};
   const project = resolveProject();
-  const depKeys = ["dependencies", "peerDependencies", "devDependencies"];
+  const depKeys = ['dependencies', 'peerDependencies', 'devDependencies'];
   const root = project.root;
-  const deps = depKeys.reduce((deps, key) => {
-    return deps.concat(Object.keys(project.package[key] || {}));
-  }, []);
+  /** @type {string[]} */
+  let deps = [];
+  for (const key of depKeys) {
+    deps = deps.concat(Object.keys(project.package[key] || {}));
+  }
   const packages = resolveLocalPackages(deps);
   Object.keys(packages).forEach((key) => {
     const project = packages[key];
     if (
+      project &&
       deps.includes(project.name) &&
       project.package.devDependencies &&
-      project.package.devDependencies["@digigov/cli-build"] &&
+      project.package.devDependencies['@digigov/cli-build'] &&
       project.isWorkspace
     ) {
       const projectSrc = path.join(project.root, project.src);

package/load-commands.js

@@ -1,16 +1,16 @@
-import fs from "fs-extra";
-import path from "path";
-import { fileURLToPath } from "url";
-import { logger } from "./lib/index.js";
-import { DigigovCommand, findPackageJson } from "./lib/index.js";
+import fs from 'fs-extra';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { logger } from './lib/index.js';
+import { findPackageJson } from './lib/index.js';
 
 /**
- * @param {DigigovCommand} program - The program to load commands into
+ * @param {import('./lib/index.js').DigigovCommand} program - The program to load commands into
  */
 export async function loadCommands(program) {
   const packageFilePath = findPackageJson();
   if (!packageFilePath) {
-    logger.warn("No package.json found");
+    logger.warn('No package.json found');
     return;
   }
   const packageFile = fs.readFileSync(packageFilePath);
@@ -24,9 +24,9 @@ export async function loadCommands(program) {
     try {
       const modulePath = path.resolve(
         process.cwd(),
-        "node_modules",
+        'node_modules',
         commandPackage,
-        "index.js",
+        'index.js'
       );
       const realPath = fs.realpathSync(modulePath);
       const command = await import(
@@ -40,10 +40,9 @@ export async function loadCommands(program) {
         error.message.endsWith("undefined (reading '_name')")
       )
         logger.warn(
-          errorPrefix,
-          "| Did you forget to default export the command?",
+          `${errorPrefix}\nDid you forget to default export the command?`
         );
-      else logger.warn(errorPrefix, error);
+      else logger.warn(`${errorPrefix}\n${error}`);
     }
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@digigov/cli",
   "description": "CLI for Digigov apps and libs with plugin support",
-  "version": "2.0.0-2177f152",
+  "version": "2.0.0-264e5fff",
   "author": "GRNET Devs <devs@lists.grnet.gr>",
   "type": "module",
   "bin": {
@@ -11,12 +11,15 @@
     "fs-extra": "11.2.0",
     "deepmerge": "4.3.1",
     "execa": "8.0.1",
-    "@microsoft/rush-lib": "5.133.4",
+    "@microsoft/rush-lib": "5.151.0",
     "commander": "12.1.0",
     "chalk": "4.1.0"
   },
   "devDependencies": {
-    "publint": "0.1.8"
+    "publint": "0.1.8",
+    "typescript": "5.6.2",
+    "@types/fs-extra": "11.0.4",
+    "@types/node": "20.17.24"
   },
   "engines": {
     "node": ">=18"
@@ -33,10 +36,12 @@
     "./lib": {
       "require": "./lib/project-utils.cjs",
       "default": "./lib/index.js"
-    }
+    },
+    "./tsconfig.cli": "./tsconfig.cli.json"
   },
   "scripts": {
     "publint": "publint",
-    "lint": "echo 'no lint needed (yet)'"
+    "lint": "echo 'no lint needed (yet)'",
+    "typecheck": "tsc"
   }
 }

package/tsconfig.cli.json

@@ -2,9 +2,9 @@
   "compilerOptions": {
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
-    "sourceMap": true,
+    "noEmit": true,
     "allowJs": true,
-    "declaration": true,
+    "checkJs": true,
     "strict": true,
     "allowSyntheticDefaultImports": true,
     "skipLibCheck": true,
@@ -13,7 +13,7 @@
     "forceConsistentCasingInFileNames": true,
     "noImplicitReturns": true,
     "noImplicitThis": true,
-    "noImplicitAny": true,
+    "noImplicitAny": false,
     "strictNullChecks": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,