Skip to content

README.md

Latest commit

 

History

History
66 lines (49 loc) · 2.68 KB

README.md

File metadata and controls

66 lines (49 loc) · 2.68 KB

JSer.info Prompt

このプロジェクトは、JSer.infoのスタイルに従った記事やライブラリの紹介文を生成するためのプロンプトを提供します。

プロジェクト構成

  • data/ ディレクトリ: 各記事やライブラリの紹介文を保存するMarkdownファイルが含まれています。
  • README.md: プロジェクトの概要と使い方を説明します。

使い方

  1. URLの指定

    • data/ディレクトリ内のMarkdownファイルに、紹介したい記事やライブラリのURLを記載します。

  2. プロンプトの実行

    • 指定されたURLに基づいて、JSer.info形式の紹介文を生成します。

  3. 生成された紹介文の確認

    • チャット欄に生成された紹介文が表示されます。
    • 必要に応じて、data/ディレクトリ内の該当ファイルに追記されます。

手元での操作方法

  1. 新しい記事ファイルの作成

    • 以下のコマンドを実行して、新しい記事ファイルを作成します。 
      query="記事やライブラリのURL"
workingDir="$HOME/ghq/github.com/jser/jser-info-prompt"
scrapDir="$HOME/ghq/github.com/jser/jser-info-prompt/data"
defaultFileName="$(date +%Y-%m-%d--%H-%M-%S).md"
touch "${scrapDir}/${defaultFileName}"
echo "${query}" > "${scrapDir}/${defaultFileName}"
/local/bin/code-insiders --new-window "${workingDir}" --goto "${scrapDir}/${defaultFileName}"
    • queryには紹介したい記事やライブラリのURLを指定してください。

  2. VSCodeでのプロンプト実行

    • 上記コマンドで開いたVSCodeで、/jser-info-article promptを実行します。
    • 必要に応じて生成された紹介文を確認し、編集します。

注意事項

  • 紹介文はJSer.infoのスタイルガイドに従って生成されます。
  • 嘘や誇張、不正確な内容を避け、事実に基づいた簡潔な説明文を提供します。
  • リリースノートの場合、主な変更点を箇条書きで要約します。

スタイルガイド

  • 一行目に概要、二行目以降に詳細を書く。
  • Markdown形式を使用可能。
  • 専門用語は正確に使用する。
  • センテンス間は。で区切る。
  • Majorな変更、Minorな変更、Bugfixの順に記載する。

例

ライブラリのリリースノート

React v18.3.0リリース。  
React 19での変更予定の機能に対してDeprecatedの警告を出す実装が追加されている。

技術記事

TypeScriptの型チェックのパフォーマンスチェックと改善について