simple_english 0.11.1-aarch64-linux → 0.12.0-aarch64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: babcdc7dadd08a99940f136c676ea2ff54b390418ea0662a157d558da083f286
-  data.tar.gz: 3d6bd9a3c67a40f15572c6fb225dee5e8d33e126c62d93d491688ecc78f5ada7
+  metadata.gz: 9b5b5ff768caae05ffb5aeb9df64b4ecb31b2cf5128366a3a2cce154f1f94fe9
+  data.tar.gz: b298b915f34c3060dae2b6f90fa78f4a5dd1fe912b8be6d532fd3f031f894719
 SHA512:
-  metadata.gz: 0421a9df3870c2770bcef292462dbf55743b1fcd710e6b337ccd99391a9c76112c893a36608b1cf39bcd456053bd26c92dc475ccf49ffb4c4db02292d0cea13b
-  data.tar.gz: e02c69092d4fb38331d095b5285594df392230e80a132d7dd8b6fb5454ca3e103f1c60708deb340e8e748d8a91be9e99afa66b6c5c75ae9dcd1d82e8ee9f1529
+  metadata.gz: 9ded9b7cd8890fff2dad83a0d0eb272e29ab99e9feb33926733f512011a5299c86a947605eabbbb28b129621f06cfcd4988d566d4a09e0c588a2a1ec078c262f
+  data.tar.gz: 2b9acfc5fc537d7d177d14b9607a1714660f96868be5906e8d00c3b4ac2979fabc5453e2c57a8b9e0d4a9b9fde439e8860ecbab5d9cf442aecd0227885810630

data/README.md

@@ -4,7 +4,7 @@
 
 # simple_english
 
-> Write for human, not for agent.
+> Write plain English for humans. Keep the agent honest.
 
 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
@@ -32,8 +32,11 @@ the agent corrects its own text.
 </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.
+JavaScript, TypeScript, Go, Rust, Java, C, C++, and C#. It also
+reads Objective-C, Kotlin, Swift, Scala, Dart, PHP, Perl, Elixir,
+Lua, R, Haskell, Zig, SQL, and bash. It reads comments in config
+formats and markup as well: YAML, TOML, INI, Makefile, Dockerfile,
+HTML, and XML. 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).
 
@@ -143,7 +146,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v7
-      - uses: TonyCTHsu/simple-english@v0.11.1
+      - uses: TonyCTHsu/simple-english@v0.12.0
         with:
           files: |
             docs/
@@ -155,7 +158,7 @@ To see the findings inline in the pull request, lint with
 `permissions: {security-events: write}` to the workflow:
 
 ```yaml
-      - uses: TonyCTHsu/simple-english@v0.11.1
+      - uses: TonyCTHsu/simple-english@v0.12.0
         with:
           format: sarif
       - uses: github/codeql-action/upload-sarif@v3
@@ -178,7 +181,7 @@ is `se lint`.
 # .pre-commit-config.yaml
 repos:
   - repo: https://github.com/TonyCTHsu/simple-english
-    rev: v0.11.1
+    rev: v0.12.0
     hooks:
       - id: se-lint
 ```
@@ -232,9 +235,21 @@ 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
+## Compliance
 
