add linter as a command to tool cli

mdn · Feb 23, 2023 · d058166 · d058166
1 parent 18a8f5d
commit d058166
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 44 deletions.
diff --git a/fmlint/cli.ts b/fmlint/cli.ts
diff --git a/fmlint/linter.ts b/fmlint/linter.ts
@@ -182,7 +182,7 @@ function compileValidators(config: FMConfig) {
 }
 
 // lint front matter
-export async function runLinter(
+export async function lintFrontMatter(
   filesAndDirectories: string[],
   options: LinterOptions
 ) {

diff --git a/fmlint/types.ts b/fmlint/types.ts
@@ -1,6 +1,6 @@
 import { ActionParameters } from "@caporal/core";
 
-export interface CliArgsAndOptions extends ActionParameters {
+export interface FMLintArgsAndOptions extends ActionParameters {
   args: {
     files?: string[];
   };

diff --git a/tool/cli.ts b/tool/cli.ts
@@ -41,6 +41,8 @@ import {
   MacroInvocationError,
   MacroRedirectedLinkError,
 } from "../kumascript/src/errors.js";
+import { FMLintArgsAndOptions } from "../fmlint/types.js";
+import { lintFrontMatter } from "../fmlint/linter.js";
 
 const { program } = caporal;
 const { prompt } = inquirer;
@@ -1191,6 +1193,36 @@ if (Mozilla && !Mozilla.dntEnabled()) {
       const { deprecatedOnly, format, unusedOnly } = options;
       return macroUsageReport({ deprecatedOnly, format, unusedOnly });
     })
+  )
+
+  .command("fmlint", "Validate and prettify front matter.")
+  .option("--cwd <path>", "Explicit current-working-directory", {
+    validator: program.STRING,
+    default: process.cwd(),
+  })
+  .option("--config <path>", "Front matter config file location", {
+    validator: program.STRING,
+    default: fileURLToPath(
+      new URL("../fmlint/front-matter-config.json", import.meta.url)
+    ),
+  })
+  .option("--fix", "Save formatted/corrected output", {
+    validator: program.BOOLEAN,
+    default: false,
+  })
+  .argument("[files...]", "list of files and/or directories to check", {
+    default: [CONTENT_ROOT, CONTENT_TRANSLATED_ROOT].filter(Boolean),
+  })
+  .action(
+    tryOrExit(({ args, options, logger }: FMLintArgsAndOptions) => {
+      const cwd = options.cwd || process.cwd();
+      const files = (args.files || []).map((f) => path.resolve(cwd, f));
+      if (!files.length) {
+        logger.info("No files to lint.");
+        return;
+      }
+      return lintFrontMatter(files, options);
+    })
   );
 
 program.run();