@openameba/textlint-rule-preset-ameba
v0.5.1
Published
textlint rule preset for Ameba
Downloads
1,616
Keywords
Readme
textlint-rule-preset-ameba
Amebaで利用するtextlintルールプリセットです。以下の目的で利用しています。
- 表記ゆれを修正するため
- わかりやすい日本語にするため
- 複数人により書かれた文章を、統一された基準で校正するため
ルールの詳細は設定ファイルをご覧ください。
Installation
npm install --save-dev @openameba/textlint-rule-preset-ameba
or
yarn add --dev @openameba/textlint-rule-preset-ameba
Usage
CLI、Node module、エディタ内など様々な方法で利用できます。利用方法の詳細はtextlintをご覧ください。
.textlintrc
{
"rules": {
"@openameba/preset-ameba": true
}
}
Allow List
Release v0.5.0よりAmebaのVisionにある「つくる、つむぐ、つづく、」が追加されました。 textlintでは読点の最大数を設定しており、バリデーションから除外すること推奨しています。
利用者側で下記のように.textlintrc
を拡張してください。
{
"rules": {},
"filters": {
"allowlist": {
"allowlistConfigPaths": [
"./node_modules/@openameba/textlint-rule-preset-ameba/lib/allow-ameba.yml"
]
}
}
}
Release
- リリース対象の成果物を
main
ブランチにマージします - GitHub Actionsのversioning
- 「Run workflow」からアップデートするバージョンを記載のジョブを実行
- package.jsonのversionがアップデートされ自動的にPull requestが作成されます
- バージョンアップのPull requestを
main
ブランチにマージ
- GitHub Actionsのpublishより「dry run」にチェックを入れた状態でジョブを実行
- 「dry run」のジョブが成功したら「dry run」のチェックボックスを外してジョブを実行
- リリースが完了したらReleasesの「Draft a new release」からリリースノートを作成しましょう
- 対象のリリースバージョンを選択後、「Generate release notes」ボタンを押して「Publish release」します
- リリース作業完了となります