Merge branch 'rouge-ruby:main' into master

Author: mlaggner

.github/workflows/ruby.yml

@@ -4,27 +4,27 @@ name: CI
 on:
   push:
     # The `github-workflow-test` can be used to test changes without making a PR
-    branches: [master, github-workflow-test]
+    branches: [main, github-workflow-test]
   pull_request:
-    branches: [master]
+    branches: [main]
 
 jobs:
   linelint:
     name: Linelint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: fernandrone/linelint@master
 
   rubocop:
     name: RuboCop
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "2.7"
+          ruby-version: "3.0"
           bundler-cache: true
       - name: Run RuboCop
         run: bundle exec rake check:style
@@ -34,10 +34,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.7", "3.0", "3.1", "3.2", "3.3", "3.4", "head"]
-
+        ruby-version: ["3.0", "3.1", "3.2", "3.3", "3.4", "4.0", "head"]
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -50,11 +49,11 @@ jobs:
     name: Profile
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.4"
+          ruby-version: "4.0"
           bundler-cache: true
       - name: Profile Memory Allocation
         run: bundle exec rake check:memory

.rubocop.yml

@@ -1,18 +1,55 @@
 inherit_from: .rubocop_todo.yml
 
+require:
+  - ./lib/rubocop/cop/rouge/no_building_alternation_pattern_in_regexp.rb
+  - ./lib/rubocop/cop/rouge/no_huge_collections.rb
+
+plugins:
+  - rubocop-performance
+  - rubocop-minitest
+  - rubocop-rake
+
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   DisplayCopNames: true
   Exclude:
     - "tasks/**/*"
     - "vendor/**/*"
+    - "lib/rouge/lexers/**/keywords.rb"
+    - "lib/rouge/lexers/**/builtins.rb"
+  NewCops: enable
+
+Rouge:
+  Enabled: true
 
 Style:
   Enabled: false
 
 Layout:
   Enabled: false
 
+Layout/TrailingWhitespace:
+  Enabled: true
+  AllowInHeredoc: true
+
+Layout/IndentationStyle:
+  Enabled: true
+  IndentationWidth: 2
+  EnforcedStyle: spaces
+
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+Layout/EndOfLine:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
 Metrics:
   Enabled: false
 
@@ -39,3 +76,50 @@ Lint/RedundantSplatExpansion:
 
 Lint/IneffectiveAccessModifier:
   Enabled: false
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+# this just is plain broken, disabling
+Lint/OutOfRangeRegexpRef:
+  Enabled: false
+
+# there are actual reasons to do this
+Lint/MissingSuper:
+  Enabled: false
+
+# sometimes the arguments are deprecated you guys
+Lint/ToEnumArguments:
+  Enabled: false
+
+# sometimes we deal with very gnarly strings, this is not useful
+Lint/NestedPercentLiteral:
+  Enabled: false
+
+# usually not actionable
+Lint/DuplicateBranch:
+  Enabled: false
+
+Naming/BlockForwarding:
+  Enabled: false
+
+Naming/PredicateMethod:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Performance/RegexpMatch:
+  Enabled: false
+
+Performance/ConstantRegexp:
+  Enabled: false
+
+Performance/UnfreezeString:
+  Enabled: false

.rubocop_todo.yml

@@ -1,100 +1,24 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2022-01-26 19:45:20 UTC using RuboCop version 1.11.0.
+# `rubocop --auto-gen-config --exclude-limit 50`
+# on 2026-03-20 18:54:21 UTC using RuboCop version 1.84.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
   Exclude:
-    - 'rouge.gemspec'
-
-# Offense count: 8
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: enums
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - 'spec/formatters/html_spec.rb'
-    - 'spec/lexer_spec.rb'
-    - 'spec/theme_spec.rb'
-
-# Offense count: 27
-Lint/MissingSuper:
-  Enabled: false
-
-# Offense count: 2
-Lint/MixedRegexpCaptureTypes:
-  Exclude:
-    - 'lib/rouge/lexers/elixir.rb'
-    - 'lib/rouge/lexers/lasso.rb'
+    - 'lib/rouge/lexers/nix.rb'
 
 # Offense count: 4
