本文へ移動

22静的検査のコミットゲートを構築

HTML、CSS、JavaScript、Python、YAML、Markdown、Shell、リンク、綴り、秘密情報、組版を対象に、1行で説明できる検査22個と詳しい説明が必要な検査5個からなるコミットゲートを構築し、警告扱いや行内抑制を認めない方針にした。

22 1行で説明できる検査と詳述を要する5つの検査

状況. 参加ガイドは提案にとどまり、金曜の小さな変更では負ける。1人のプロジェクトではレビュー担当者もおらず、書いた本人が自分に最も異議を唱えたくない瞬間に、本番との唯一の防壁となるため、さらに深刻だった。

課題. 気づかれるのを待たず違反でコミットを失敗させる、実行可能な基準が必要だった。

行動. 全指摘をエラーにする22の静的検査を整え、生成器にも警告を失敗へ昇格させ、非推奨警告でも停止させた。HTML、CSS、JavaScript、Python、YAML、Markdown、Shell、綴り、秘密情報、リンクを検査する。さらに、両テーマの多層面の層数一致、写真表示幅が原画素の半分以内、私的なパス・ホスト名の非混入、3言語の文体、Markdown・代替プロトコル形式の存在など、汎用ツールにない固有規則も設けた。ignoreコメント、disable指定、フック回避、検出逃れの改名など、行内抑制と迂回を全面禁止した。既存の失敗も言い訳にせず、導入していない不備でも検出した回で修正することを、規則の実効性を保つ条件にした。

結果. コミット前に機械が定型的な異議を出し、このプロジェクト唯一のレビュー担当となった。コミットは遅く、出来の悪い検査への対応には強い苛立ちがあるという費用も隠さず記した。そのため後に、検査自体を整形・静的検査の対象にした。

  • ペン、書くこと、筆記
    写真: RoumanetD / Pixabay
  • チェックリスト、点検、確認
    写真: HeungSoon / Pixabay

この経験をお客様のプロジェクトに

「22静的検査のコミットゲートを構築」を、お客様の組織の似た課題を考える出発点にしてください。この実績を支えたサービスを、お客様のプロジェクトにも提供できます。 事業側の要望を開発可能な内容に変え、つくる価値がないものもはっきり伝えます。

サービスを見る お問い合わせ

結果の背景を確かめる

この事例の状況、判断、結果をご覧ください。どの部分がお客様の制約の下でも生かせるか、どこに別の方法が必要かをご相談いただけます。 22静的検査のコミットゲートを構築 — 22 1行で説明できる検査と詳述を要する5つの検査

サービスを見る お問い合わせ

より多くの実績の 一つです — そのすべてをこのサイトで公開しています。

どの項目も、状況、課題、実施内容、変化という同じ構成で記載しています。

すべての実績を見る

必要な改善を定める

必要な判断、影響を受ける人々、すでに検討した選択肢をお知らせください。選択に伴う利点と不利益を明確にし、推奨案を文書に残せます。

料金を見る お問い合わせ

コードのコミット前に基準を適用したいですか?

「22静的検査のコミットゲートを構築」の判断の背景についてお尋ねください。仕事内容を説明し、お客様のプロジェクトを検討できる担当者が対応します。

サービスを見る
welcome@engineer.company +45 50 10 61 84 デンマーク、コペンハーゲン
HTML、CSS、JavaScript、Python、YAML、Markdown、Shell、リンク、綴り、秘密情報、組版を対象に、1行で説明できる検査22個と詳しい説明が必要な検査5個からなるコミットゲートを構築し、警告扱いや行内抑制を認めない方針にした。のQRコード
このページを持ち歩くhttps://advisory.engineer.company/ja/portfolio/built-a-22-linter-commit-gate/