a11y-lint 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cc893abebb39fdce9dcf7a2d1b7659734d7e27ebc5d88b166245c1baa2991a2
-  data.tar.gz: 51da80a1ea01bf4650831ca95cb6439120ffc881b2f909b1aab3fe44db58e9f8
+  metadata.gz: e12c6c589719fa574aecc86ff23ba8f3c2f9b3ae7f5d4da88bae60bbd3035735
+  data.tar.gz: c107e0d511e57a1cbbbb61ec62a28d3f704bb11e3dbea32851000146f3053a4c
 SHA512:
-  metadata.gz: ef6c52fc24bab87e5d1873d40eff8425e31128cfdecb933881c7f0d51abb15c2bd588299257e324468beb1c72fe2fd7666815facbae62a5a6e30f78e5fac40b8
-  data.tar.gz: f3f78859233ba397931dc57dd228b87e36afbeff2856e9e13da304e3af05de97ce379e1628bec0a63078a6d8a190472401d67cc6d059db6c1e529c67290f66a2
+  metadata.gz: 81a64d2d5a348f5341636124859d31a61f65d6e4fce0d4712bafae17092d7749d5b629aa7f2a7e4269bc54f6e5ce3ff4cbf60225b1ccbcf7f44375104eaa773c
+  data.tar.gz: bda106347b59bb146e5acc02937eae5d54c0649833c86e86982f6759b128c5fc7b8885b632ee00d6d0848c3746d8d7eb5e4a041b74e1916cc39e6921a57d3ab3

data/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2026-03-27
+
+### Added
+
+- Command-line interface (`exe/a11y-lint`) for running the linter from the terminal
+  - Accepts file paths and directories as arguments
+  - Recursively scans for `.slim` files when given a directory (defaults to current directory)
+  - Supports `--version` and `--help` flags
+
 ## [0.1.0] - 2026-03-27
 
 ### Added

data/CLAUDE.md

@@ -14,10 +14,12 @@ a11y-lint is a Ruby gem (v0.1.0) for accessibility linting. It uses the `A11y::L
 - **Run a single test file:** `bundle exec ruby -Ilib:test test/a11y/test_lint.rb`
 - **Run a single test by name:** `bundle exec ruby -Ilib:test test/a11y/test_lint.rb -n test_name`
 - **Run linter:** `bundle exec rake rubocop`
+- **Run a11y-lint on files:** `bundle exec a11y-lint [file_or_directory ...]`
 - **Interactive console with gem loaded:** `bin/console`
 
 ## Architecture
 
+- **CLI:** `lib/a11y/lint/cli.rb` — command-line interface; executable at `exe/a11y-lint`
 - **Entry point:** `lib/a11y/lint.rb` — defines the `A11y::Lint` module and `A11y::Lint::Error` exception
 - **Version:** `lib/a11y/lint/version.rb`
 - **Type signatures (RBS):** `sig/a11y/lint.rbs`

data/README.md

@@ -24,8 +24,33 @@ gem install a11y-lint
 
 ## Usage
 
+### Command Line
+
+Run the linter on specific files or directories:
+
+```bash
+a11y-lint app/views/
+a11y-lint app/views/home.html.slim app/views/about.html.slim
+```
+
+With no arguments, it scans the current directory recursively for `.slim` files:
+
+```bash
+a11y-lint
+```
+
+### Ruby API
+
 ```ruby
 require "a11y/lint"
+
+source = File.read("app/views/home.html.slim")
+runner = A11y::Lint::Runner.new([A11y::Lint::Rules::ImgMissingAlt.new])
+offenses = runner.run(source, filename: "app/views/home.html.slim")
+
+offenses.each do |offense|
+  puts "#{offense.filename}:#{offense.line} [#{offense.rule}] #{offense.message}"
+end
 ```
 
 ## Requirements

data/exe/a11y-lint

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "a11y/lint"
+require "a11y/lint/cli"
+
+exit A11y::Lint::CLI.new(ARGV).run

data/lib/a11y/lint/cli.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module A11y
+  module Lint
+    # Command-line interface for running accessibility linting on Slim templates.
+    class CLI
+      def initialize(argv, stdout: $stdout, stderr: $stderr)
+        @argv = argv
+        @stdout = stdout
+        @stderr = stderr
+      end
+
+      def run
+        parse_options!
+        files = resolve_files(@argv)
+
+        if files.empty?
+          @stderr.puts("No .slim files found")
+          return 0
+        end
+
+        offenses = lint_files(files)
+        print_results(offenses)
+
+        offenses.empty? ? 0 : 1
+      end
+
+      private
+
+      def parse_options!
+        option_parser.parse!(@argv)
+      end
+
+      def option_parser # rubocop:disable Metrics/MethodLength
+        OptionParser.new do |opts|
+          opts.banner = "Usage: a11y-lint [options] [file_or_directory ...]"
+
+          opts.on("-v", "--version", "Show version") do
+            @stdout.puts(A11y::Lint::VERSION)
+            exit 0
+          end
+
+          opts.on("-h", "--help", "Show help") do
+            @stdout.puts(opts)
+            exit 0
+          end
+        end
+      end
+
+      def resolve_files(paths)
+        paths = ["."] if paths.empty?
+        paths.flat_map { |path| expand_path(path) }.sort
+      end
+
+      def expand_path(path)
+        if File.directory?(path)
+          Dir.glob(File.join(path, "**", "*.slim"))
+        elsif File.file?(path)
+          [path]
+        else
+          @stderr.puts("Warning: #{path} not found, skipping")
+          []
+        end
+      end
+
+      def lint_files(files)
+        runner = Runner.new(all_rules)
+
+        files.flat_map do |file|
+          source = File.read(file)
+          runner.run(source, filename: file)
+        end
+      end
+
+      def all_rules
+        Rules.constants.filter_map do |name|
+          klass = Rules.const_get(name)
+          klass.new if klass.is_a?(Class) && klass < Rule
+        end
+      end
+
+      def print_results(offenses)
+        offenses.each { |offense| print_offense(offense) }
+        @stdout.puts(summary_message(offenses.length))
+      end
+
+      def print_offense(offense)
+        @stdout.puts(
+          "#{offense.filename}:#{offense.line} " \
+          "[#{offense.rule}] #{offense.message}"
+        )
+      end
+
+      def summary_message(count)
+        return "No offenses found" if count.zero?
+
+        "#{count} offense#{"s" unless count == 1} found"
+      end
+    end
+  end
+end

data/lib/a11y/lint/version.rb

@@ -2,6 +2,6 @@
 
 module A11y
   module Lint
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: a11y-lint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Abdullah Hashim
@@ -26,7 +26,8 @@ dependencies:
 description: A linter for checking accessibility issues in your code
 email:
 - abdul@hey.com
-executables: []
+executables:
+- a11y-lint
 extensions: []
 extra_rdoc_files: []
 files:
@@ -38,7 +39,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/a11y-lint
 - lib/a11y/lint.rb
+- lib/a11y/lint/cli.rb
 - lib/a11y/lint/node.rb
 - lib/a11y/lint/offense.rb
 - lib/a11y/lint/rule.rb