textlint-rule-aws-service-name はAWSサービス名のtypoを予防するためのtextlintルールです。
このパッケージの開発において、いくつか制約やルールを設けていますので、コントリビューターの皆様は事前にご確認下さい。
このプロジェクトにはsemantic-release/semantic-releaseを導入して、各種リリース作業の効率化を図っています。
semantic-releaseの制約上、コミットメッセージにはConventional Commitsを利用する必要があります。
このリポジトリには、husky と commitlint を導入して、コミットメッセージをConventional Commitsの形式に合うかチェックする仕組みを導入しています。
コミットメッセージは次の規約に準拠します。
commitlint/@commitlint/config-conventional
コミットメッセージのフォーマットは以下のように規定しています。
<type>[optional scope]: <subject>
[optional body]
[optional footer(s)]
type, subjectは必須です。
新規機能追加に伴う変更
feat: 不要なスペースの混入を検知するルールクラス追加
コメントの追加やコードに影響を与えない変更など
chore: RuleFileクラスにdocstringを追加
バグ修正など
fx: アッパーキャメルケースのルールが機能しないバグの修正
src/index.js を実行することにより、auto-create-regular-rules.ymlに記載するルールに照らし合わせてチェックします。
チェックの仕組みは以下モジュールの仕組みを利用しており、実際に以下モジュールに提供するためのprh用のymlファイルを動的に作成することです。
https://github.com/textlint-rule/textlint-rule-prh
ymlを作成するためのクラス構成などについては以下をご確認下さい。
auto-create-regular-rules.ymlは src/*.ts に記載するスクリプトで更新（ファイルがなければ作成）されます。
全体の処理概要は以下のようなフローとなっています。
flowchart TD
AwsApi("AWSの公開APIからサービス名の一覧を取得")
--> AwsServices("必要な情報のみ抽出")
--> Rule("prh用の個々のルールを作成")
--> Rules("個々のルールをつなぎ合わせる")
--> RuleFile("ymlファイルとして出力")
以下のように関心ごとにクラスを分けて、基本的に継承を使わずに実装しています。
厳密に言えば、createRule.ts内でそれぞれのクラスインスタンスを作成して、処理を呼び出しています。
classDiagram
RuleFile *-- Rules
Rules *-- Rule
Rule *-- AwsServices
AwsServices *-- AwsApi
APIはこちらのJSONフィードを利用しています。
https://aws.amazon.com/api/dirs/items/search?item.directoryId=whats-new