フロントエンド開発にtextlintを導入して運用している話 2021.07.13 Tue. SaaSプロダクトのフロントエンド最前線@オンライン 近藤 大介 @diescake SmartHR プロダクトエンジニア ／年末調整チーム／主にWebフロントエンド（React + TypeScr…

【終了しました】Slackbotで簡単に「textlint」が使えるようになりました！｜SmartHRオープン社内報 ※2021年 11月 2日追記 textlint自体がプロダクトの過半数に導入されたことで一定の成果を出したことと、利用頻度、運用コストを加味した結果、Slackbotでの運用は2021年11月2日に終了しました。 おつかれさまです。プロダクトデザイングループのこぎそ（@kgsi）です。 より良い文書を書くための校正ルール「textlint（テキストリント）」のSmartHR用ルールプリセットをオープンソースで公開して約1ヶ月経ちましたが、エクステンドなサービスとして、誰でも簡単に「textlint」を実行できるSlackbotを2021年4月にリリースしました！ Slackbotの正式名は「須磨 倫子（すま りんこ）」さんです。 Slackbotの開発背景 「textli

スクリーンショット これはなに 会社で「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 を参考に、アプリケーションをセキュ

こんにちは、かたいなかです。 最近、ちょっとしたドキュメントのリポジトリに対して、textlintをかけたいと思うことがありました。しかし、textlintのためだけにCIツールを設定するとなると少し面倒だなとも感じました。 そんなとき、GitHub Actionsを使用するとリポジトリに設定ファイルを設置するだけで処理が実行できることを思い出しました。 そこで今回は、現在ベータのGitHub Actionsを使用してtextlintを実行する構成を試してみました。 GitHub Actionsは現在ベータです。 手順 GitHub ActionsのBetaにSign up GitHub ActionsはまだBetaなのでそのままで使用することはできません。 以下のリンクよりベータにサインアップし、アカウントで有効化されるまで待ちます。 https://github.com/feature

概要 技術書典でRe:VIEWを使っていたものの、文章を書き、textlintを回すというCI環境を整えることができませんでした。また、このCI環境は、ブログ執筆においても有効であるため、このタイミングで構築することにしました。 今回はRe:VIEWで書いた文章の校正をCircleCIとtextlintでGitHubのPRに自動コメントする仕組みを作ったのでその紹介をします。 概要 仕様🖋 構築手順👨‍💻 textlintの導入 CircleCIの設定 .circleci/config.yml textlintの実行とGitHubのPRヘコメント GitHubのアクセストークンを取得 GitHubのアクセストークンをCircleCIに設定 .circleci/review-textlint.sh 動作確認🚨 CircleCIの確認 GitHubのPRコメントの確認 まとめ✨ 仕様

文章の校正チェックを自動で行うVisual Studio Codeの拡張機能「テキスト校正くん」を弊社からリリースしました。無料で利用できます。 テキスト校正くん – Visual Studio Marketplace 短い文章であれば目視でもチェックできますが、長文になるとチェックに時間がかかり見落としも多くなってしまいます。また、いくら内容のいい文章を書いても誤字や脱字が多く体裁が整っていないと、印象が悪く読みづらい文章になってしまいます。 そんなとき、「テキスト校正くん」を利用することで、文章チェックの手間を軽減でき、文章の品質を高めることができます。 ▲VS Codeの拡張機能「テキスト校正くん」 「テキスト校正くん」でできること この拡張機能は、VS CodeでテキストファイルやMarkdownファイル等の日本語の文章をチェックします。編集時に自動で校正のチェックを行い、エディタ

