slopless 0.2.0 → 0.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 websmasher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,22 +1,32 @@
 # slopless
 
-Deterministic textlint rules for catching slop in prose.
-
-## Install
+Install:
 
 ```bash
 npm install -D slopless
 ```
 
-## Run
-
-Check Markdown files:
+Run:
 
 ```bash
 npx slopless
 ```
 
-Add an npm script:
+Run on a specific path:
+
+```bash
+npx slopless "docs/**/*.md"
+```
+
+Save JSON:
+
+```bash
+npx slopless "docs/**/*.md" > slopless.json
+```
+
+## Npm Script
+
+Add this to `package.json`:
 
 ```json
 {
@@ -26,37 +36,155 @@ Add an npm script:
 }
 ```
 
-Run it:
+Run:
 
 ```bash
 npm run lint:prose
 ```
 
-Check a specific path:
+## What Slopless Is
 
-```bash
-npx slopless "docs/**/*.md"
-```
+Slopless is a deterministic prose checker for Markdown.
+
+It reports concrete writing patterns that often make generated or careless prose feel padded, vague, generic, or formulaic.
+
+It is built for local scripts, CI checks, review pipelines, and tools that need structured prose findings without calling an LLM.
+
+## What Slopless Is Not
+
+Slopless does not rewrite text.
+
+Slopless does not check facts.
+
+Slopless does not judge taste.
+
+Slopless does not replace editing.
+
+It reports rule findings. A person or another tool decides what to do with them.
+
+## Defaults
+
+- Checks `**/*.md` when no path is passed.
+- Emits JSON only.
+- Requires Node.js 20 or newer.
+- Requires no `.textlintrc.json`.
+- Requires no separate `textlint` install.
+
+## Exit Codes
+
+- `0`: no findings
+- `1`: prose findings were reported
+- `2`: command failure before linting
 
 ## Output
 
-Output is always JSON.
+Output is always textlint JSON.
+
+Each result contains the checked file path and its messages. Each message includes the rule ID, line, column, message text, and range data when textlint can provide it.
+
+Rule IDs use this shape:
+
+```text
+slopless/<rule-name>
+```
+
+Example:
+
+```text
+slopless/semantic-thinness
+slopless/llm-openers
+slopless/hedge-stacking
+```
+
+## CI Use
+
+Run Slopless in CI:
+
+```bash
+npm ci
+npm run lint:prose
+```
+
+Save findings as an artifact:
 
 ```bash
 npx slopless "docs/**/*.md" > slopless.json
 ```
 
+The command exits `1` when findings exist, so CI fails by default on reported prose issues.
+
+## Stdin
+
+Check text from stdin:
+
+```bash
+cat draft.md | npx slopless --stdin --stdin-filename draft.md
+```
+
+`--stdin-filename` should end in `.md` so textlint parses the input as Markdown.
+
+## Supported Options
+
+Slopless forwards normal textlint file and execution options.
+
+Useful examples:
+
+```bash
+npx slopless "docs/**/*.md" --quiet
+npx slopless --stdin --stdin-filename draft.md
+npx slopless --no-color
+```
+
+Unsupported:
+
+```bash
+npx slopless --format stylish
+npx slopless -f json
+```
+
+`--format` and `-f` are rejected because Slopless always emits JSON.
+
 ## What It Checks
 
+Slopless checks for:
+
 - stock AI-style phrasing
 - empty or generic prose patterns
 - rhetorical filler
-- weak closers and lead-ins
+- weak lead-ins and closers
 - hedge stacking
-- prohibited vocabulary
+- prohibited or overused vocabulary
+- cliches and corporate phrasing
+- fake precision signals
 - readability and sentence metrics
 - Markdown style signals
 
-## Requirements
+## Why It Exists
+
+Generated prose often repeats the same rhetorical moves: vague contrast, empty emotional payoff, overconfident summaries, generic transitions, and formulaic conclusions.
+
+General grammar tools are not aimed at those patterns. LLM review can catch them, but it is slower, non-deterministic, and harder to use as a stable CI gate.
+
+Slopless keeps that layer deterministic. It gives projects a repeatable JSON report of known prose issues.
+
+## Advanced Textlint Use
+
+The package also exports a textlint preset for users who already run textlint directly.
+
+`.textlintrc.json`:
+
+```json
+{
+  "rules": {
+    "preset-slopless": true
+  }
+}
+```
+
+Direct textlint use:
+
+```bash
+npx textlint "docs/**/*.md"
+```
 
-- Node.js 20 or newer
+Most users should use `npx slopless` instead.

package/dist/cli.js

@@ -4,11 +4,62 @@ import { fileURLToPath } from "node:url";
 import { cli } from "textlint/lib/src/cli.js";
 const DEFAULT_TARGET = "**/*.md";
 const FORMAT_FLAGS = new Set(["--format", "-f"]);
