Can I contribute a cspell hook?

オープン
#810 コメント 0 件 リアクション 2 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
ruby
領域
devtools

調査の方向性

The issue proposes a new pre-commit hook for cspell and includes a draft Ruby class. Look at the existing hooks under lib/overcommit/hook/pre_commit/ and the default hook configuration in config/default.yml to see how a hook is registered and how its output is parsed. Done means a maintainer agrees the hook belongs in the project, then a hook class, its config entry and a spec pass, but the issue has had no reply in about three and a half years, so confirm interest first.

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
Ruby
スター
4k
フォーク
288
平均マージ
2日 4時間
マージ済み PR(30日)
18

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

sds/overcommit のほかの issue

sds/overcommit の issue をすべて見る

似ている issue

Ruby の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。