🚀

npm scriptを活用してZennの記事作成を迅速に始めたい

2023/01/15に公開約1,000字

はじめに

毎回Zenn記事を書き始めるときに同じ動作をしないといけないのがめんどくさいので npm script を利用して自動的に処理できるようにしました。

やること

私の運用では毎回記事毎にブランチを作成してそこで更新をしているので以下のアクションが必要になります。

  1. ブランチを作成
  2. Zenn CLIで新規記事を作成、Slugはブランチ名を指定
  3. 空コミットしてPush
  4. 作成した記事をVSCodeで開く

Script

出来上がったものはこちらです。

package.json
"scripts": {
    "prenewarticle": "git switch -c %npm_config_name%",
    "newarticle": "npx zenn new:article --slug %npm_config_name%",
    "postnewarticle": "git commit -m \"First Commit\" --allow-empty && git push origin %npm_config_name% && code articles/%npm_config_name%.md"
  }

コマンドは以下のように叩きます。

TERMINAL
npm run newarticle -name=<登録名>

Zenn CLIを利用して執筆記事のテンプレを作成するコマンドはこちらをご参照ください。
https://zenn.dev/zenn/articles/zenn-cli-guide#記事の作成

※登録名はSlugの命名規則に従います。
https://zenn.dev/zenn/articles/what-is-slug

補足

pre- post-スクリプトについて

npm scriptを設定するとき、スクリプト名に prepostを付与すると、対象スクリプトの前後に動作させるスクリプトを設定できます。
今回は、newarticleというスクリプトをメインにすえつつ、その前後にGitの操作を設定しています。

https://zenn.dev/ikuraikura/articles/bd76fba0539f7fe04703
https://www.twilio.com/ja/blog/npm-scripts-jp

Discussion

ログインするとコメントできます