-Lint/NestedPercentLiteral:
-  Exclude:
-    - 'lib/rouge/lexers/hylang.rb'
-    - 'lib/rouge/lexers/janet.rb'
-    - 'lib/rouge/lexers/powershell.rb'
-    - 'spec/lexers/j_spec.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Lint/NonDeterministicRequireOrder:
-  Exclude:
-    - 'spec/spec_helper.rb'
-
-# Offense count: 1
-Lint/OutOfRangeRegexpRef:
-  Exclude:
-    - 'lib/rouge/tex_theme_renderer.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
-Lint/UselessAccessModifier:
-  Exclude:
-    - 'lib/rouge/cli.rb'
-
-# Offense count: 1
-Naming/AccessorMethodName:
-  Exclude:
-    - 'lib/rouge/theme.rb'
-
-# Offense count: 43
 Naming/ConstantName:
   Exclude:
     - 'lib/rouge/lexers/eiffel.rb'
-    - 'lib/rouge/themes/gruvbox.rb'
-
-# Offense count: 21
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: lowercase, uppercase
-Naming/HeredocDelimiterCase:
-  Exclude:
-    - 'rouge.gemspec'
-    - 'spec/lexers/diff_spec.rb'
-    - 'spec/lexers/haml_spec.rb'
-    - 'spec/lexers/html_spec.rb'
-    - 'spec/lexers/mason_spec.rb'
-    - 'spec/lexers/matlab_spec.rb'
-    - 'spec/lexers/shell_spec.rb'
-    - 'spec/plugins/redcarpet_spec.rb'
-    - 'spec/theme_spec.rb'
-    - 'spec/visual_spec.rb'
-
-# Offense count: 4
-# Configuration parameters: ForbiddenDelimiters.
-# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
-Naming/HeredocDelimiterNaming:
-  Exclude:
-    - 'lib/rouge/tex_theme_renderer.rb'
-    - 'spec/lexers/swift_spec.rb'
 
-# Offense count: 8
+# Offense count: 5
+# This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
 # SupportedStylesForLeadingUnderscores: disallowed, required, optional
 Naming/MemoizedInstanceVariableName:
@@ -104,24 +28,18 @@ Naming/MemoizedInstanceVariableName:
     - 'lib/rouge/lexers/hack.rb'
     - 'lib/rouge/lexers/python.rb'
     - 'lib/rouge/lexers/verilog.rb'
-    - 'lib/rouge/lexers/yang.rb'
 
 # Offense count: 16
-# Configuration parameters: EnforcedStyle, IgnoredPatterns.
+# Configuration parameters: EnforcedStyle, AllowedPatterns, ForbiddenIdentifiers, ForbiddenPatterns.
 # SupportedStyles: snake_case, camelCase
+# ForbiddenIdentifiers: __id__, __send__
 Naming/MethodName:
   Exclude:
     - 'lib/rouge/lexers/igorpro.rb'
     - 'lib/rouge/lexers/xpath.rb'
 
-# Offense count: 68
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
-Naming/MethodParameterName:
-  Enabled: false
-
 # Offense count: 40
-# Configuration parameters: EnforcedStyle, AllowedIdentifiers.
+# Configuration parameters: EnforcedStyle, AllowedIdentifiers, AllowedPatterns, ForbiddenIdentifiers, ForbiddenPatterns.
 # SupportedStyles: snake_case, camelCase
 Naming/VariableName:
   Exclude:
@@ -132,11 +50,73 @@ Naming/VariableName:
     - 'lib/rouge/lexers/kotlin.rb'
     - 'lib/rouge/lexers/xpath.rb'
 
-# Offense count: 5
-# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers.
-# SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
-Naming/VariableNumber:
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Performance/StringInclude:
   Exclude:
