Denoで完結させるZennの記事管理
Zennへ連携可能なGitHubリポジトリが実は2個まで設定可能ということをつい最近知ったので、
検証を兼ねてタイトル通りDenoを中心に編集環境を準備します。
環境
Zenn-CLI
Denoはnpmパッケージの直接利用がサポートされているので、
deno run npm:XXXコマンドを実行すると、XXXというNPMパッケージを確保して実行してくれます。
#!/bin/sh
exec deno run \
--allow-env \
--allow-net \
--allow-read \
--allow-sys \
--allow-write \
npm:zenn-cli $@
--allow-XXX系オプションは、最初はプロンプトに従いつつ、よしなに付与していきます。
Textlint
Zenn-CLIのときと同様に、Denoのソース内にもNPMパッケージを指定可能です。
そのため、telixtint本体と使用プラグインをすべてインポートして実行するスクリプトを用意することで、
Denoランタイムでtextlintを実行することが出来ます。 [3] [4]
#!/usr/bin/env -S deno run --allow-read --allow-env
/**
* textlint by Deno
*
* Original source from https://github.com/kn1cht/run-textlint-on-deno/
*/
// Textlint本体から、エンジンだけ利用
import { TextLintEngine } from "npm:textlint";
// プラグインのロード（ダウンロードさせるのが主目的なので、importのみで良い）
import "npm:textlint-rule-preset-ja-technical-writing";
import "npm:textlint-filter-rule-comments";
// ここから実行本体。
const engine = new TextLintEngine();
const results = await engine.executeOnFiles(Deno.args);
if (engine.isErrorResults(results)) {
console.error(engine.formatResults(results));
Deno.exit(1);
}
意識的に設定しているのはshebangの構成でしょうか。
#/usr/bin/env denoでも動きますが、これだと--allow-XXXを設定できません。
そこでenvのオプションである-Sを利用して、サブコマンドやオプションをまるごと指定しています。
{
"rules": {
"preset-ja-technical-writing": true,
"ja-technical-writing/no-exclamation-question-mark": false,
"ja-technical-writing/ja-no-mixed-period": {
"allowPeriodMarks": [
":::"
],
}
},
"filters": {
"comments": true
}
}
textlintの設定自体は、Node.jsで実行するときのものと変わりません。
構成上の理由からpackage.jsonが存在しないため、下記の点に注意する必要があります。
- 使用するプラグインは、
bin/textlint内で直接宣言する。 - ルールファイルはpackage.jsonに書けない。
(Optional) pre-commitでtextlint
Node.jsプロジェクトでpre-commitタイミングに何かをしたいときは、huskyを使うことがあります。
しかし、このプロジェクトは「Denoランタイムを利用するからpackage.jsonがない」「特定プログラムではなくあくまで記事管理」という点から、pre-commitを採用しています。
repos:
- repo: local
hooks:
- id: textlint
name: Lint writing-texts
language: script
files: '.+\.md'
entry: ./bin/textlint
一般的なpre-commitの利用法では、repoにリポジトリURLを指定して設定のみを記述します。
今回はローカルのtextlintを実行したいので、上記コードで次のように設定しています。
-
repo: localでこのリポジトリ自体をpre-commitのフック置き場と判定させる。 -
entry: ./bin/textlintでtextlintを実行させる。
GitHub Actions
この記事の編集時点ではPrivateリポジトリで管理+pre-commitを導入しているため、GitHub Actionsは基本的に不要です。
とはいえ、「別端末でpre-commitのセットアップを忘れた」「Publicリポジトリ化してからPRもらったときに検査したい」というシーンを考えると、用意したほうが無難でしょう。
幸い、Denoはdenoland側でSetupアクションを公開しているので、非常に少ない作業で「push時に全ファイルのtextlintチェック」を導入できます。
name: Run textlint for all contents
on: push
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: denoland/setup-deno@v1
- name: Run textlint
run: bin/textlint articles books
おわり
これで、記事執筆の基本的な環境整備が完了です。
好みの差はありますが、Denoランタイムによる「個別ワークスペースごとにモジュール管理しなくて良い」というポイントはリポジトリの見た目がスッキリして嬉しいです。
Discussion