人間性をさがせよ QiitaのTypo検出 - Qiita にtextlintを追加しました。 まとめ textlintの追加は簡単だった ほんのり(優しく)チェックできるtextlintプラグインを探さなければならない ホワイトリスト機能を改善してもらった textlintに引っかかる投稿はそこそこある 誤判定は割と出る。が、一部は慣れでスルーできる 編集リクエストは一つにまとめて送信する 編集リクエストが採用されなくても泣かない 追加コード 人間性をさがせよ QiitaのTypo検出 - Qiita のコードを見ていないとなんのこっちゃですが、diffで表示します。 --- a/index.js +++ b/index.js @@ -4,6 +4,9 @@ const axios = require('axios'); const DICTIONARY = require('./dic

danger-textlintというdangerのプラグインを公開しました！今回はその紹介エントリです。 RubyGems: https://rubygems.org/gems/danger-textlint Github: https://github.com/Kesin11/danger-textlint dangerについて そもそもdanger自体の知名度がまだまだだと思うので簡単に紹介したいと思います。 dangerはpull requestのコードレビューを助けるためのツールです。 dangerはpull requestのデータにrubyから簡単にアクセスするためのインターフェースと、pull requestにコメントするためのインターフェースを提供してくれます。 例えばdangerを使うとタイトルに[WIP]が含まれる場合は警告のコメントを出してマージできないようにする、とい

SkyWayとWebRTC開発者コミュニティ4年間の軌跡とCMC_Meetupで学んだこと、実践したこと

textlintにはさまざまなルールがありますが、特定の行や場所においてはルールを無効化したい場合があります。 例えば、asciidwango/js-primer: JavaScriptの入門書という書籍では、表記揺れを防止するためにtextlint-rule-prhというルールを使っています。 この書籍では、匿名関数と無名関数の表記揺れを防止するために匿名関数へ統一する辞書が入っています。 しかし、どちらもよく使われる単語なので、「この書籍では無名関数の事を匿名関数と呼ぶ」という言及が必要です。 このように関数式では、名前を持たない関数を変数に代入できます。 このような名前を持たない関数を匿名関数（または無名関数）と呼びます。 https://asciidwango.github.io/js-primer/basic/function-declaration/より この時、この部分だけは

最近のアップデート Cloud Automator のアップデートでログイン中の操作画面にマニュアルのリンクが表示されるようになりました。 blog.serverworks.co.jp もちろんマニュアルだけでも閲覧できますので、気になった方は無料トライアルでCloud Automator を試してみてください。 Cloud Automator – 株式会社サーバーワークス サポートページ https://support.serverworks.co.jp/hc/ja/categories/115001305127 cloudautomator.com ドキュメントを充実させるには ドキュメントを充実させていくには、地道に書いていくしかないわけで・・・Cloud Automator についても開発メンバーで分担しながら作っています。 その際ちょっと気になってくるのが表記のゆれです。 これは

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert

こんにちは、Androidエンジニアの堀江です。最近はiOSのプロジェクトに参加してSwiftを書いています。新しいことを始めるのは楽しいですね。 ところで今ご覧になられている弊社の技術ブログ「VASILY DEVELOPERS BLOG」は、VASILYのエンジニアが交代で更新しています。記事に何を書くかは各エンジニアの裁量に任されていますが、公開前に社内でレビューをするようにしています。 レビューをする際には、以下のような点に注意しています。 誤字脱字・文法上の間違いが無いか 間違った情報が無いか 文章中にわかりにくい表現や解説が無いか このうち、誤字脱字・文法上の間違いは、文章校正ツールを使うことで機械的にチェックすることが可能です。それによって、文章そのもののより本質的なレビューに時間を割くことができます。記事はレビュー前に文章校正済みであるのが理想ですが、実際には忘れる事も多いで

こんにちは。フロントエンドエンジニアのほりでーです。 Web関係のお仕事をされている方のなかには、業務のノウハウを自社のブログや個人のサイト、はてなやQiitaなどのブログサービスを通じて発信されている方も多いでしょう。私もLIGブログへ載せるには敷居の高いネタはQiitaへ投稿することが多いです。しかし、推敲が苦手なので自分のあまりの誤字脱字の多さに辟易してしまうことがあります。 エンジニアにとっての国語のライティングは、技術記事の執筆以外においても案外重要なスキルです。要件定義書、仕様書、環境構築手順書、Wiki、README、コミットログ、チケット、バグレポートなど、コード以外にもエンジニアが書くべきドキュメントはたくさんあります。 こういった日本語のライティングを強力にサポートしてくれるのがtextlint（テキストリント）という校正支援ツールです。 今回はこのtextlintとT

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert

こんにちは！ 新オフィスに移転してから毎日2缶ドクターペッパーを買うのが習慣化してきた @fortkle です。 今回はSlackで簡単に文字校正ができるBotを作ってみたのでご紹介したいと思います。 手軽に校正したい メールやチャットだけでなく、こういったブログやissueに書く仕様など「文章を書く」シーンはたくさんあると思います。 そんなとき自分が伝えたいことを相手にちゃんと伝えることができれば良いのですが、良い文章を書くのはなかなか難しく、今も試行錯誤しています。 そこで、相手に伝えたいことがちゃんと伝わる良い文章を書くためにSlack上で簡単に試せる文字校正Botを作ってみました。 成果物 実際に見たほうが早いと思うので画像を交えてご紹介します。 例として以下の文章をチェックしてみたいと思います。 この文章はご存知の通り、ダミーテキストです ヽ(^o^)丿 そして、様々な、ｴﾗｰﾁ

この記事は、textlintのチェックでエラーとなった結果を、Pull Requestのレビューコメントとして書く設定をする手順をまとめたものです。 textlintを使っているCI環境に数行追加する程度で、次のようにPull Requestのコメントに指摘内容が自動で書き込めるようになります。 reviewdogを使うことで、CIからレビューコメントとしてLintの結果を書き込むことができます。 CIでLintがエラーとなった場合、CIの画面までエラーを見に行く必要があって面倒です。 reviewdogを使うことで、PRの画面上にLintのエラーが表示されるので手間が省けて便利です。 基本的には次の記事と同様です。 textlintをTravis CIで動かして継続的に文章をチェックする - Qiita Travis CIでtextlintの指摘をPull Requestのレビューコメン