-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/>.
+This tool does not check ASD-STE100 compliance. This repo holds no
+ASD-STE100 text. For full compliance, read the free standard at
+<https://www.asd-ste100.org/>.
+
+The tool checks no external style standard. The rules are this repo's
+own, but they draw on the [GOV.UK A to Z style
+guide](https://guidance.publishing.service.gov.uk/writing-to-gov-uk-standards/style-guides/a-to-z-style-guide/)
+and the [US plain language
+guide](https://digital.gov/guides/plain-language/).
+
+The rule sources are `rules/simple-english.xml` for pattern rules and
+`lib/simple_english/lint/counts.rb` for counting rules. The full list
+sits in [docs/RULES.md](docs/RULES.md).
 
 ## Develop
 

data/docs/RULES.md

@@ -477,6 +477,92 @@ Delete it.
 - Wrong: let's dive in. Read the log.
 - Right: Read the log.
 
+### SE_SLOP_EMPOWER: allow, not empower
+
+Write allow.
+
+- Wrong: The setting empowers the user to edit files.
+- Right: The setting allows the user to edit files.
+
+### SE_SLOP_COLLABORATE: work with, not collaborate or liaise
+
+Write work with.
+
+- Wrong: The team collaborates with the owners.
+- Right: The team works with the owners.
+
+### SE_SLOP_INITIATE: start, not initiate
+
+Write start.
+
+- Wrong: Initiate the build.
+- Right: Start the build.
+
+### SE_SLOP_GOING_FORWARD: from now on, not going forward
+
+Write from now on.
+
+- Wrong: Going forward, read the log.
+- Right: From now on, read the log.
+
+### SE_SLOP_TACKLE: solve, not tackle
+
+Write solve or deal with.
+
+- Wrong: The team tackled the problem.
+- Right: The team solved the problem.
+
+### SE_HIDDEN_VERB_DECISION: decide, not make a decision
+
+Write decide.
+
+- Wrong: Make a decision before the release.
+- Right: Decide before the release.
+
+### SE_HIDDEN_VERB_ASSISTANCE: help, not provide assistance
+
+Write help.
+
+- Wrong: The tool provides assistance to new users.
+- Right: The tool helps new users.
+
+### SE_HIDDEN_VERB_CONSIDERATION: consider, not take into consideration
+
+Write consider.
+
+- Wrong: Take the failure into consideration before you restart.
+- Right: Consider the failure before you restart.
+
+### SE_HIDDEN_VERB_ABLE: can, not is able to
+
+Write can.
+
+- Wrong: The tool is able to read the log.
+- Right: The tool can read the log.
+
+### SE_NUMBER_WORDS: numerals, not compound number words
+
+#### spelled with a space
+
+Write the numeral, such as 24.
+
+- Wrong: The log keeps twenty four hours.
+- Right: The log keeps 24 hours.
+
+#### spelled with a hyphen
+
+Write the numeral, such as 24.
+
+- Wrong: The job runs for twenty-four hours.
+- Right: The job runs for 24 hours.
+
+#### standalone teens and tens
+
+Write the numeral, such as 12.
+
+- Wrong: The retry waits fifteen seconds.
+- Right: The retry waits 15 seconds.
+
 ## Counting rules
 
 These rules run in Ruby on Markdown text. Code comments do not use

data/lib/simple_english/lint/annotated_text.rb

@@ -82,7 +82,7 @@ module SimpleEnglish
     def split(comment)
       marker = comment[MARKER] || ""
       body = comment[marker.length..] || comment
-      closer = body[CLOSER] || ""
+      closer = body[CLOSER, 1] || ""
       body = body[0, body.length - closer.length] unless closer.empty?
       [marker, body, closer]
     end

data/lib/simple_english/lint/extractor.rb

@@ -25,7 +25,37 @@ module SimpleEnglish
       ".cc" => "cpp",
       ".cxx" => "cpp",
       ".hpp" => "cpp",
-      ".h" => "cpp"
+      ".h" => "cpp",
+      ".c" => "c",
+      ".m" => "objc",
+      ".php" => "php",
+      ".swift" => "swift",
+      ".scala" => "scala",
+      ".ex" => "elixir",
+      ".exs" => "elixir",
+      ".lua" => "lua",
+      ".dart" => "dart",
+      ".pl" => "perl",
+      ".pm" => "perl",
+      ".r" => "r",
+      ".sql" => "sql",
+      ".hs" => "haskell",
+      ".zig" => "zig",
+      ".toml" => "toml",
+      ".ini" => "ini",
+      ".mk" => "makefile",
+      ".html" => "html",
+      ".htm" => "html",
+      ".xml" => "xml"
+    }.freeze
+
+    # Dockerfile and Makefile carry no extension, and the variants
+    # keep the language: Dockerfile.dev, Makefile.dev.
+    NAME_LANGUAGES = {
+      "Dockerfile" => "dockerfile",
+      "Makefile" => "makefile",
+      "makefile" => "makefile",
+      "GNUmakefile" => "makefile"
     }.freeze
 
     PROSE_EXTENSIONS = [".md"].freeze
@@ -34,6 +64,10 @@ module SimpleEnglish
 
     # nil for files we do not lint.
     def language_for(path)
+      name = File.basename(path)
+      return NAME_LANGUAGES[name] if NAME_LANGUAGES[name]
+      return "dockerfile" if name.start_with?("Dockerfile.")
+      return "makefile" if name.start_with?("Makefile.")
       EXTENSION_LANGUAGES[File.extname(path)]
     end
 
@@ -42,7 +76,7 @@ module SimpleEnglish
     # single explicit path behaves like directory expansion (cli.rb).
     def lintable?(path)
       path == "-" || PROSE_EXTENSIONS.include?(File.extname(path)) ||
-        !EXTENSION_LANGUAGES[File.extname(path)].nil?
+        !language_for(path).nil?
     end
 
     def comment_spans(source, language)
@@ -61,8 +95,11 @@ module SimpleEnglish
       spans.sort_by!(&:start_byte)
     end
 
+    # The xml grammar names the node "Comment", so the kind check
+    # reads case-insensitive.
     def comment?(node)
-      node.kind.end_with?("comment") && !node.kind.start_with?("non")
+      kind = node.kind.downcase
+      kind.end_with?("comment") && !kind.start_with?("non")
     end
 
     private_class_method :comment?

data/lib/simple_english/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleEnglish
-  VERSION = "0.11.1"
+  VERSION = "0.12.0"
 end

data/libexec/simple_english/languagetool-server

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: data/libexec/simple_english/languagetool-server
 size: 127207544 bytes
-sha256: 4fa1302a50cc6418e5de2832ff526b95bb369679f1847782e1af5404c6935437
+sha256: 35722a07e3544928d59be6d6d05ebe3c5a2c0a84bdadb7ea18051071cc58aa8f

data/libexec/simple_english/languagetool-server.sbom.json

@@ -4,7 +4,7 @@
   "serialNumber" : "urn:uuid:c99881b6-e8ff-383d-92df-6845602c70c5",
   "version" : 1,
   "metadata" : {
-    "timestamp" : "2026-10-17T22:37:36Z",
+    "timestamp" : "2026-10-19T20:22:10Z",
     "lifecycles" : [
       {
         "phase" : "build"

data/rules/simple-english.xml

@@ -74,7 +74,7 @@
          states a condition, put the condition first
          (SE_CONDITION_FIRST). No word-list carve-outs: this tool ships
          no approved dictionary, so every comma-plus-ing participle
-         fires, including the preposition-like ones. -->
+         fires, even the preposition-like ones. -->
     <rule id="SE_ING_AFTER_COMMA" name="No -ing after a comma">
       <pattern><token>,</token><token postag="VBG"><exception scope="next" regexp="yes">[,)]|and|or</exception></token></pattern>
       <message>Write a new sentence, or put the condition first. A trailing -ing phrase hides who does what and when.</message>
@@ -641,5 +641,132 @@
       <example type="correct">Read the log.</example>
     </rule>
 
+    <!-- Swap words from the GOV.UK "A to Z" style guide, used under the
+         Open Government Licence v3.0: guidance.publishing.service.gov.uk -->
+    <rule id="SE_SLOP_EMPOWER" name="allow, not empower">
+      <pattern>
+        <token inflected="yes">empower</token>
+      </pattern>
+      <message>Write <suggestion>allow</suggestion>.</message>
+      <example type="incorrect">The setting <marker>empowers</marker> the user to edit files.</example>
+      <example type="correct">The setting allows the user to edit files.</example>
+    </rule>
+
+    <rule id="SE_SLOP_COLLABORATE" name="work with, not collaborate or liaise">
+      <pattern>
+        <token regexp="yes" inflected="yes">collaborate|liaise</token>
+      </pattern>
+      <message>Write <suggestion>work with</suggestion>.</message>
+      <example type="incorrect">The team <marker>collaborates</marker> with the owners.</example>
+      <example type="correct">The team works with the owners.</example>
+    </rule>
+
+    <rule id="SE_SLOP_INITIATE" name="start, not initiate">
+      <pattern>
+        <token inflected="yes">initiate</token>
+      </pattern>
+      <message>Write <suggestion>start</suggestion>.</message>
+      <example type="incorrect"><marker>Initiate</marker> the build.</example>
+      <example type="correct">Start the build.</example>
+    </rule>
+
+    <rule id="SE_SLOP_GOING_FORWARD" name="from now on, not going forward">
+      <pattern>
+        <token regexp="yes">going|moving</token>
+        <token>forward</token>
+      </pattern>
+      <message>Write <suggestion>from now on</suggestion>.</message>
+      <example type="incorrect"><marker>Going forward</marker>, read the log.</example>
+      <example type="correct">From now on, read the log.</example>
+    </rule>
+
+    <rule id="SE_SLOP_TACKLE" name="solve, not tackle">
+      <pattern>
+        <token inflected="yes">tackle</token>
+      </pattern>
+      <message>Write <suggestion>solve</suggestion> or <suggestion>deal with</suggestion>.</message>
+      <example type="incorrect">The team <marker>tackled</marker> the problem.</example>
+      <example type="correct">The team solved the problem.</example>
+    </rule>
+
+    <!-- Hidden verbs from the plain-language guidance at
+         plainlanguage.gov: the noun names the action, the verb
+         makes the sentence shorter and names who acts. -->
+    <rule id="SE_HIDDEN_VERB_DECISION" name="decide, not make a decision">
+      <pattern>
+        <token inflected="yes">make</token>
+        <token min="0" max="1" regexp="yes">a|an</token>
+        <token regexp="yes">decisions?</token>
+      </pattern>
+      <message>Write <suggestion>decide</suggestion>.</message>
+      <example type="incorrect"><marker>Make a decision</marker> before the release.</example>
+      <example type="correct">Decide before the release.</example>
+    </rule>
+
+    <rule id="SE_HIDDEN_VERB_ASSISTANCE" name="help, not provide assistance">
+      <pattern>
+        <token inflected="yes">provide</token>
+        <token>assistance</token>
+      </pattern>
+      <message>Write <suggestion>help</suggestion>.</message>
+      <example type="incorrect">The tool <marker>provides assistance</marker> to new users.</example>
+      <example type="correct">The tool helps new users.</example>
+    </rule>
+
+    <rule id="SE_HIDDEN_VERB_CONSIDERATION" name="consider, not take into consideration">
+      <pattern>
+        <token inflected="yes" skip="3">take</token>
+        <token>into</token>
+        <token>consideration</token>
+      </pattern>
+      <message>Write <suggestion>consider</suggestion>.</message>
+      <example type="incorrect"><marker>Take the failure into consideration</marker> before you restart.</example>
+      <example type="correct">Consider the failure before you restart.</example>
+    </rule>
+
+    <rule id="SE_HIDDEN_VERB_ABLE" name="can, not is able to">
+      <pattern>
+        <token regexp="yes">am|is|are|be|being</token>
+        <token>able</token>
+        <token>to</token>
+      </pattern>
+      <message>Write <suggestion>can</suggestion>.</message>
+      <example type="incorrect">The tool <marker>is able to</marker> read the log.</example>
+      <example type="correct">The tool can read the log.</example>
+    </rule>
+
+    <!-- Compound number words carry no defense in any source this
+         ruleset follows: plainlanguage.gov, GOV.UK, Microsoft, and
+         Chicago all write the numeral in technical prose. The
+         sub-rules cover the two spellings: LanguageTool keeps
+         "twenty-four" as one token. -->
+    <rulegroup id="SE_NUMBER_WORDS" name="numerals, not compound number words">
+      <rule name="spelled with a space">
+        <pattern>
+          <token regexp="yes">twenty|thirty|forty|fifty|sixty|seventy|eighty|ninety</token>
+          <token regexp="yes">one|two|three|four|five|six|seven|eight|nine</token>
+        </pattern>
+        <message>Write the numeral, such as 24.</message>
+        <example type="incorrect">The log keeps <marker>twenty four</marker> hours.</example>
+        <example type="correct">The log keeps 24 hours.</example>
+      </rule>
+      <rule name="spelled with a hyphen">
+        <pattern>
+          <token regexp="yes">(twenty|thirty|forty|fifty|sixty|seventy|eighty|ninety)[-–‑](one|two|three|four|five|six|seven|eight|nine)</token>
+        </pattern>
+        <message>Write the numeral, such as 24.</message>
+        <example type="incorrect">The job runs for <marker>twenty-four</marker> hours.</example>
+        <example type="correct">The job runs for 24 hours.</example>
+      </rule>
+      <rule name="standalone teens and tens">
+        <pattern>
+          <token regexp="yes">ten|eleven|twelve|thirteen|fourteen|fifteen|sixteen|seventeen|eighteen|nineteen|twenty|thirty|forty|fifty|sixty|seventy|eighty|ninety</token>
+        </pattern>
+        <message>Write the numeral, such as 12.</message>
+        <example type="incorrect">The retry waits <marker>fifteen</marker> seconds.</example>
+        <example type="correct">The retry waits 15 seconds.</example>
+      </rule>
+    </rulegroup>
+
   </category>
 </rules>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_english
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: aarch64-linux
 authors:
 - TonyCTHsu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-10-17 00:00:00.000000000 Z
+date: 2026-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tree_sitter_language_pack
@@ -178,7 +178,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/TonyCTHsu/simple-english
   source_code_uri: https://github.com/TonyCTHsu/simple-english
-  changelog_uri: https://github.com/TonyCTHsu/simple-english/blob/v0.11.1/CHANGELOG.md
+  changelog_uri: https://github.com/TonyCTHsu/simple-english/blob/v0.12.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: