slopless 0.2.21 → 0.2.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -2
  2. package/package.json +2 -10
package/README.md CHANGED
@@ -9,7 +9,7 @@
9
9
  [![ci](https://img.shields.io/github/actions/workflow/status/seochecks-ai%2Fslopless/ci.yml?branch=main&label=ci)](/actions/workflows/ci.yml)
10
10
  [![socket](https://socket.dev/api/badge/npm/package/slopless)](https://socket.dev/npm/package/slopless)
11
11
 
12
- Catch AI and human slop in English Markdown without calling an LLM. Slopless ships 50+ deterministic textlint rules and a CLI that emits structured JSON findings.
12
+ Give it to your writing agent and it stops handing you AI-slop prose. Slopless is a deterministic linter - a textlint preset and a zero-config CLI - that flags the LLM tells (hollow framing, fake contrasts, hedging, em-dash tics, vacuous closers, and many more) so the agent rewrites until the text reads human. No model calls, no API key.
13
13
 
14
14
  ## What it catches
15
15
 
@@ -59,9 +59,12 @@ Loop:
59
59
  5. Let the agent run Slopless, rewrite, and rerun until the JSON output has no findings.
60
60
  6. Profit.
61
61
 
62
- ## Direct CLI Use
62
+ ## Set up the CLI
63
+
64
+ The CLI bundles textlint, so it needs no separate textlint install and no `.textlintrc`. This is the recommended path for writing agents and one-off checks.
63
65
 
64
66
  ```bash
67
+ npm install -D slopless
65
68
  npx slopless "docs/**/*.md"
66
69
  ```
67
70
 
@@ -76,6 +79,30 @@ mkdir -p .slopless/findings
76
79
  npx slopless "docs/**/*.md" > ".slopless/findings/$(date +%Y-%m-%d-%H%M%S)--review.json"
77
80
  ```
78
81
 
82
+ ## Set up the textlint preset
83
+
84
+ If you already run [textlint](https://textlint.github.io/), add slopless as a preset instead. It runs through your existing textlint, alongside your other rules and `.textlintrc`, and supports textlint's output formatters (the CLI is always JSON).
85
+
86
+ ```bash
87
+ npm install -D slopless textlint
88
+ ```
89
+
90
+ Add `preset-slopless` to your `.textlintrc.json`:
91
+
92
+ ```json
93
+ {
94
+ "rules": {
95
+ "preset-slopless": true
96
+ }
97
+ }
98
+ ```
99
+
100
+ ```bash
101
+ npx textlint "docs/**/*.md"
102
+ ```
103
+
104
+ Findings use the same `slopless/<rule>` ids as the CLI. Turn off individual rules with `"preset-slopless": { "cliches": false }`. To honor the `<!-- textlint-disable -->` blocks below, also `npm install -D textlint-filter-rule-comments` and add `"filters": { "comments": true }` to the config.
105
+
79
106
  ## Agent Use
80
107
 
81
108
  Agents should run help first:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "slopless",
3
- "version": "0.2.21",
3
+ "version": "0.2.22",
4
4
  "description": "Deterministic textlint rules and CLI for catching prose slop in English Markdown.",
5
5
  "keywords": [
6
6
  "textlint",
@@ -124,7 +124,6 @@
124
124
  "textlint-util-to-string": "3.3.4"
125
125
  },
126
126
  "devDependencies": {
127
- "@double-great/stylelint-a11y": "3.4.13",
128
127
  "@eslint-community/eslint-plugin-eslint-comments": "4.7.1",
129
128
  "@types/node": "22.19.19",
130
129
  "@typescript-eslint/eslint-plugin": "8.59.4",
@@ -132,15 +131,9 @@
132
131
  "cspell": "10.0.0",
133
132
  "eslint": "10.4.0",
134
133
  "eslint-plugin-import-x": "4.16.2",
135
- "eslint-plugin-regexp": "3.1.0",
136
134
  "eslint-plugin-sonarjs": "4.0.3",
137
135
  "eslint-plugin-unicorn": "64.0.0",
138
- "g3ts-eslint-plugin-style-policy": "0.1.3",
139
- "jscpd": "4.2.3",
140
136
  "prettier": "3.8.3",
141
- "stylelint": "17.12.0",
142
- "stylelint-config-standard": "40.0.0",
143
- "stylelint-config-tailwindcss": "1.0.1",
144
137
  "syncpack": "15.3.1",
145
138
  "type-coverage": "2.29.7",
146
139
  "typescript": "6.0.3"
@@ -150,9 +143,8 @@
150
143
  "format": "prettier --write .",
151
144
  "format:check": "prettier --check .",
152
145
  "lint": "eslint --max-warnings 0 .",
153
- "lint:css": "stylelint --max-warnings 0 \"styles/**/*.css\"",
154
146
  "spellcheck": "cspell .",
155
147
  "typecov": "type-coverage --strict --at-least 100",
156
- "validate": "pnpm run build && node scripts/verify-cli-version.mjs && pnpm run lint && pnpm run lint:css && prettier --check . && cspell . && type-coverage --strict --at-least 100"
148
+ "validate": "pnpm run build && node scripts/verify-cli-version.mjs && pnpm run lint && prettier --check . && cspell . && type-coverage --strict --at-least 100"
157
149
  }
158
150
  }