nollm 0.4.0 → 0.6.0

package/README.md

@@ -52,14 +52,16 @@ through a row of `..`.
 Ignore patterns from the config describe the project, so they apply under the
 current directory and leave paths outside it alone.
 
-| Option            | Effect                                                             |
-| ----------------- | ------------------------------------------------------------------ |
-| `--jobs <n>`      | Number of worker threads. Defaults to the CPU count.               |
-| `--config <path>` | Config file to use.                                                |
-| `--diff <ref>`    | Check only the lines this branch adds or changes since `<ref>`.    |
-| `--no-git`        | Do not ask git for the file list. Read `.gitignore` files instead. |
-| `--quiet`         | Print only the summary.                                            |
-| `--list-rules`    | Print every rule and exit.                                         |
+| Option                    | Effect                                                             |
+| ------------------------- | ------------------------------------------------------------------ |
+| `--jobs <n>`              | Number of worker threads. Defaults to the CPU count.               |
+| `--config <path>`         | Config file to use.                                                |
+| `--diff <ref>`            | Check only the lines this branch adds or changes since `<ref>`.    |
+| `--no-git`                | Do not ask git for the file list. Read `.gitignore` files instead. |
+| `--stdin`                 | Read the text from stdin. The path `-` does the same.              |
+| `--stdin-filename <name>` | Check stdin as if it were this file. Defaults to `stdin.md`.       |
+| `--quiet`                 | Print only the summary.                                            |
+| `--list-rules`            | Print every rule and exit.                                         |
 
 The exit code is 1 when there are findings, and 2 on a usage error.
 
@@ -80,6 +82,24 @@ src/index.js
 4 problems in 2 files (5 files checked, 0.07s)
 ```
 
+## Checking text from stdin
+
+Pass `-` to check text that is not in a file, such as a draft or a commit message:
+
+```
+pbpaste | nollm -
+git log -1 --format=%B | nollm -
+```
+
+Stdin is checked as markdown. To check it as another type, name a file.
+The name picks the language and labels the report. No file is read:
+
+```
+git show main:src/index.js | nollm --stdin-filename src/index.js
+```
+
+The config applies as usual. Stdin cannot be combined with paths or `--diff`.
+
 ## Checking only a pull request
 
 A large codebase written before you added `nollm` has findings everywhere.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nollm",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "lint against LLMisms in your codebase",
   "keywords": [
     "comments",

package/src/cli.js

@@ -1,18 +1,29 @@
 import { createRequire } from "node:module";
+import { resolve } from "node:path";
+import { text as readAll } from "node:stream/consumers";
 import { parseArgs, styleText } from "node:util";
+import { check } from "./check.js";
+import { findConfig, loadConfig } from "./config.js";
+import { classify } from "./languages.js";
 import { lint } from "./lint.js";
 import { rules } from "./rules.js";
 
+const STDIN_FILENAME = "stdin.md";
+
 const HELP = `Usage: nollm [options] [paths...]
 
 Checks files for LLMisms and prints each finding as soon as it is found.
 Paths may be relative or absolute. Files that git ignores are skipped.
+The path - reads the text from stdin instead.
 
 Options:
   --jobs, -j <n>     Number of worker threads (default: cpu count)
   --config <path>    Config file (default: nollm.config.js in the current directory)
   --diff <ref>       Check only the lines this branch adds or changes since <ref>
   --no-git           Do not ask git for the file list. Read .gitignore files instead
+  --stdin            Read the text from stdin. Same as the path -
+  --stdin-filename <name>
+                     Check stdin as if it were this file (default: ${STDIN_FILENAME})
   --quiet, -q        Print only the summary
   --list-rules       Print every rule and exit
   --version, -v      Print the version and exit
@@ -21,13 +32,20 @@ Options:
 Examples:
   nollm docs/guide.md            a path relative to the current directory
   nollm /srv/site/docs/guide.md  an absolute path
