qiita-cli

v1.0.4

Published

2 years ago

Downloads

0High
0Medium
0Low

antyuntyun

qiita-cli

qiita記事管理用のTypeScript製cli

紹介記事

https://qiita.com/antyuntyuntyun/items/278579fd60ecd85f6e4c

インストール

npm install -g qiita-cli

How to use

$ qiita --help

🐥 qiita cli

Command:
  qiita init                    qiitaとの接続設定. 初回のみ実行
  qiita pull:article            既に投稿している記事をローカルにpull(強制上書き)
  qiita new:article             新しい記事を追加
  qiita post:article            ローカルで新規作成した記事を選択的に投稿
  qiita patch:article           ローカルで修正した記事を選択的に投稿
  qiita delete:article(未実装)   選択した記事の削除
  qiita sync(未実装)             ローカルで作成/修正した記事の一括反映および投稿済み記事の取得
  qiita --version, -v           qiita-cliのバージョンを表示
  qiita --help, -h              ヘルプ

Remark:
  コマンドは全て作業フォルダのルートでの実行を想定したものになっています.
  記事の取得・投稿は作業フォルダはコマンド実行場所の作業フォルダ内のarticlesフォルダを基準に実行されます.
  (articlesフォルダはqiita init や qiit pull コマンドで生成されます)

開発環境設定

node仮想環境を用いて開発

# node仮想環境の用意
# ※anyenv: https://github.com/anyenv/anyenv
nodenv install 14.16.0
# パッケージインストール
npm install
# ビルド
npm run build
# package.jsonのbin記載コマンド'qiita'が使えるように
# シンボリックリンクを生成
npm link

VScodeによるホットロード

Ctr + Shift + B でwatch状態に設定可能(設定ファイル: .vscode/tasks.json)

リリースについて

mainブランチに対してのpushをフックにsemantic-releaseを導入している。 npm repositoryへのpublish, GitHubのタグとリリースを自動で生成。

参考: https://dev.classmethod.jp/articles/github-actions-semantic-release-sample/ https://zenn.dev/ucwork/articles/41cf2f20ecd2a0

コミットメッセージの制約

semantic-releaseのために, 以下のコミットメッセージの制約あり. (huskyが現状機能していないので、強制できていないが、強制の必要ないのでよしとする)

|コミットメッセージ|リリースタイプ|バージョン更新例| |:----|:----|:----| |fix(books): 書籍取得関数の取得件数の誤り修正|パッチリリース|v1.0.0 → v1.0.1| |feat(books): 書籍削除関数の追加|マイナーリリース|v1.0.0 → v1.1.0| |perf(books): 取得件数オプションを削除BREAKING CHANGE: これは破壊的変更です|メジャーリリース|v1.0.0 → v2.0.0|

ブランチのマージについて

gitflowに従い開発し、基本的にdevelopに対してはSquash Mergeで、 mainに対しては通常のコミットでマージすること。 developに対してのSquash Merge の際に、コミットメッセージがsemantic releaseが検知できるように、PRタイトルやコミットメッセージを適宜変更すること。

semantic release導入メモ

npm i -D semantic-release semantic-release-cli husky @commitlint/cli @commitlint/config-conventional
npm config get registry  
npx semantic-release-cli setup

参考

qiita api v2
https://qiita.com/api/v2/docs
cli作成参考記事
https://qiita.com/suzuki_sh/items/f3349efbfe1bdfc0c634
https://qiita.com/amay077/items/c19ab5304176326d584a
node-emoji一覧 https://raw.githubusercontent.com/omnidan/node-emoji/master/lib/emoji.json

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

qiita-cli

紹介記事

インストール

How to use

開発環境設定

VScodeによるホットロード

リリースについて

コミットメッセージの制約

ブランチのマージについて

semantic release導入メモ

参考