textlint のルールを作って仕組みを理解した💪 - Qiita
この記事は 弁護士ドットコム Advent Calendar 2022 の 11 日目の記事です。 はじめに 皆さんは textlint を使っていますか？ ESLint を始めとした Linter は、ソースコードを静的解析してバグになりそうな記法やコーディングルールに則っていない部分を指摘・修正してくれます。 textlint は名前の通り text、つまりプレーンテキストや Markdown などの Linter です。 また、先日 Lint Night #1 という勉強会があり、そこで作者の azu さんが発表されていました。 自分は参加できなかったのですが、発表されていたスライドがあるので、こちらもぜひご覧ください！ 活用事例 弊社でも textlint を活用していて、Slack のチャットボット「凛さん」が稼働しています。 今年は 13 日担当の @shellme が、去年の
プログラマーに贈る、わかりやすい文章を書くための技法 - LIVESENSE ENGINEER BLOG
これは Livesense Advent Calendar 2022 DAY 8 の記事です。 転職ドラフトでエンジニアをしている verdy_266 です。 僕の2022年を振り返ると、採用広報チームでの活動を無視することはできません。転職ドラフトの開発を行う傍ら、昨年末に採用広報チームにジョインし、記事の執筆や校正に多くの時間を割いてきました。 今まで記事を投稿したことがなかったこちらのブログにも共作含め5記事を投稿し、11月には Software Design への寄稿の機会をいただくこともできました。文章を書くことが思った以上に好きなんだなと発見があった年でもありました。 made.livesense.co.jp made.livesense.co.jp made.livesense.co.jp made.livesense.co.jp made.livesense.co.jp 弊
Maintainer Month: なぜtextlintを作ったか
今では200以上のルールがある自然言語のLintツールであるtextlintがどのように作られたかを振り返る記事です。 6月はMaintainer MonthというイベントをGitHubが主催しています。 Maintainer Month is a reminder for the ecosystem to support, celebrate, and compensate open source maintainers. – Maintainer Month Maintainer Monthは、オープンソースのメンテナーが集まって情報共有したり、メンテナーを祝ったり、支援したりするイベントです。 メンテナーがどういうサポートを求めているかを知る、負荷が特定の箇所に集中するエコシステムはバランスが悪いのでそれを支援する方法を知るといったことを思い出すのがMaintainer Monthの
textlintへのルール追加に必要な正規表現を、やさしく解説してみた - SmartHR Tech Blog
こんにちは、UXライターのkunyです。3月にスケボーを始めて、最近チックタックができるようになりました。 さてSmartHRでは、textlintに独自のルールプリセットを追加して利用しています。ルールプリセットはオープンソースで公開しており、継続的にルールを追加しています。 さて、そのルール追加の際に正規表現の知識が必要なのですが、「正規表現、マジ難しい...」と感じています。「う〜ん」と唸りながらルールを追加することも多いです。 そこで自分の勉強も兼ねて、textlintへのルール追加の際に必要な「基本的な正規表現」を、実例とセットでまとめてみました。「ブログ書くぞ〜」と宣言したところ、少数ながらも「いいね」をいただき、需要あるかも？と思っています。感想やフィードバックを、Twitterでつぶやいていただけると嬉しいです。 textlintのルール作りに必要な正規表現、というタイトル
【GitHub Actions】Markdown 執筆に textlintの自動校正を取り入れる | DevelopersIO
背景 GitHub で Markdown 執筆活動 複数人で協力してドキュメントを執筆しています。 執筆の流れは下図のとおり。 執筆ブランチ を作成する 執筆ブランチ で執筆活動を行う mainブランチ にマージするための プルリクエスト を作成する プルリクエスト内でレビュー (必要に応じて修正) を行う 最後に mainブランチ へマージする (1. に戻る) 最低限 Git や GitHub 周りの操作を把握できたら、この方法は結構良いと感じています。 以下のようなメリットを享受できています。 テキストで情報を管理できる ( by Markdown ) バージョン管理ができる( by Git ) 文章レビューの流れを統一できる( by GitHub ) textlint で文章校正 さて、執筆活動において より良い文章 を書くために textlint を活用しています。 textli
文章校正を行うためのtextlint入門 - ICS MEDIA
ICS MEDIAでは読みやすい文章作りの取り組みとして、自社で公開しているVS Code拡張機能の「テキスト校正くん」を使用して文章校正を行っています。スタッフの校正ルールを統一して、一定の品質と読みやすさを確保することを心がけています。 「テキスト校正くん」は、文章校正エンジンにtextlintというNode.jsのパッケージを使用しています。textlintは設定した校正ルールにもとづいて文章校正を行えるので、プロジェクトに適切なルールを設定して文章校正ができます。以下の記事で、textlintの活用事例が紹介されています。企業がtextlintを導入し、文章品質を高めるワークフローとして活用されていることがうかがえます。 『textlintを使っている企業の事例・ルールをまとめてみた - Zenn』 『よりよい文書を書くための校正ツール「textlint」のSmartHR用ルールプ
「Visual Studio Code」で執筆するSF作家 藤井太洋氏が作る物書きのための拡張機能
「VS Code Meetup」は、強力かつ軽量なオープンソースのコードエディター「Visual Studio Code」のミートアップです。今年もVS Code Meetup 主催の年次カンファレンス、「VS Code Conference Japan 2021」が開催されました。招待講演では、SF作家の藤井太洋氏が登壇。VS Codeで執筆を支援する機能拡張「novel-writer」の制作について発表しました。 『Hello, World!』で吉川英治文学新人賞を受賞したSF作家 藤井：お時間いただきまして、ありがとうございます。本日、「Visual Studio Codeで小説を書く」というセッションを持たせていただく、SF作家の藤井太洋です。それでは、プレゼンテーションを進めます。 まず簡単な自己紹介から。私は、2012年に『Gene Mapper』というサイバーパンク小説をセル
textlintプロジェクトの現在地 - SmartHR Tech Blog
こんにちは、今年1年でキーボードを3回買い替えたUXライターのkunyです。今は、NiZのATOM 66を使っています。 SmartHRでは、textlintに独自のルールプリセットを追加して利用しています。textlintは4人で運用していますが、自分もメンバーの1人です。この記事では、textlintの便利さを世の中に伝えたく、textlintの利用シーンや利用者の生の声をご紹介します。 ※この記事は、2021年SmartHRアドベントカレンダーの13日目の記事です。 textlintの利用シーン 開発現場において、各自のローカル環境・GitHubと連携したCircleCIで文言の正誤を判定しています。 ローカル環境では、エディター上でコマンドを実行すると、「エラー内容」と「正しい表現」がわかります。コマンドで「正しい表現」に置き換えることもできますが、前後の文脈を確認しながら文言を修
textlintを導入してみて / Usage status and effects of the textlint
サーバーレスは死なぬ！みんなEDA(Event Driven Architecture)として使ってるでしょ？
広報業務をもっと楽にするため、textlintを導入した話 - Colorful Bullet
皆さんこんにちは！ Technology & Design DepartmentのDEVチーム所属の定吉です。 広報業務も担当してから記事を書く機会が増えました。ブレインストーミングから草稿やドキュメントチェックなど、一連のフローを通じて記事を公開するまでの労力って結構かかります。 特にドキュメントチェックは、単純な文字の誤りや表現を見るだけでなく、コンテンツ内容まで踏み込んで徹底した事実確認を行います。 そのため、「単純な文字の誤りや表現」をなくす作業はより正確かつスムーズに進めたい！そんな思いから、textlintという文章校正ツールを使い、ドキュメントチェックに取り入れてみました。 textlint とは textlintは、文章を書く場合の誤字脱字や読みづらい表現などを検知し、知らせてくれる校正ツールのことです。 例えば、「確かにそういったケースはない事はない。」や「それが事の発端
私のチームで行っているドキュメント管理方法の紹介(GitHub Actions, S3, AsciiDoc) | DevelopersIO
ドキュメントツールのインストール(Windows) Macの場合の設定方法は、本項の後に記載 PowerShellの起動 各種ツールをインストールするため、PowerShellを管理者として実行 Windowsボタンを押下 powershell と入力 右クリックで管理者として実行 を選択します Chocolateyのインストール 本手順は前述で起動したPowerShellを利用 1.Chocolatey のサイトにアクセスし、インストールコマンドをクリップボードへコピー 2.前項でコピーしたコマンドをPowerShellにペーストして実行します Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServiceP
textlintをWeb Workerとして動かしてアプリに組み込む - Bouldering & Com.
Web Workers APIを使うのは初めてなので、この使い方で問題ないのかはよくわかっていない。これから学んでいきます。 動機 会社でtextlintを便利に使っており、ユーザーさんからのお問い合わせ窓口を自社開発しているので、返信内容を送信前にlintにかけたいというのも自然な流れ。などと思っていたら、azuさんがこういうのを用意してくれていた。 textlint 12リリース、ブラウザで動くtextlint editorをベータリリース | Web Scratch GitHub - textlint/editor: textlint editor project. 内部での利用だからtextlintをサーバーで動かして結果を受け取るのでもいいけど、これのためにWebサーバーにNode.js入れて動かすのもなんかやりすぎ。かといってJobサーバーで動かす構成にするのはもっとやりすぎ。
textlint で日本語の文章を校正する方法 | fwywd（フュード）powered by キカガク
キカガクでは、社内に記述方法のガイドラインを設けており、誤字脱字のチェックなど、コンテンツ開発者とレビュアーが文章の校正を行っています。 参考：絶対に間違えたくない。括弧（かっこ）と句読点にある、たった１つのルール | fwywd（フュード） しかし、文章を隅々まで読んで、手動で校正をすると非常に大変です…。なんと textlint（読み方：テキストリント） というパッケージを使うと、ある程度、文章を自動で校正できます（超便利）
GitHub Actions + reviewdogでtextlintを実行する - ひよこまめ
この記事では、文章校正ツールであるtextlintのチェックでエラーになったときの結果を、GitHubのPull Requestへコメントする設定について説明します。 textlintはGitHub Actionsを使って実行し、reviewdogを使ってPull Requestへコメントします。 reviewdogはGitHub Actionsで使えるDockerベースのPublic reviewdog actionsを公開しています。 しかしtextlint用のactionsはないので、この記事ではワークフローの定義ファイルを自作します。 動作を確認した環境 GitHub Actions β版（YAML Syntax）reviewdog v0.9.13textlint v11.4.0GitHub Actionsのワークフローの作成 GitHub Actionsを設定するリポジトリを準備
よりよい文書を書くための校正ツール「textlint」のSmartHR用ルールプリセットを公開しました！｜SmartHRオープン社内報｜株式会社SmartHR
おつかれさまです。プロダクトデザイングループのこぎそ（@kgsi）です。みんなのデザインシステムことSmartHR Design Systemプロジェクトの一環として、より良い文書を書くための校正ルール「textlint（テキストリント）」のSmartHR用ルールプリセットをオープンソースで公開しました！ SmartHR用ルールプリセット公開の背景 SmartHRのバリューには「一語一句に手間ひまかける」と、SmartHR Design Systemのデザイン原則の中でも「言葉からはじまるデザイン」と表されていますが、改めて、SmartHRは「言葉」をとても大切にしている会社ですよね。 UXライティングチームを中心に、日々文言ガイドラインが整備され、SmartHRの扱う言葉は進化しています。整備対象は各部署共通で使う文言から、ヘルプページ、プロダクトで使う文言まで多岐にわたっています。 ▲
日本語エラーチェックサイトenno.jpを作った理由｜TechRacho by BPS株式会社
こんにちは、hachi8833です。はっと気がつくと、私が運営している日本語エラーチェックサイト「enno.jp」を開始してからもう8年が経過していましたので、たまには振り返ってみたいと思います。 サイト: 日本語の文章のタイポ/変換ミス/誤字脱字エラーをチェック/校正 | enno.jp enno.jpより 使い方はあきれるほど単純です。チェックしたい文章をフィールドに貼り付けてボタンを押すだけ。 enno.jpは、自分で作って自分で使い、自分で常にパターンを追加/更新しています。いわゆるドッグフーディングというヤツです。当然この記事もenno.jpでチェック・修正しました。 参考: ドッグフーディングとは:意味/解説 - シマウマ用語集 今年1月に突然enno.jpがバズッて自分でもびっくりしました。広めていただきありがとうございます🙇。 「外出自粛要請」が文章校正に引っかかってワロ
非エンジニアが文章校正のためにVSCodeとtextlintを導入するまでの記録
今年は文章校正の環境を整えられなかったことが大きな課題でした。いままで、秀丸のハイライト……はMacに乗り換えたのでお別れしたり、miを使って表記ルールを入れ込む……は用語統一を登録するので精一杯で実用的にはならなかったりといった具合で、なかなか「これ！」という校正・校閲環境に持って行けていませんでした。 そんなとき見つけたのがtextlintというもの。ATOKのような文章チェックをしてくれるものとイメージしてもらえたらよいかなと思います。 Markdown などのテキストファイルを特定のルールにしたがってチェックするツールです。 ルールは作者の azu さんを始め、多くのルールが公開されています。 （textlintとVSCodeで始める文章校正） で、textlintはVSCodeというエディタで動かせます。VSCode（Visual Studio Code）は、マイクロソフトが提供
GitHubの機能をフルに使って職務経歴書の継続的インテグレーションを実現する
GitHub で職務経歴書を公開 & 継続的に改善していく環境を作ったのでその紹介です。 リポジトリはこちらです。 kawamataryo/resume なぜ職務経歴書を？ 今のチームがとても好きなので転職の予定はないのですが、「安定しているときこそ職務経歴書をまとめておくべき。本当に職務経歴書が必要なときはメンタルが消耗していて書く余裕はない」という話を最近知り合いから聞き、それは確かにと思い書き初めました。どうせ書くなら何か面白いことをしたいなと GitHub に公開 & CI 環境の構築をやってみました。 機能紹介 🌐 GitHub Pages で Web ページとしての公開 Markdown + GitHub のファイルビューでも良いのですが、より見やすいほうが好ましいですよね。 GitHub の無料ホスティグ GitHub Pages を使って Web ページとして公開していま
ドキュメントの文章校正には、textlintが便利 - Cybozu Inside Out | サイボウズエンジニアのブログ
こんにちは！ 開発部 テクニカルコミュニケーションチーム（以下、TCチーム）の原嶋です。 さてさて。 みなさん、ドキュメントの文章校正（以下、校正）ってどんな風にやっていますか？ 目視チェックでバッチリだぜ！という方も もちろんいると思うのですが、チェックポイントが多いと指摘が漏れてしまいがちですよね。そして、会社の公式文書となれば、チェックポイントはあれもこれもと山のようになります。 TCチームでも長年 校正に頭をかかえていましたが、textlint と＋αのツール を使って、校正の悩みを解決しました。 今回はその経緯をお話させてください。 校正って確認する項目がたくさん TCチームでは、サイボウズ製品のユーザーサポートコンテンツ（ヘルプやリリースノートなど）を作成しているのですが、 それらのコンテンツは会社の公式文書なので、毎回の校正でチェックする項目が多々あるんです。 校正おわったー
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
「秀丸エディタ」がモダナイズ！ JavaScript対応マクロで可能性を切り開くv9.19が公開／プライベートモードにも対応