+const HELP_FLAGS = new Set(["--help", "-h"]);
+const VERSION_FLAGS = new Set(["--version", "-v"]);
+const VERSION = "0.2.2";
+const HELP_TEXT = `Slopless checks Markdown prose for deterministic slop signals and writes JSON.
+
+Install:
+  npm install -D slopless
+
+Run:
+  npx slopless
+  npx slopless "docs/**/*.md"
+  npx slopless draft.md > slopless.json
+
+Package script:
+  {
+    "scripts": {
+      "lint:prose": "slopless"
+    }
+  }
+
+Default behavior:
+  - If no file path is passed, Slopless checks **/*.md.
+  - Output is always JSON.
+  - Exit 0 means no findings.
+  - Exit 1 means Slopless found prose issues.
+  - Exit 2 means the command failed before linting.
+  - No .textlintrc.json is required.
+  - No separate textlint install is required.
+
+What it is for:
+  Slopless is for deterministic prose checks in CI, local scripts, and review
+  pipelines. It catches repeated AI-style phrasing, empty claims, rhetorical
+  filler, weak lead-ins and closers, hedge stacking, readability problems, and
+  Markdown style signals.
+
+What it is not for:
+  Slopless does not rewrite text, check facts, judge taste, or replace human
+  editing. It reports concrete rule findings that another tool or person can
+  review.
+
+Useful forms:
+  npx slopless --stdin --stdin-filename draft.md
+  npx slopless "docs/**/*.md" > slopless.json
+  npx slopless "docs/**/*.md" --quiet
+
+Unsupported:
+  --format and -f are rejected. JSON is the only output format.
+`;
 function hasFormatOverride(args) {
     return args.some((arg, index) => FORMAT_FLAGS.has(arg) ||
         arg.startsWith("--format=") ||
         (index > 0 && FORMAT_FLAGS.has(args[index - 1] ?? "")));
 }
+function hasFlag(args, flags) {
+    return args.some((arg) => flags.has(arg));
+}
 function hasFileTarget(args) {
     return args.some((arg) => !arg.startsWith("-"));
 }
@@ -18,6 +69,14 @@ function packageNodeModules() {
 }
 async function main() {
     const userArgs = process.argv.slice(2);
+    if (hasFlag(userArgs, HELP_FLAGS)) {
+        process.stdout.write(HELP_TEXT);
+        return 0;
+    }
+    if (hasFlag(userArgs, VERSION_FLAGS)) {
+        process.stdout.write(`${VERSION}\n`);
+        return 0;
+    }
     if (hasFormatOverride(userArgs)) {
         process.stderr.write("slopless always writes JSON output. Remove --format / -f.\n");
         return 2;

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,GAAG,EAAE,MAAM,yBAAyB,CAAC;AAE9C,MAAM,cAAc,GAAG,SAAS,CAAC;AACjC,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;AAEjD,SAAS,iBAAiB,CAAC,IAAuB;IAChD,OAAO,IAAI,CAAC,IAAI,CACd,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CACb,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC;QACrB,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC;QAC3B,CAAC,KAAK,GAAG,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CACzD,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,IAAuB;IAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,kBAAkB;IACzB,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAErE,OAAO,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEvC,IAAI,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChC,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,6DAA6D,CAC9D,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,IAAI,GAAG;QACX,MAAM;QACN,UAAU;QACV,UAAU;QACV,UAAU;QACV,wBAAwB;QACxB,kBAAkB,EAAE;QACpB,UAAU;QACV,MAAM;QACN,GAAG,QAAQ;KACZ,CAAC;IAEF,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,GAAG,EAAE,MAAM,yBAAyB,CAAC;AAE9C,MAAM,cAAc,GAAG,SAAS,CAAC;AACjC,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;AACjD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;AAC7C,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;AACnD,MAAM,OAAO,GAAG,OAAO,CAAC;AACxB,MAAM,SAAS,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4CjB,CAAC;AAEF,SAAS,iBAAiB,CAAC,IAAuB;IAChD,OAAO,IAAI,CAAC,IAAI,CACd,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CACb,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC;QACrB,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC;QAC3B,CAAC,KAAK,GAAG,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CACzD,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,IAAuB,EAAE,KAA0B;IAClE,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,aAAa,CAAC,IAAuB;IAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,kBAAkB;IACzB,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAErE,OAAO,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEvC,IAAI,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;QAClC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAChC,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE,CAAC;QACrC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;QACrC,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChC,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,6DAA6D,CAC9D,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,IAAI,GAAG;QACX,MAAM;QACN,UAAU;QACV,UAAU;QACV,UAAU;QACV,wBAAwB;QACxB,kBAAkB,EAAE;QACpB,UAAU;QACV,MAAM;QACN,GAAG,QAAQ;KACZ,CAAC;IAEF,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC"}

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "slopless",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Deterministic textlint rules for detecting slop in prose.",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/agent-quality-controls/slopless.git",
-    "directory": "packages/textlint-rules"
+    "url": "git+https://github.com/agent-quality-controls/Slopless.git"
   },
-  "homepage": "https://github.com/agent-quality-controls/slopless#readme",
+  "homepage": "https://github.com/agent-quality-controls/Slopless#readme",
   "bugs": {
-    "url": "https://github.com/agent-quality-controls/slopless/issues"
+    "url": "https://github.com/agent-quality-controls/Slopless/issues"
   },
   "type": "module",
   "main": "./dist/index.js",