+  pbpaste | nollm -              text from the clipboard, as markdown
+  git show HEAD:a.py | nollm --stdin-filename a.py
 
 Exit code 1 when there are findings. Exit code 2 on a usage error.
 `;
 
 export async function main(
   argv,
-  { stdout = process.stdout, stderr = process.stderr, cwd = process.cwd() } = {},
+  {
+    stdin = process.stdin,
+    stdout = process.stdout,
+    stderr = process.stderr,
+    cwd = process.cwd(),
+  } = {},
 ) {
   let parsed;
   try {
@@ -40,6 +58,8 @@ export async function main(
         config: { type: "string" },
         diff: { type: "string" },
         git: { type: "boolean", default: true },
+        stdin: { type: "boolean", default: false },
+        "stdin-filename": { type: "string" },
         quiet: { type: "boolean", short: "q", default: false },
         "list-rules": { type: "boolean", default: false },
         version: { type: "boolean", short: "v", default: false },
@@ -83,21 +103,44 @@ export async function main(
 
   const paint = (style, text) => styleText(style, text, { stream: stdout });
   const started = performance.now();
+  const fromStdin =
+    values.stdin || values["stdin-filename"] !== undefined || positionals.includes("-");
+
+  if (fromStdin) {
+    if (positionals.some((path) => path !== "-")) {
+      stderr.write("Paths cannot be combined with stdin. Check one or the other\n");
+      return 2;
+    }
+    if (values.diff !== undefined) {
+      stderr.write("--diff cannot be combined with stdin, since stdin has no git history\n");
+      return 2;
+    }
+  }
+
+  const onResult = (result) => {
+    if (values.quiet || result.findings.length === 0) return;
+    stdout.write(formatFile(result.file, result.findings, paint));
+  };
 
   let summary;
   try {
-    summary = await lint({
-      roots: positionals.length > 0 ? positionals : ["."],
-      cwd,
-      configPath: values.config,
-      git: values.git,
-      diff: values.diff,
-      jobs,
-      onResult(result) {
-        if (values.quiet || result.findings.length === 0) return;
-        stdout.write(formatFile(result.file, result.findings, paint));
-      },
-    });
+    summary = fromStdin
+      ? await lintStdin({
+          stdin,
+          file: values["stdin-filename"] ?? STDIN_FILENAME,
+          cwd,
+          configPath: values.config,
+          onResult,
+        })
+      : await lint({
+          roots: positionals.length > 0 ? positionals : ["."],
+          cwd,
+          configPath: values.config,
+          git: values.git,
+          diff: values.diff,
+          jobs,
+          onResult,
+        });
   } catch (error) {
     stderr.write(`${error.message}\n`);
     return 2;
@@ -112,6 +155,30 @@ export async function main(
   return summary.findings > 0 ? 1 : 0;
 }
 
+/**
+ * Checks the text on stdin as if it were the named file.
+ *
+ * The name picks the language and labels the report. No file is read.
+ * Returns the same summary as lint, for one file.
+ */
+async function lintStdin({ stdin, file, cwd, configPath, onResult }) {
+  if (!classify(file)) {
+    throw new Error(`nollm does not know how to check "${file}". Pass --stdin-filename a.md`);
+  }
+
+  const resolvedConfig = configPath ? resolve(cwd, configPath) : await findConfig(cwd);
+  const config = await loadConfig(resolvedConfig);
+  const findings = check(file, await readAll(stdin), config.rules);
+
+  onResult({ file, findings, skipped: null });
+  return {
+    files: 1,
+    checked: 1,
+    findings: findings.length,
+    filesWithFindings: findings.length > 0 ? 1 : 0,
+  };
+}
+
 /**
  * One block per file:
  *

package/src/rules.js

@@ -270,6 +270,16 @@ const PR_TALK = [
   "existing behavior",
   "existing behaviour",
   "unchanged from",
+  // Explaining a step that is not there
+  "nothing to disable",
+  "nothing to turn off",
+  "nothing to uninstall",
+  "nothing to revert",
+  "nothing to opt out of",
+  "no need to disable",
+  "no need to turn off",
+  "no need to uninstall",
+  "no need to revert",
   // Leaving things as they were
   "keeping it off",
   "keeping it on",