Skip to content

Can I contribute a cspell hook? #810

@mattbrictson

Description

@mattbrictson

Hi, I've written a simple overcommit hook for cspell, which is a general purpose spell-check linter for code and documentation.

Would the overcommit maintainers be interested in a PR to add this?

module Overcommit::Hook::PreCommit
  class Cspell < Base
    MESSAGE_REGEX = /^(?<file>.+):(?<line>\d+):\d+ - (?<message>.+)$/

    def run
      result = execute(command, args: applicable_files.map { "file://#{_1}" })
      return :pass if result.success?

      extract_messages(result.stdout.lines, MESSAGE_REGEX)
    end
  end
end

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions