dislop 0.6.0__tar.gz
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.
- dislop-0.6.0/.gitignore +41 -0
- dislop-0.6.0/LICENSE +202 -0
- dislop-0.6.0/PKG-INFO +248 -0
- dislop-0.6.0/README.md +226 -0
- dislop-0.6.0/README.zh-CN.md +222 -0
- dislop-0.6.0/awesome/README.md +184 -0
- dislop-0.6.0/awesome/README.zh-CN.md +184 -0
- dislop-0.6.0/benchmarks/README.md +73 -0
- dislop-0.6.0/benchmarks/README.zh-CN.md +76 -0
- dislop-0.6.0/docs/research/README.md +29 -0
- dislop-0.6.0/models/manifest.json +90 -0
- dislop-0.6.0/models/pocket-slop-v1.json +1 -0
- dislop-0.6.0/packs/business-brief/pack.json +598 -0
- dislop-0.6.0/packs/core/pack.json +192 -0
- dislop-0.6.0/packs/deck-and-ui/pack.json +290 -0
- dislop-0.6.0/packs/engineering-spec/pack.json +144 -0
- dislop-0.6.0/packs/executive-deck/pack.json +98 -0
- dislop-0.6.0/packs/literary-essay/pack.json +324 -0
- dislop-0.6.0/packs/regulated-comms/pack.json +99 -0
- dislop-0.6.0/patterns/README.md +39 -0
- dislop-0.6.0/patterns/banks/composite-fusion.json +36 -0
- dislop-0.6.0/patterns/banks/discourse-rhythm.json +95 -0
- dislop-0.6.0/patterns/banks/lexical-signals.json +74 -0
- dislop-0.6.0/patterns/banks/syntactic-frames.json +45 -0
- dislop-0.6.0/patterns/banks/visual-deck.json +37 -0
- dislop-0.6.0/patterns/dimensions/artifacts.json +121 -0
- dislop-0.6.0/patterns/dimensions/discourse.json +412 -0
- dislop-0.6.0/patterns/dimensions/lexical.json +172 -0
- dislop-0.6.0/patterns/dimensions/rhythm.json +206 -0
- dislop-0.6.0/patterns/dimensions/syntactic.json +285 -0
- dislop-0.6.0/patterns/dimensions/visual-and-deck.json +322 -0
- dislop-0.6.0/patterns/taxonomy.json +112 -0
- dislop-0.6.0/pyproject.toml +58 -0
- dislop-0.6.0/skills/dislop/SKILL.md +60 -0
- dislop-0.6.0/skills/dislop/agents/openai.yaml +6 -0
- dislop-0.6.0/skills/dislop/references/business-and-rfc.md +26 -0
- dislop-0.6.0/skills/dislop/references/editorial-and-essay.md +20 -0
- dislop-0.6.0/skills/dislop/references/regulated-and-precision.md +27 -0
- dislop-0.6.0/skills/dislop/references/web-ui-and-deck.md +26 -0
- dislop-0.6.0/src/dislop/__init__.py +5 -0
- dislop-0.6.0/src/dislop/cli.py +1282 -0
- dislop-0.6.0/src/dislop/engine.py +2463 -0
- dislop-0.6.0/src/dislop/local_model.py +946 -0
- dislop-0.6.0/src/dislop/mcp_server.py +566 -0
- dislop-0.6.0/src/dislop/pattern_engine.py +898 -0
- dislop-0.6.0/src/dislop/pocket_model.py +681 -0
dislop-0.6.0/.gitignore
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Private & local workspace state
|
|
2
|
+
.private/
|
|
3
|
+
.claude/
|
|
4
|
+
.codex/
|
|
5
|
+
.agents/*
|
|
6
|
+
!.agents/plugins/
|
|
7
|
+
!.agents/plugins/marketplace.json
|
|
8
|
+
CLAUDE.local.md
|
|
9
|
+
.dislop.local.json
|
|
10
|
+
.env
|
|
11
|
+
.env.*
|
|
12
|
+
!.env.example
|
|
13
|
+
!**/.env.example
|
|
14
|
+
*.pem
|
|
15
|
+
*.key
|
|
16
|
+
*.p12
|
|
17
|
+
|
|
18
|
+
# Python
|
|
19
|
+
__pycache__/
|
|
20
|
+
*.py[cod]
|
|
21
|
+
*$py.class
|
|
22
|
+
.venv/
|
|
23
|
+
venv/
|
|
24
|
+
dist/
|
|
25
|
+
build/
|
|
26
|
+
*.egg-info/
|
|
27
|
+
.pytest_cache/
|
|
28
|
+
.ruff_cache/
|
|
29
|
+
.mypy_cache/
|
|
30
|
+
|
|
31
|
+
# Node / TypeScript
|
|
32
|
+
node_modules/
|
|
33
|
+
npm-debug.log*
|
|
34
|
+
pnpm-debug.log*
|
|
35
|
+
.tsbuildinfo
|
|
36
|
+
|
|
37
|
+
# OS & Editor
|
|
38
|
+
.DS_Store
|
|
39
|
+
.idea/
|
|
40
|
+
.vscode/*
|
|
41
|
+
!.vscode/extensions.json
|
dislop-0.6.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
dislop-0.6.0/PKG-INFO
ADDED
|
@@ -0,0 +1,248 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: dislop
|
|
3
|
+
Version: 0.6.0
|
|
4
|
+
Summary: Local zero-dependency anti-slop linter for AI-written docs, Word/PowerPoint files, and web pages.
|
|
5
|
+
Project-URL: Homepage, https://dislop.com
|
|
6
|
+
Project-URL: Repository, https://github.com/dislop-ai/dislop
|
|
7
|
+
Project-URL: Issues, https://github.com/dislop-ai/dislop/issues
|
|
8
|
+
Author: dislop contributors
|
|
9
|
+
License-Expression: Apache-2.0
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: agent-skill,ai-slop,anti-slop,de-slop,editorial,linter,mcp,proofreading,quality-gate
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Environment :: Console
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Topic :: Text Processing :: Linguistic
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Provides-Extra: onnx
|
|
20
|
+
Requires-Dist: onnxruntime>=1.18.0; extra == 'onnx'
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
|
|
23
|
+
<p align="center">
|
|
24
|
+
<picture>
|
|
25
|
+
<source media="(prefers-color-scheme: dark)" srcset="./assets/banner-dark.svg">
|
|
26
|
+
<img src="./assets/banner-light.svg" alt="dislop — Catch AI slop before you send it" width="100%">
|
|
27
|
+
</picture>
|
|
28
|
+
</p>
|
|
29
|
+
|
|
30
|
+
<p align="center">
|
|
31
|
+
<a href="./README.zh-CN.md">简体中文</a> ·
|
|
32
|
+
<a href="https://dislop.com/?lang=en">Try it at dislop.com</a> ·
|
|
33
|
+
<a href="./awesome/README.md">Awesome Anti-Slop</a> ·
|
|
34
|
+
<a href="./ROADMAP.md">Roadmap</a> ·
|
|
35
|
+
<a href="https://x.com/dislop_ai">X (@dislop_ai)</a> ·
|
|
36
|
+
<a href="./LICENSE">Apache-2.0</a>
|
|
37
|
+
</p>
|
|
38
|
+
|
|
39
|
+
`dislop` gathers proven anti-slop writing habits, web and slide design rules, an offline zero-dependency checker, and 87 vetted tools in one repository. You and your AI agent can clear AI slop before shipping docs, Word or PowerPoint files, or web pages.
|
|
40
|
+
|
|
41
|
+
Here is a short launch note straight from a model:
|
|
42
|
+
|
|
43
|
+
```text
|
|
44
|
+
Certainly! Here is the launch note. It's worth noting that exports are a game-changer, finishing in up to 12 minutes for workspaces above 500,000 rows.
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
`dislop check launch-note.md` flags three things:
|
|
48
|
+
|
|
49
|
+
```text
|
|
50
|
+
[ERROR] launch-note.md:1:1 chatbot-artifact "Certainly! Here is"
|
|
51
|
+
[WARNING] launch-note.md:1:37 en-throat-clearing-opener "It's worth noting that"
|
|
52
|
+
[INFO] launch-note.md:1:75 en-cliche-lexicon "game-changer"
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
If you rewrite it into a second-order AI slogan (`This isn't just an upgrade — it's a new standard.`), running `dislop check` catches that too. Clean it up into plain prose and `dislop check` exits `0`.
|
|
56
|
+
|
|
57
|
+
That's it. It reads Markdown, plain text, HTML/CSS/JSX, Word (`.docx`), and PowerPoint (`.pptx`). The browser workbench at [dislop.com](https://dislop.com/?lang=en) and the Node.js, Python, and local stdio MCP runtimes all run the same **7 built-in packs (`42` rules)**, 5-axis rhythm telemetry, and offline voice extraction 100% locally with zero uploads; the CLI and local MCP also add extended pattern-bank probes (`--patterns`), the bundled `14.6 KB` Pocket ML ensemble (`--ml`), and hardware-aware optional local model setup (`dislop model`). When you want zero-local-setup connectors or one-click self-healing LLM rewriting, the optional hosted cloud MCP (`https://dislop.com/mcp`) is one click away.
|
|
58
|
+
|
|
59
|
+
## Quick start
|
|
60
|
+
|
|
61
|
+
### Node.js 20+ (zero dependencies, all 7 packs bundled offline)
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
# Check the current folder (exits 1 on core AI artifact errors; prints cliché warnings)
|
|
65
|
+
npx --yes github:dislop-ai/dislop check .
|
|
66
|
+
|
|
67
|
+
# Auto-route domain pack and enable 5-axis telemetry, 14.6 KB Pocket ML, and extended pattern probes
|
|
68
|
+
npx --yes github:dislop-ai/dislop check draft.md --pack auto --profile --ml --patterns
|
|
69
|
+
|
|
70
|
+
# Extract a deterministic personal voice profile offline or inspect hardware for optional local models
|
|
71
|
+
npx --yes github:dislop-ai/dislop voice my-notes.md
|
|
72
|
+
npx --yes github:dislop-ai/dislop model
|
|
73
|
+
|
|
74
|
+
# Check only lines changed against main and emit GitHub PR annotations
|
|
75
|
+
npx --yes github:dislop-ai/dislop check --changed origin/main --format github
|
|
76
|
+
|
|
77
|
+
# Explain a rule's check question and before / overcorrected / after examples
|
|
78
|
+
npx --yes github:dislop-ai/dislop explain negation-pivot-frame
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Python 3.10+ (zero dependencies)
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
# Run directly via uvx
|
|
85
|
+
uvx --from git+https://github.com/dislop-ai/dislop dislop check quarterly-review.pptx
|
|
86
|
+
|
|
87
|
+
# Or from a local checkout
|
|
88
|
+
git clone https://github.com/dislop-ai/dislop.git
|
|
89
|
+
cd dislop
|
|
90
|
+
PYTHONPATH=src python3 -m dislop.cli check . --fail-on warning
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## AI artifacts vs. style warnings
|
|
94
|
+
|
|
95
|
+
Auto-rewriters often trade one AI cliché for another or flatten your voice into a generic template. Flat banned-word lists also cause false alarms on ordinary nouns (`Delve` debugger, `wool tapestry`).
|
|
96
|
+
|
|
97
|
+
`dislop` splits its 42 rules across 7 bundled packs into two layers:
|
|
98
|
+
|
|
99
|
+
1. **AI delivery artifacts (`packs/core/`, `severity: error`, always on)**: Clear leftovers from AI generation—stray chatbot greetings (`Certainly! Here is...`, `[oaicite:1]`), unfilled `[insert ...]` / `{{var}}` / `[TBD]` placeholders, raw Markdown asterisks pasted unrendered into `.docx`/`.pptx`, and dead `<a href="#">` placeholder buttons.
|
|
100
|
+
2. **Built-in scenario & vertical packs (`warning` / `info`, advisory by default, 0 network downloads)**: `business-brief`, `engineering-spec` (PR diff parrots, shallow root causes, unowned action items), `regulated-comms` (unsubstantiated superlatives, unanchored `"10x faster"` multipliers), `literary-essay`, `deck-and-ui`, and `executive-deck` (process-only slide titles, 4+ consecutive identical slide skeletons). Each rule includes a check question, before / overcorrected / after examples, and automated hit/clean tests.
|
|
101
|
+
|
|
102
|
+
## What it reads
|
|
103
|
+
|
|
104
|
+
Both the Node.js CLI (`bin/dislop.mjs`) and the Python CLI (`src/dislop/`) run with zero external runtime dependencies and pass the same conformance suite (`tests/test_conformance.py`).
|
|
105
|
+
|
|
106
|
+
| What you bring | Extensions | What `dislop` catches | Known boundary |
|
|
107
|
+
|---|---|---|---|
|
|
108
|
+
| Drafts & docs | `.md`, `.mdx`, `.txt` | AI artifacts + throat-clearing openers, `"Not X, but Y"` pivots, staccato slogan runs, bureaucratic padding, four-character triads, moralizing endings, unsourced claims, bold-lead bullet walls, em-dash overuse, half-width CJK punctuation | Code blocks, inline code, URLs, blockquotes, and `dislop-quote` blocks are masked for style rules |
|
|
109
|
+
| Web pages & components | `.html`, `.css`, `.jsx`, `.tsx` | Dead `<a href="#">` placeholder links, unexplained `<button disabled>`, purple-pink AI gradients, pill-badge walls, 3-level nested boxes, `AI-Powered` prompt-echo badges | Static per-file inspection; runtime DOM state still needs browser tests |
|
|
110
|
+
| Word | `.docx` | Joined `<w:t>` runs, raw Markdown asterisks pasted from chat, and prose slop rules (`para N`) | Reports paragraph number rather than rendered page number |
|
|
111
|
+
| PowerPoint | `.pptx` | Presentation slide order (`p:sldIdLst`), joined `<a:t>` runs, raw Markdown, slide word-walls (`> 120` words / `> 280` Han chars), bullet caps (`> 6`), `<a:normAutofit>` shrink (`< 80%`), generic titles (`Overview`, `Background`), layout monotony, and prose rules | Hidden slides (`show="0"`) are reported as `[SKIP]` for density checks |
|
|
112
|
+
|
|
113
|
+
## Awesome Anti-Slop
|
|
114
|
+
|
|
115
|
+
Looking for other tools, style guides, design rules, PR policies, and papers in this space? Browse **[awesome/README.md](./awesome/README.md)** ([Chinese edition](./awesome/README.zh-CN.md)) or filter all 87 checked entries offline at **[dislop.com/awesome/](https://dislop.com/awesome/?lang=en)** (machine-readable [index.json](https://dislop.com/awesome/index.json) and [index.md](https://dislop.com/awesome/index.md)).
|
|
116
|
+
|
|
117
|
+
## Use it across agents, editors, and CI
|
|
118
|
+
|
|
119
|
+
| Surface | One-liner or 1-click install | What you get |
|
|
120
|
+
|---|---|---|
|
|
121
|
+
| **Any AI chat** | Paste: `Read https://dislop.com/llms.txt and apply its anti-slop rules and checks before delivering my next draft.` | Zero install; reads the `~2.4 KB` index, task guides (`/tasks/*.md`), or atomic rule cards (`/rules/<id>.md`) |
|
|
122
|
+
| **Agent Skill (75+ hosts)** | `npx skills add dislop-ai/dislop` | Installs [skills/dislop/SKILL.md](./skills/dislop/SKILL.md) + 4 local reference cards in Claude Code, Codex, Cursor, Windsurf, Antigravity, and OpenCode (`0` network calls) |
|
|
123
|
+
| **Claude Code Plugin** | `/plugin marketplace add dislop-ai/dislop` then `/plugin install dislop@dislop-ai` | Bundles Skill + local stdio MCP (`~130` always-on tokens) |
|
|
124
|
+
| **OpenAI Codex Plugin** | `codex plugin marketplace add dislop-ai/dislop` then `codex plugin add dislop@dislop-ai` | Ships native UI card metadata ([openai.yaml](./skills/dislop/agents/openai.yaml)) and `$dislop` trigger |
|
|
125
|
+
| **Gemini CLI Extension** | `gemini extensions install https://github.com/dislop-ai/dislop` | Mounts local `bin/dislop-mcp.mjs` directly via [gemini-extension.json](./gemini-extension.json) |
|
|
126
|
+
| **VS Code / Cursor 1-Click MCP** | [Install in VS Code (Local Offline)](https://vscode.dev/redirect/mcp/install?name=dislop&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22--yes%22%2C%22github%3Adislop-ai%2Fdislop%22%2C%22--mcp%22%5D%7D) · [Install in VS Code (Cloud)](https://vscode.dev/redirect/mcp/install?name=dislop-cloud&config=%7B%22url%22%3A%22https%3A%2F%2Fdislop.com%2Fmcp%22%7D) · [Install in Cursor (Local)](cursor://anysphere.cursor-deeplink/mcp/install?name=dislop&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyItLXllcyIsImdpdGh1YjpkaXNsb3AtYWkvZGlzbG9wIiwiLS1tY3AiXX0=) | Opens the editor's native confirmation dialog without manual JSON edits |
|
|
127
|
+
| **GitHub Action / `pre-commit`** | Reference `uses: dislop-ai/dislop@main` ([action.yml](./action.yml) and [.pre-commit-hooks.yaml](./.pre-commit-hooks.yaml)) | Gates modified lines in PRs with inline annotations or SARIF 2.1.0 |
|
|
128
|
+
|
|
129
|
+
### Manual MCP config (`Claude Code`, `Codex`, `Cursor`, `Windsurf`)
|
|
130
|
+
|
|
131
|
+
```json
|
|
132
|
+
{
|
|
133
|
+
"mcpServers": {
|
|
134
|
+
"dislop": {
|
|
135
|
+
"command": "npx",
|
|
136
|
+
"args": ["--yes", "github:dislop-ai/dislop", "--mcp"]
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Exposed local MCP tools (`7` offline tools, `verbosity: "compact"` by default, with negative fixtures stripped): `dislop_check` (supports `pack` including `"auto"`, `profile`, `ml`, and `patterns`), `dislop_voice_extract_offline`, `dislop_model_score`, `dislop_model_status`, `dislop_explain`, `dislop_packs`, and `dislop_catalog`.
|
|
143
|
+
|
|
144
|
+
## Configure it, or overrule it
|
|
145
|
+
|
|
146
|
+
Run `dislop init` to create `.dislop.json` (put private local bans in Git-ignored `.dislop.local.json`):
|
|
147
|
+
|
|
148
|
+
```json
|
|
149
|
+
{
|
|
150
|
+
"failOn": "error",
|
|
151
|
+
"ignore": ["vendor/**", "dist/**"],
|
|
152
|
+
"overrides": [
|
|
153
|
+
{ "files": ["docs/**/*.md"], "pack": "business-brief" },
|
|
154
|
+
{ "files": ["essays/**/*.md"], "pack": "literary-essay" },
|
|
155
|
+
{ "files": ["site/**/*.{html,css,svg}"], "pack": "deck-and-ui" }
|
|
156
|
+
],
|
|
157
|
+
"allow": ["Delve", "Bayeux Tapestry"],
|
|
158
|
+
"rules": {
|
|
159
|
+
"bold-lead-list-wall": "info"
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
For a narrow one-off exception, add a reason above the line (`--report-unused` flags stale comments):
|
|
165
|
+
|
|
166
|
+
```markdown
|
|
167
|
+
<!-- dislop-ignore-next-line en-cliche-lexicon -- quoting vendor press release verbatim -->
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Install once locally (true air-gapped / fast hooks)
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
# Node.js 20+ (global binary, < 250 KB tarball, zero network after install)
|
|
174
|
+
npm install -g github:dislop-ai/dislop
|
|
175
|
+
dislop check .
|
|
176
|
+
|
|
177
|
+
# Or Python 3.10+ (zero external dependencies)
|
|
178
|
+
git clone https://github.com/dislop-ai/dislop.git
|
|
179
|
+
PYTHONPATH=dislop/src python3 -m dislop.cli check .
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### Open-Source Local (`Skill` + `CLI`) vs. Hosted Cloud (`dislop.com/mcp`)
|
|
183
|
+
|
|
184
|
+
- **Open Source (`dislop-ai/dislop`, Apache-2.0)**: `SKILL.md` + bundled local `./references/*.md`, Node/Python CLI (`dislop check [--pack <id|auto>] [--profile] [--ml] [--patterns] [--changed [ref]] [--staged] [--format text|json|sarif|github|md]`, `dislop patterns`, `dislop voice`, `dislop model [status|score|install|import|remove|deslop]`, `dislop setup`, `dislop deslop --local`, `dislop explain`, `dislop packs`, `dislop catalog`, `dislop resources`), 7-tool local stdio MCP (`--mcp`), all 7 built-in packs (`42` rules) + 53-pattern catalog (`patterns/`), bundled `14.6 KB` gzip (`49.0 KB` raw) Pocket ML ensemble (`models/pocket-slop-v1.json`, `< 0.5 ms`, `100.0%` F1 / `0.0%` Clean FPR on `stealth-vapor-v1`), `Awesome Anti-Slop`, and `dislop-bench v2`. Zero third-party packages, zero API keys, and `0` network calls during `check` / `patterns` / `voice` / `model score` so private drafts never leave your machine. For heavier local neural rewrites, `dislop setup` and `dislop model install` inspect RAM/disk budgets and let you optionally install `0.6B` (`~520 MB`), `1.7B` (`~1.3 GB`), or `4B` (`~2.5 GB`) local models (or import offline `.gguf`/`.onnx` weights with SHA-256 verification) protected by an internal numeric and qualifier retention guard during automated local rewrites.
|
|
185
|
+
- **Hosted Cloud Remote MCP & Web AI (`https://dislop.com/mcp`, `https://dislop.com/?lang=en#pricing`)**: Optional closed-source cloud backend powered by a paid-tier zero-training Google Gemini endpoint (no draft logging; see [privacy.md](https://dislop.com/privacy.md)). Exposes `dislop_review` (1 credit, hybrid 3rd-order review), `dislop_deslop` (2 credits, self-healing rewrite with an internal numeric and qualifier retention guard and automatic repair), and `dislop_voice_extract` (2 credits, `dislop.voice/1`). Includes 5 free anonymous web demo credits/day, **30 free monthly credits** after email key signup, and early-access waitlists for Pro (`$12/mo`, 1,500 credits), PAYGO (`$10 / 800 credits`), and Team (`$29/seat/mo`).
|
|
186
|
+
|
|
187
|
+
## Anti-slop benchmark (`dislop-bench v2`)
|
|
188
|
+
|
|
189
|
+
Run the full offline benchmark (`112` cross-modality detection samples across Node & Python + `18` end-to-end writing and design tasks comparing raw AI, naive humanizers, and `dislop`-guided revisions):
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
node scripts/run_benchmark.mjs --assert
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
Latest measured baseline ([benchmarks/REPORT.md](./benchmarks/REPORT.md) and [benchmarks/PATTERN-BENCHMARK.md](./benchmarks/PATTERN-BENCHMARK.md)):
|
|
196
|
+
|
|
197
|
+
- **Core Detection (`Suite A`, 112 samples = 48 v1 + 16 `holdout-v1` + 48 `text-hard-v2`)**: Precision `100.0%` · Recall `100.0%` · Clean FPR `0.0%` · Adversarial Near-Miss FPR `0.0%` · 2nd-Order Trap Recall `100.0%` · Node/Python Rule & Statistical Profile Parity `100.0%`.
|
|
198
|
+
- **Multi-Angle Pattern Benchmark (`154` samples = 48 + 16 + 62 `pattern-challenge-v2` + 28 `holdout-v2`)**: Precision `100.0%` · Recall `100.0%` · F1 `100.0%` · Clean FPR `0.0%` · Node/Python Parity `100.0%`.
|
|
199
|
+
- **Bundled Pocket ML (`stealth-vapor-v1`, 24 paired samples; 36 blind eval with holdouts)**: `14.6 KB` gzip (`49.0 KB` raw), `< 0.5 ms`, `100.0%` F1, `0.0%` Clean FPR.
|
|
200
|
+
- **End-to-End Revision (`Suite B`, 18 tasks = 12 `revision-v1` + 6 `revision-hard-v2`, weights `D1=45 / D2=20 / D3=25 / D4=10`)**: `raw_ai` **60.8 / 100** → `naive_humanizer` **70.8 / 100** (doubles 3rd-order slop and drops or invents numbers) → `dislop_clean` **100.0 / 100** (`18/18` all-clear).
|
|
201
|
+
- **Live 5-model comparison ([benchmarks/MODEL-COMPARISON.md](./benchmarks/MODEL-COMPARISON.md))**: Across `Gemini 3.1/3.5 Flash-Lite`, `Gemini 3.5/3.8 Flash`, and `Qwen 3.8 Flash`, bare prompts averaged `76.0–84.2 / 100` (`2/10–4/10` all-clear on the 10-task `revision-v1` live subset), while the `dislop` self-healing cloud pipeline lifted every model by **+15.8 to +22.3 points** (`97.0–100.0 / 100`, `8/10–10/10` all-clear; `Gemini 3.1 Flash-Lite` reached `98.5 / 100` in `1.2s` at `~$0.09 / 1k calls`).
|
|
202
|
+
|
|
203
|
+
See [benchmarks/README.md](./benchmarks/README.md) to score your own model, Skill, or cloud endpoint (`--eval`) or export randomized blind human A/B review sheets (`--export-blind-sheet`).
|
|
204
|
+
|
|
205
|
+
## dislop checks dislop
|
|
206
|
+
|
|
207
|
+
GitHub Actions CI runs `dislop pack-test` (160 fixture assertions: 83 hit + 77 clean in both Node and Python), 26 Python `unittest` conformance and engine tests across 4 modules (`test_conformance`, `test_engine`, `test_pattern_library`, `test_pocket_and_local_models`), pattern catalog checks (`node scripts/pattern_lab.mjs verify` and `assert`), and site checks (`tests/test_site.mjs`). It also runs `dislop check . --fail-on warning` across this repository's docs, `awesome/`, and `site/`.
|
|
208
|
+
|
|
209
|
+
## Docs & layout
|
|
210
|
+
|
|
211
|
+
- [Brand & Voice Guide](./docs/brand-and-voice-guide.md) ([zh-CN](./docs/brand-and-voice-guide.zh-CN.md))
|
|
212
|
+
- [Architecture](./docs/architecture.md) ([zh-CN](./docs/architecture.zh-CN.md)) · [Design System](./docs/design-system.md) ([zh-CN](./docs/design-system.zh-CN.md))
|
|
213
|
+
- [Roadmap](./ROADMAP.md) ([zh-CN](./ROADMAP.zh-CN.md)) · [Releasing](./docs/releasing.md) · [Contributing](./CONTRIBUTING.md) · [Research Index](./docs/research/README.md) · [Changelog](./CHANGELOG.md)
|
|
214
|
+
|
|
215
|
+
```text
|
|
216
|
+
dislop/
|
|
217
|
+
├── .agents/plugins/ # OpenAI Codex marketplace manifest (marketplace.json)
|
|
218
|
+
├── .claude-plugin/ # Claude Code plugin & marketplace manifests (Skill + local MCP)
|
|
219
|
+
├── .codex-plugin/ # OpenAI Codex native plugin manifest & UI card metadata
|
|
220
|
+
├── plugin.json # Agent Plugins 1.0 portable manifest (paired with root mcp.json)
|
|
221
|
+
├── gemini-extension.json # Gemini CLI Extension Gallery manifest
|
|
222
|
+
├── server.json # Official MCP Registry manifest (local stdio + remote HTTP)
|
|
223
|
+
├── action.yml # Reusable GitHub Marketplace incremental check Action
|
|
224
|
+
├── awesome/ # Awesome Anti-Slop (README.md & README.zh-CN.md, 87 entries)
|
|
225
|
+
├── benchmarks/ # Offline anti-slop benchmark datasets (CC0-1.0) & reproducible reports
|
|
226
|
+
├── bin/ # Node.js CLI (dislop.mjs) & local stdio MCP launcher (dislop-mcp.mjs)
|
|
227
|
+
├── src/
|
|
228
|
+
│ ├── core.mjs # Zero-dep ES module shared by Node CLI, MCP, and browser workbench
|
|
229
|
+
│ ├── pattern-engine.mjs # Multi-angle 11-probe extended pattern-bank scanner
|
|
230
|
+
│ ├── pocket-model.mjs# Bundled 14.6 KB gzip zero-dep Pocket ML ensemble & domain pack router
|
|
231
|
+
│ ├── local-model.mjs# Hardware-aware optional local small-model advisor (Node.js)
|
|
232
|
+
│ ├── binary-node.mjs# Zero-dep ZIP reader for Node.js (.docx / .pptx)
|
|
233
|
+
│ └── dislop/ # Zero-dep Python 3.10+ engine, pattern scanner, local-model advisor, CLI, and MCP
|
|
234
|
+
├── packs/ # Declarative dislop.pack/2 manifests (7 built-in packs, 42 rules, 160 fixtures)
|
|
235
|
+
├── patterns/ # Structured 53-pattern anti-slop catalog across 6 dimensions & 7 angles
|
|
236
|
+
├── skills/dislop/ # Cross-host Agent Skill (SKILL.md + local ./references/ + openai.yaml)
|
|
237
|
+
├── tests/ # 26 Python unittest suites, Node/Python conformance, and site tests
|
|
238
|
+
├── scripts/ # Manifest lockstep sync (sync_manifests.mjs), site compiler & benchmarks
|
|
239
|
+
├── site/ # Compiled dislop.com workbench, /awesome/, and /llms.txt pages
|
|
240
|
+
├── assets/ # Logo mark, light/dark banners, and 1200x630 social preview card
|
|
241
|
+
└── docs/ # Brand guide, architecture, design system, roadmap, and research
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
## License
|
|
245
|
+
|
|
246
|
+
[Apache License 2.0](./LICENSE)
|
|
247
|
+
|
|
248
|
+
<!-- mcp-name: io.github.dislop-ai/dislop -->
|