simple_english 0.6.0-aarch64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5122afb44d3c0332b53c7636a893150d5d27bf2a80d49cae239d44e57c250ea2
+  data.tar.gz: c4e8fcf8f0c5a0dd9ebd31ab5f4e8c1f93d7bd37118015da48d0c21ba2d82656
+SHA512:
+  metadata.gz: 694c1b6d1af013b704a8ece195f9e55f0189b1220b01fd259aa04fc255ff4f82df3c264dc75d3bdde65e2a53c67529876f25d370d8397e6d1febec36f8cf4b8c
+  data.tar.gz: d72828c6a2d99e17a5d0a7f3d5e0fb5e20a06a47ac7baa7375de393986753c9bd7471cada8bc8a748d818bc21e35f6e4cf4f8ed47b8460896bd4d469baab489b

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 tony.hsu
+
+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.

data/README.md

@@ -0,0 +1,212 @@
+[![CI](https://github.com/TonyCTHsu/simple-english/actions/workflows/ci.yml/badge.svg)](https://github.com/TonyCTHsu/simple-english/actions/workflows/ci.yml) <!-- se: ignore=SE_PARAGRAPH_TOO_LONG -->
+[![Gem Version](https://badge.fury.io/rb/simple_english.svg)](https://badge.fury.io/rb/simple_english)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/TonyCTHsu/simple-english/blob/master/LICENSE)
+
+# simple_english
+
+> Write for human, not for agent.
+
+You can teach an agent plain-English prose with a skill or a
+prompt. It writes clean prose in the first paragraph and slop again
+by the third. This linter keeps the agent honest: it reads what the
+agent wrote and names every broken rule. Send the findings back, and
+the agent corrects its own text.
+
+<table>
+<tr>
+<th width="50%">Before</th>
+<th width="50%">After</th>
+</tr>
+<tr>
+<td valign="top">
+
+> Your API keys are rotated by the service every 90 days — you will need to update them if you get a 401; don't panic, simply re-run the setup command, which regenerates the credentials without any downtime. <!-- se: ignore -->
+
+</td>
+<td valign="top">
+
+> The service rotates your API keys every 90 days. If you get a 401, update them. Do not panic. Re-run the setup command. It regenerates the credentials without any downtime.
+
+</td>
+</tr>
+</table>
+
+The linter covers Markdown prose plus code comments in Python, Ruby,
+JavaScript, TypeScript, Go, Rust, Java, C#, C++, Kotlin, bash, and
+YAML. Findings print as plain text, JSON, or SARIF.
+
+If your language is not on the list, [open an issue](https://github.com/TonyCTHsu/simple-english/issues).
+
+## Agent integrations
+
+Plug the linter into your coding agent. It checks its own draft
+before you read the file.
+
+| Coding agent | Integration |
+|---|---|
+| pi | [pi-simple-english](integrations/pi/README.md) |
+| Claude Code | [simple-english](integrations/claude-code/README.md) |
+| Codex | [simple-english](integrations/codex/README.md) |
+
+If your agent is not on the list, [open an issue](https://github.com/TonyCTHsu/simple-english/issues).
+
+## The rules
+
+- **Voice:** say who does the action.
+- **Tense:** simple tenses only, no present perfect.
+- **Modals:** `can`, `will`, `must` only.
+- **Punctuation:** no em-dashes, no semicolons.
+- **Contractions:** write every word in full.
+- **Sentence shape:** condition before command, no `-ing` phrase after a comma.
+- **Word choice:** about 50 substitution rules, from `leverage` to `in conclusion`. `make sure that` keeps its "that".
+- **Code comments:** same pattern rules, with line and column range.
+- **Counts (Markdown only):** 20 words per sentence in list items, 25 in paragraphs, six sentences per paragraph at most.
+
+The full list, with a wrong and a right example for each rule [docs/RULES.md](docs/RULES.md).
+
+## Install
+
+### Homebrew (macOS arm64)
+
+```bash
+brew install TonyCTHsu/tap/simple-english
+```
+
+### Ruby gem (macOS arm64, Linux x86-64 and arm64)
+
+```bash
+gem install simple_english
+```
+
+### Container
+
+```bash
+docker run --rm -v "$PWD":/work ghcr.io/tonycthsu/simple-english .
+```
+
+## Usage
+
+Lint files, directories, or stdin:
+
+```bash
+se README.md
+se docs/            # every .md, .py, .rb, .yaml, .yml, ... under docs/
+se - < notes.md     # stdin (Markdown)
+```
+
+Lint only what changed:
+
+```bash
+git diff --name-only --diff-filter=ACM main | xargs -I{} se {}
+```
+
+### Outputs
+
+Pattern findings print an exclusive column range as
+`file:line:start-end: [RULE_ID] message`. A range that crosses lines ends
+with `end-line:end-column`. Columns count UTF-16 code units. Counting findings
+identify only the paragraph's first line. JSON and SARIF output expose the same
+source ranges:
+
+```bash
+se --format json docs/
+se --format sarif src/ > results.sarif
+```
+
+### Exit codes
+
+- `0`: no findings
+- `1`: findings
+- `2`: input, configuration, installation, or daemon error
+
+### MCP server
+
+Start an MCP stdio server with one tool, `lint`. Any MCP
+client can call it.
+
+```
+se mcp
+```
+
+### CI
+
+Gate the prose in the pull request that changes it. The plain run
+fails the build on findings, and the SARIF report puts them inline:
+
+```yaml
+name: lint-docs
+on: [pull_request]
+permissions:
+  security-events: write
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: ruby/setup-ruby@v1
+      - run: gem install simple_english
+      - run: se --format sarif . > lint.sarif
+      - run: se .
+      - uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: lint.sarif
+        if: always()
+```
+
+## Config and suppressions
+
+### Config file
+
+`.simple-english.yml` in the working directory:
+
+```yaml
+ignore:
+  - vendor/**
+disabled-rules:
+  - SE_NO_EMDASH
+```
+
+`ignore` globs: `**` crosses directories, `*` stays in one segment.
+
+### Inline suppressions
+
+A line containing `se: ignore` suppresses findings reported on that
+line. Use `se: ignore=RULE1,RULE2` to scope it to rules. Pattern
+findings cite the line of the match, so put the directive on the line the
+finding reports.
+
+In Markdown:
+
+```markdown
+The daemon keeps it's own lock. <!-- se: ignore=SE_NO_CONTRACTIONS -->
+```
+
+In a code comment:
+
+```ruby
+# Don't touch this constant. se: ignore=SE_NO_CONTRACTIONS
+```
+
+## FAQ
+
+### Have you thought about an agent skill?
+
+This project takes its idea from [SimpleEnglish](https://github.com/AminBlg/SimpleEnglish). If you like, use both: the skill helps the first draft, and the linter catches what the agent missed.
+
+### Why not Vale?
+
+We ported rules to Vale and ran the corpus on both engines.
+About 60 rules behave the same. Vale has no check for the em-dash
+and semicolon rules: its checks see words, not punctuation. Its
+tagger also mislabels verbs, so the condition-first rule stays
+silent. Closing the Vale gaps needs scripts or an external
+tagger, and that erases Vale's main advantage: one binary with no
+service behind it.
+
+## Scope
+
+This tool does not check ASD-STE100 compliance. This repo holds no ASD-STE100 text. If you need full compliance, read the free standard at <https://www.asd-ste100.org/>.
+
+## Develop
+
+To change the linter, add rules, or run the tests, read [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md).

data/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,72 @@
+# Third-party notices
+
+Files under `licenses/` carry the license texts and upstream notices
+for third-party software distributed inside this gem. Simple English's
+own code is MIT-licensed; see `LICENSE`.
+
+## Lint engine
+
+Each platform gem ships a compiled lint engine at
+`libexec/simple_english/languagetool-server`. The binary is built with
+GraalVM Community Edition 25.0.2 and contains code from the
+components below. The authoritative list of components inside a given
+binary is the CycloneDX SBOM published with each release
+(`dist/languagetool-server-<platform>.sbom.json`).
+
+| Component | License | Notice |
+|---|---|---|
+| LanguageTool 6.6 (`languagetool-core`, `languagetool-server`, `languagetool-gui-commons`, `language-en`, `language-ca`, `language-es`, `language-pt`), unmodified except for a build-time copy of `rules/simple-english.xml` into the English rules | LGPL-2.1 | `licenses/LGPL-2.1.txt` |
+| English word-list and POS data (12dicts, AGID, Moby/WordNet POS) | upstream terms, public domain | `licenses/languagetool-resource-en/` |
+| `at.favre.lib:bcrypt` 0.10.2 | Apache-2.0 | |
+| `ch.qos.logback:logback-classic` 1.5.18 | EPL-1.0 or LGPL-2.1 | |
+| `co.elastic.logging:logback-ecs-encoder` 1.3.2 | Apache-2.0 | |
+| `com.fasterxml.jackson.core:jackson-databind` 2.18.0 | Apache-2.0 | |
+| `commons-cli:commons-cli` 1.9.0 | Apache-2.0 | |
+| `commons-codec:commons-codec` 1.17.1 | Apache-2.0 | |
+| `edu.washington.cs.knowitall:opennlp-*` models 1.5 | Apache-2.0 | |
+| `io.lettuce:lettuce-core` 6.5.4 | MIT | |
+| `io.prometheus:simpleclient_*` 0.16.0 | Apache-2.0 | |
+| `org.apache.opennlp:opennlp-tools` 1.9.4 | Apache-2.0 | |
+| `org.mariadb.jdbc:mariadb-java-client` 3.4.1 | LGPL-2.1 | `licenses/LGPL-2.1.txt` |
+| `org.mybatis:mybatis` 3.5.16 | Apache-2.0 | |
+| `org.slf4j:slf4j-api` 2.0.16 | MIT | |
+| GraalVM and OpenJDK runtime code | GPLv2 with the Classpath Exception | `licenses/OpenJDK-LICENSE.txt` |
+
+The engine uses logback under its LGPL-2.1 option, not its EPL-1.0
+option.
+
+## LGPL 2.1 obligations
+
+LanguageTool is licensed under the GNU Lesser General Public License
+2.1. This gem distributes a binary statically linked with
+LanguageTool, which LGPL 2.1 section 6 permits when recipients can
+study, modify, and rebuild the LGPL part:
+
+- The license text ships with every gem (`licenses/LGPL-2.1.txt`).
+- The corresponding LanguageTool source is the `v6.6` tag at
+  https://github.com/languagetool-org/languagetool/tree/v6.6
+- The gem's MIT license permits reverse engineering, so you may
+  debug the binary and your modifications to it.
+- You can rebuild the engine against a modified LanguageTool: change
+  the version in `native/languagetool/pom.xml` and follow the
+  rebuild steps in `native/languagetool/README.md` under "Changing
+  the native engine".
+
+Written offer under section 6(c): we give any recipient the
+machine-readable materials that section 6(a) names, for at least three
+years after each release, at no charge. Ask in an issue at
+https://github.com/TonyCTHsu/simple-english/issues. The materials are
+the LanguageTool `v6.6` source, the resolved classpath of
+`native/languagetool/pom.xml` as Maven Central artifacts, the
+reachability metadata under `native/languagetool/config/`, and the
+build scripts `native/languagetool/build.rb` and `Rakefile` with the
+`rules/simple-english.xml` overlay. You need them to modify
+LanguageTool and relink a working engine.
+
+## OpenJDK and GraalVM source
+
+The binary embeds OpenJDK and GraalVM Community runtime code under
+GPLv2 with the Classpath Exception. The corresponding source is
+public: https://github.com/openjdk/jdk and
+https://github.com/oracle/graal. The release SBOM names the versions
+the binary embeds.

data/bin/se

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/simple_english/cli"
+
+exit(SimpleEnglish::CLI.start(ARGV) || 0)