slopless  by seochecks-ai

Deterministic prose quality checker for Markdown

Created 1 week ago

New!

350 stars

Top 79.4% on SourcePulse

GitHubView on GitHub
Project Summary

Summary Slopless offers a deterministic approach to identifying and rectifying "prose slop" within English Markdown content. It provides over 50 textlint rules and a command-line interface (CLI) that outputs structured JSON findings, enabling automated quality control without relying on Large Language Models (LLMs). This tool is beneficial for developers and AI writing agents aiming for consistent, reproducible prose improvements.

How It Works The project employs a curated set of over 50 deterministic textlint rules, organized into seven distinct families, to analyze Markdown files. Its CLI tool accepts file paths or standard input, generating findings in a structured JSON format. This deterministic nature ensures consistent results, a key advantage for automated workflows. Slopless can be integrated as a "skill" for AI agents (e.g., Codex, Claude), facilitating iterative writing and revision cycles where agents continuously refine content until all Slopless checks pass.

Quick Start & Requirements

  • Installation: npm install -D slopless
  • Prerequisites: Node.js and npm.
  • Agent Integration: Install agent skills using npx slopless install-skill codex or npx slopless install-skill claude.
  • Direct CLI Use: Execute checks with npx slopless "docs/**/*.md".
  • Exit Codes: 0 indicates clean output; 1 signifies findings; 2 denotes failure.
  • Output: Findings are always emitted as JSON to standard output.
  • Rule Ignoring: Supports standard textlint inline comments (e.g., <!-- textlint-disable -->).

Highlighted Details

  • Comprises 50+ deterministic rules for prose quality analysis.
  • Generates structured JSON output, facilitating programmatic integration.
  • Designed for seamless integration with AI writing agents for automated content refinement loops.
  • Allows for inline rule disabling via textlint comment syntax.

Maintenance & Community The project is identified as part of "Agent Quality Controls." Contributing requires opening an issue first, and pull requests must pass a G3TS pre-commit gate. The provided text does not mention specific community channels (like Discord or Slack) or notable contributors and sponsorships.

Licensing & Compatibility The license type is not explicitly stated in the provided README excerpt. This omission necessitates further investigation before considering commercial use or integration into closed-source projects.

Limitations & Caveats

  • Slopless is exclusively designed for English language content.
  • The absence of a clearly defined license is a significant barrier to adoption and requires clarification.
  • Contribution workflows mandate adherence to a specific pre-commit gate.
Health Check
Last Commit

2 days ago

Responsiveness

Inactive

Pull Requests (30d)
18
Issues (30d)
23
Star History
351 stars in the last 7 days

Explore Similar Projects

Feedback? Help us improve.