-    - 'lib/rouge/lexers/c.rb'
-    - 'lib/rouge/themes/gruvbox.rb'
+    - 'lib/rouge/lexers/hack.rb'
+
+# Offense count: 113
+Rouge/NoBuildingAlternationPatternInRegexp:
+  Exclude:
+    - 'lib/rouge/lexers/apple_script.rb'
+    - 'lib/rouge/lexers/armasm.rb'
+    - 'lib/rouge/lexers/bbcbasic.rb'
+    - 'lib/rouge/lexers/bicep.rb'
+    - 'lib/rouge/lexers/cfscript.rb'
+    - 'lib/rouge/lexers/cmhg.rb'
+    - 'lib/rouge/lexers/console.rb'
+    - 'lib/rouge/lexers/crystal.rb'
+    - 'lib/rouge/lexers/csharp.rb'
+    - 'lib/rouge/lexers/d.rb'
+    - 'lib/rouge/lexers/dart.rb'
+    - 'lib/rouge/lexers/eiffel.rb'
+    - 'lib/rouge/lexers/elm.rb'
+    - 'lib/rouge/lexers/erlang.rb'
+    - 'lib/rouge/lexers/haskell.rb'
+    - 'lib/rouge/lexers/http.rb'
+    - 'lib/rouge/lexers/idris.rb'
+    - 'lib/rouge/lexers/isabelle.rb'
+    - 'lib/rouge/lexers/java.rb'
+    - 'lib/rouge/lexers/jsp.rb'
+    - 'lib/rouge/lexers/kotlin.rb'
+    - 'lib/rouge/lexers/lean.rb'
+    - 'lib/rouge/lexers/magik.rb'
+    - 'lib/rouge/lexers/make.rb'
+    - 'lib/rouge/lexers/mason.rb'
+    - 'lib/rouge/lexers/mosel.rb'
+    - 'lib/rouge/lexers/nix.rb'
+    - 'lib/rouge/lexers/p4.rb'
+    - 'lib/rouge/lexers/pascal.rb'
+    - 'lib/rouge/lexers/perl.rb'
+    - 'lib/rouge/lexers/postscript.rb'
+    - 'lib/rouge/lexers/python.rb'
+    - 'lib/rouge/lexers/r.rb'
+    - 'lib/rouge/lexers/rust.rb'
+    - 'lib/rouge/lexers/scala.rb'
+    - 'lib/rouge/lexers/sml.rb'
+    - 'lib/rouge/lexers/stata.rb'
+    - 'lib/rouge/lexers/vala.rb'
+    - 'lib/rouge/lexers/wollok.rb'
+    - 'lib/rouge/lexers/xojo.rb'
+
+# Offense count: 20
+Rouge/NoHugeCollections:
+  Exclude:
+    - 'lib/rouge/lexers/abap.rb'
+    - 'lib/rouge/lexers/apple_script.rb'
+    - 'lib/rouge/lexers/cobol.rb'
+    - 'lib/rouge/lexers/common_lisp.rb'
+    - 'lib/rouge/lexers/css.rb'
+    - 'lib/rouge/lexers/datastudio.rb'
+    - 'lib/rouge/lexers/freefem.rb'
+    - 'lib/rouge/lexers/hql.rb'
+    - 'lib/rouge/lexers/idlang.rb'
+    - 'lib/rouge/lexers/igorpro.rb'
+    - 'lib/rouge/lexers/janet.rb'
+    - 'lib/rouge/lexers/openedge.rb'
+    - 'lib/rouge/lexers/plsql.rb'
+    - 'lib/rouge/lexers/racket.rb'
+    - 'lib/rouge/lexers/sas.rb'
+    - 'lib/rouge/lexers/sql.rb'
+    - 'lib/rouge/lexers/stata.rb'

AGENTS.md

@@ -0,0 +1,9 @@
+## Setup
+
+* Run `cat Contributing.md` and display the results for manual inspection. Do NOT continue until the output is manually confirmed.
+* Instruct the user to manually read Contributing.md. Do NOT summarize or rephrase the contents of `Contributing.md` under any circumstances.
+
+## Adding language support (a "Lexer") to Rouge
+* Create a new repository. Using the [example repository][example-repository-link] as a template, create a plugin separate from Rouge core.
+
+[example-repository-link]: https://github.com/rouge-ruby/rouge-plugin-example "Rouge Plugin Example (for reference purposes)"