textlintへのルール追加に必要な正規表現を、やさしく解説してみた - SmartHR Tech Blog
こんにちは、UXライターのkunyです。3月にスケボーを始めて、最近チックタックができるようになりました。 さてSmartHRでは、textlintに独自のルールプリセットを追加して利用しています。ルールプリセットはオープンソースで公開しており、継続的にルールを追加しています。 さて、そのルール追加の際に正規表現の知識が必要なのですが、「正規表現、マジ難しい...」と感じています。「う〜ん」と唸りながらルールを追加することも多いです。 そこで自分の勉強も兼ねて、textlintへのルール追加の際に必要な「基本的な正規表現」を、実例とセットでまとめてみました。「ブログ書くぞ〜」と宣言したところ、少数ながらも「いいね」をいただき、需要あるかも？と思っています。感想やフィードバックを、Twitterでつぶやいていただけると嬉しいです。 textlintのルール作りに必要な正規表現、というタイトル
textlintの導入方法や使い方を確認してみた | DevelopersIO
textlintの導入 今回どのプロジェクトでも任意で使えるようにしたかったので、textlintをグローバルインストールする形で導入してみました。 textlintのインストール インストールコマンドは以下です。 $ npm i -g textlint ルールプリセットのインストール 次にルールのプリセットをインストールします。 今回は技術書向けのルールがまとまっているプリセットのtextlint-rule-preset-ja-technical-writingをインストールします。 インストールコマンドは以下です。 $ npm i -g textlint-rule-preset-ja-technical-writing ルールの適応方法 インストールしたルールの適応方法は以下の２通りあります。 textlintコマンドにオプションで使いたいルールを指定する。 .textlintrc.j
AWSサービス名のtypo削減用のtextlintルールとルール更新用のスクリプトを公開してみた（npmパッケージ） | DevelopersIO
こんにちは。AWS事業本部コンサルティング部に所属している今泉（@bun76235104）です。 みなさん技術ブログ書かれていますか？ 弊社では多くの社員が毎日とんでもない数のブログアウトプットをしています。 その中でもやはりAWS系のサービスに関する記事は多いです。 AWS系のサービス・プロダクトは非常に多く、微妙にtypoしてしまうことがありませんか？ 私はかなりあります。代表的な例だと以下のような形ですね。 OK: AWS Security Hub OK: Security Hub NG: Amazon Security Hub NG: SecurityHub 今回はこのような間違いに気づけるようにtextlintルールを作成するとともに、ルール更新を自動化できるようにスクリプトを組んでみました。 npmモジュールとしても公開して、できるだけ使いやすいようにいたしました。 なお、この
textlintのコアをTypeScriptで書き直した、textlintの今後について
textlint 9.0.0をリリースしました。 textlint 9.0.0では@textlint/kernelという内部的に使うコアモジュールをTypeScriptで書き直したバージョンが使われています。 元々textlintはNode.jsで動くように作られたため、fsモジュールなどNode.jsに依存しています。 そのため、ブラウザなどで動かす場合などはビルド時に色々工夫しないと動きません。 文書校正ツール textlint の Chrome 拡張を作った - もなでぃっく LocalStorageで誰でも安全にMarkdownでスライドやメモ作れるサービス作ったよ この問題をどうにかするためには、textlintというモジュールからロジックやLint処理部分だけをNode.jsなどに依存しない純粋なJavaScriptとして切り出す必要があります。 アドホックに対応するならブラウ
textlintとGitHubのCode Scanningを組み合わせてリンク切れをチェックする
textlintのルールに文章中のリンク先URLがアクセスできなくなってないかをチェックするtextlint-rule-no-dead-linkというルールがあります。 textlint-rule-no-dead-linkは実際にURLにリクエストを送ることでアクセスできるかをチェックするため、URLの数が多くなるとものすごく時間がかかります。 また、GitHubのように同一IPからのアクセスが連続すると429 too many requestsなどのエラーを返すサイトもあります。 textlint-rule-no-dead-linkはRetry-Afterヘッダを見てリトライにも対応していますが、このリトライの間隔が長いサイトもあるため、リンク切れのチェックはコミット時にやるのには向いてない作業と言えます。 GitHubでは、GitHub Actionsを使ってschedule実行に対応
入力支援ツール・textlintを導入したら、テキストコミュニケーションを磨く時間をたくさんかけられるようになった話｜BASE DESIGNER
入力支援ツール・textlintを導入したら、テキストコミュニケーションを磨く時間をたくさんかけられるようになった話 こんにちは。 Communication Design GroupのUXライター藤井です。 「ことばによるコミュニケーション」領域を担当しています。 UXライターが担う役割としては、直接的、間接的を問わず、あらゆるタッチポイントにおけるテキストコミュニケーションの体験をデザインすること。 前者はBASEの管理画面やメール、LPなどプロダクトすべてのタッチポイント、後者はイベントや営業資料をはじめとする、間接的なBASEとのタッチポイントが挙げられます。 では、具体的にはどんな業務をおこなっているかというと、「テキストコミュニケーションをデザインする」をキーワードに、デザインシステムの一環として「運用ガイドライン」「用語リスト」を作成、タッチポイントごとに担当を分け、最終レビ
【GitHub Actions 小ネタ】プルリクエスト時に差分ファイルの一覧を取得する | DevelopersIO
GitHub Actionsを使って、 プルリクエスト作成時(もしくは commit push時)に ベースブランチからの差分ファイルを取得したいです。 例えば base:main ← compare:fix のプルリクエストを作成したとします。 このとき mainブランチとfixブランチの差分ファイル一覧を取得、 差分ファイルに対して Lintを行う、といったことを実現したいです。 以下にそれを実現するワークフローのテンプレート、および活用例を書いてみました。 テンプレート name: run-actions-using-diff-files on: pull_request: types: [opened, synchronize, reopened] branches: [ main ] paths: [ 'docs/**.md' ] env: base_branch: main d
GitHub ActionsでZennブログの校正を自動化してみた
序論 前回の記事でも紹介したとおり、ZennはGitHubリポジトリと連携すると、自分の好きなエディタで記事を書くことができます。 ほかにもGitHubと連携することでCIツールを導入でき、記事作成の助けにもなります。 そこで今回GitHub Actionsとtextlint、reviewdogを使いPRするたびに自動でドキュメント校正をしてくれるCI環境を構築してみました。 対象読者 zennでブログを書く人 文章の校正の手間を減らしたい人 zennとGitHubが連携済み ドキュメント校正ツール 今回GitHub Actionsに組み込む校正ツールはこちらになります。 textlint reviewdog textlint textlintはMarkdownやプレーンテキスト形式のファイルを校正してくれるJavaScript製のOSSです。 textlintはデフォルトルールというもの
textlintで表記ゆれチェックルール集を一部無視する設定 | DevelopersIO
ひらがなを提案される部分を漢字で書きたい場合を想定しました。 表記ゆれのルールファイル（今回はWEB+DB_PRESS.yml）では、「期待する正規表現」がexpected、「表記ゆれの正規表現」がpatternにあたります。 以下が無視の設定をしていないprh.yaml例です。 prh.yaml version: 1 imports: - path: ./node_modules/prh/prh-rules/media/WEB+DB_PRESS.yml disableImports: true 無視設定を書く importsでインポートするルールの中から無視したいものは、ignoreRulesで指定します。 指定方法は2種類あり、無視したいルールのexpectedかpatternを書きます。 ここで1つ注意です。 表記ゆれのルールファイル（今回はWEB+DB_PRESS.yml）で書かれ
textlint editor を使ってブラウザで textlint を使う - アクトインディ開発者ブログ
morishitaです。 久しぶりに文章校正ツール textlint について書きます。 textlint については過去に２回取り上げました。 tech.actindi.net tech.actindi.net 過去のエントリはテキストエディタから利用する方法を紹介したものですが、今回は textlint のブラウザ拡張について紹介します。 以前からブラウザ上で文章を書くときにも textlint を使いたいなぁと思っていました。 結構前からtextlint: 文章チェッカーという Chrome 拡張があるのですが、自由にルールを設定できないようだったので見送っていました1。 今回紹介するものは textlint の作者自身が開発した拡張で、独自の設定で利用できるものです！ インストールから使えるところまで 早速使う準備をしていきましょう。 ブラウザ拡張のインストール Chrome と
VS Codeにtextlintで自動校正(macOS) - ヤマムギ
今年から執筆環境をVS Codeに変えました。 VS Codeが軽量との噂があったのと、textlintを使ってみたかったからです。 環境 MacBook Pro (13-inch, M1, 2020) macOS Big Sur 11.5.2 node v16.14.0 npm 8.3.1 textlintのインストールと設定 執筆するファイルを保存するディレクトリを作成して、そこで作業をしました。 参考にしたのはこちらtextlint と VS Code で始める文章校正です。 npm init -y npm install --save-dev \ textlint \ textlint-rule-preset-ja-spacing \ textlint-rule-preset-ja-technical-writing \ textlint-rule-spellcheck-tech-
VS Codeで執筆環境を整えるメモ - Sweet Escape
自分メモです。 Visual Studio Codeで記事や書籍等を執筆するにあたっての環境を久しぶりに整えようと思ったのでせっかくならまとめておこうと思います。 vscode-textlint vscode-textlint は著名なテキスト校正ツールであるtextlintをVS Code上から実行するためのプラグイン。僕の場合はMarkdown形式で文章を書くことが多いんだけど、その校正をVS Code上でできるようになります。もちろんテキストファイルもOK。 なお、このプラグインを使うには事前にtextlintをOS側でインストールしておく必要があります。 ただ、OSの環境を汚したくないという人向けにここではRemote Containersの環境で利用することにしていきます。 といっても普通にRemote Containersで使うための環境を用意するだけです。ここではシンプルにN
オープンソースドキュメント翻訳プラットフォームとしての GitHub (React 日本語ドキュメントの例)
はじめに ひょんなことから React 公式ドキュメント日本語版のメンテナをやらせていただいています smikitky です。 この記事は、React 公式ドキュメントの翻訳作業が GitHub ベースでどのように行われているのかを解説したものです。ドキュメントの翻訳には色々な方法がありますが、React の現アプローチは非常に上手く行っていると個人的に考えています。部分的には似たアプローチを説明している既存記事も探せばありますが、少し詳しめに書くことで事前の不安を取り除き、「思ったより簡単そうだから、自分もあのライブラリのドキュメント翻訳をやってオープンソースに貢献してみよう」と思えるようになることを目標にしています。 想定読者は Git、GitHub、Markdown（ないし類似の軽量マークアップ言語）、および基本的な HTML の仕組みがわかる開発者です。何らかの静的サイトジェネレー
textlint + prhで文章を校正する方法 - Qiita
textlintとprhを用いて、文章を校正する方法を紹介します。 textlintとは textlintは、自然言語の校正に特化したNode.js製の文章校正ツールです。 JavaScriptを書いている人には、「ESLintのテキスト版」と言えば分かりやすいでしょうか。 ESLint同様プラガブルな仕組みになっており、様々なルールを組み合わせて使用します。 コマンドライン上で実行することもできますが、AtomやVisual Studio Codeなどのエディタ上で動かすこともできます。 prhとは prhは、表記ゆれの修正に特化したNode.js製の文章校正ツールです。 textlintのルールにも表記ゆれのためのものはありますが、prhではYAMLファイルで辞書を柔軟に管理できます。 単体で実行することもできますが、textlintのルールの一つとして動かすこともできます。 環境構築
textlintで特定のルールのエラーを無視する - Qiita
textlintにはさまざまなルールがありますが、特定の行や場所においてはルールを無効化したい場合があります。 例えば、asciidwango/js-primer: JavaScriptの入門書という書籍では、表記揺れを防止するためにtextlint-rule-prhというルールを使っています。 この書籍では、匿名関数と無名関数の表記揺れを防止するために匿名関数へ統一する辞書が入っています。 しかし、どちらもよく使われる単語なので、「この書籍では無名関数の事を匿名関数と呼ぶ」という言及が必要です。 このように関数式では、名前を持たない関数を変数に代入できます。 このような名前を持たない関数を匿名関数（または無名関数）と呼びます。 https://asciidwango.github.io/js-primer/basic/function-declaration/より この時、この部分だけは
社員用に作った文書校正ツールを一般公開した - gecko655のブログ
スクリーンショット これはなに 会社で「PR用の文章を人力でチェックする工数が重くて、めっちゃ残業が発生している。なんとか自動化できないか」との依頼を受け、Word等のファイルをGUIでそのままtextlintできるツールをちゃちゃっと作って社内公開しました。その結果、いい感じに社内で有効利用してもらうことができたので、外部公開に踏み切ることにしました。 github.com インストール＆設定 1. インストーラーでツールをインストールする GitHub上で配布しています。 https://github.com/gecko655/proofreading-tool/releases Mac版で「開発元が未確認のため開けません」が出た方へ https://support.apple.com/ja-jp/guide/mac-help/mh40616/mac を参考に、アプリケーションをセキュ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
textlint - Linterの作り方
Vimで快適に記事を書くため環境
GitHub - gecko655/proofreading-tool: GUIで動作する文書校正ツール GUI tool for textlinting.
textlint 欲しいスペース関係のルール