古い記述の検出-jsチュートリアル-php.cn

ホームページ

ウェブフロントエンド

jsチュートリアル

古い記述の検出

WBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWB

Aug 22, 2024 pm 10:33 PM

Detection of Outdated Descriptions

開発者向けドキュメントには通常、各ファイルに説明が含まれています。この説明は古くなり、混乱や不正確な情報につながる可能性があります。これを防ぐには、AI と GenAIScript を少し使用して、ドキュメント内の古い説明の検出を自動化できます。

マークダウンとフロントマター

多くのドキュメントシステムは、マークダウン形式を使用してドキュメントを記述し、「frontmatter」ヘッダーを使用してメタデータを保存します。以下は、frontmatter を含むマークダウンファイルの例です:

---
title: "My Document"
description: "This is a sample document."
---

# My Document

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

ログイン後にコピー

目標は、フロントマターの説明フィールドが古くなったときを検出するスクリプトを作成することです。

スクリプト

GenAIScript はファイル上で実行することを目的としており、分析対象のファイルのリストを含む特別な変数 env.files を提供します。この変数を使用すると、def 関数を使用してファイルをコンテキストに含めることができます。大きなファイルのコンテンツの爆発を避けるために、各ファイルは 2000 トークンに制限されています。

// Define the file to be analyzed
def("DOCS", env.files, { endsWith: ".md", maxTokens: 2000 })

ログイン後にコピー

次のステップは、スクリプトにタスクを与えることです。この場合、フロントマターのコンテンツと説明フィールドが一致していることを確認します。

// Analyze the content to detect outdated descriptions
$`Check if the 'description' field in the front matter in DOCS is outdated.`

ログイン後にコピー

最後に、組み込みの診断生成機能を利用して、古い説明ごとにエラーを作成します。

// enable diagnostics generation
$`Generate an error for each outdated description.`

ログイン後にコピー

Visual Studio Codeで実行する

このスクリプトをワークスペースに保存すると、コンテキストメニューからファイルまたはフォルダーで実行できるようになります
GenAIScript を実行... を選択します。

オートメーション

CLI を使用して、ドキュメントファイルに対してこのツールを自動的に実行し、古い説明を特定できます。

npx --yes genaiscript run detect-outdated-descriptions **/*.md

ログイン後にコピー

このスクリプトを CI/CD パイプラインに統合して、検出プロセスを自動化できます。

以上が古い記述の検出の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

このウェブサイトの声明

この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。

ホットAIツール

ホットツール

ホットトピック

Gmailメールのログイン入り口はどこですか？

7360

Java チュートリアル

1628

CakePHP チュートリアル

1353

Laravel チュートリアル

1265

PHP チュートリアル

1214

Related knowledge

JavaScriptの文字列文字を交換します Mar 11, 2025 am 12:07 AM

JavaScript文字列置換法とFAQの詳細な説明この記事では、javaScriptの文字列文字を置き換える2つの方法について説明します：内部JavaScriptコードとWebページの内部HTML。 JavaScriptコード内の文字列を交換します最も直接的な方法は、置換（）メソッドを使用することです。 str = str.replace（ "find"、 "置換"）; この方法は、最初の一致のみを置き換えます。すべての一致を置き換えるには、正規表現を使用して、グローバルフラグGを追加します。 str = str.replace（/fi

カスタムGoogle検索APIセットアップチュートリアル Mar 04, 2025 am 01:06 AM

このチュートリアルでは、カスタムGoogle検索APIをブログまたはWebサイトに統合する方法を示し、標準のWordPressテーマ検索関数よりも洗練された検索エクスペリエンスを提供します。驚くほど簡単です！検索をyに制限することができます

8見事なjQueryページレイアウトプラグイン Mar 06, 2025 am 12:48 AM

楽なWebページレイアウトのためにjQueryを活用する：8本質的なプラグイン jQueryは、Webページのレイアウトを大幅に簡素化します。この記事では、プロセスを合理化する8つの強力なjQueryプラグイン、特に手動のウェブサイトの作成に役立ちます

独自のAjax Webアプリケーションを構築します Mar 09, 2025 am 12:11 AM

それで、あなたはここで、Ajaxと呼ばれるこのことについてすべてを学ぶ準備ができています。しかし、それは正確には何ですか？ Ajaxという用語は、動的でインタラクティブなWebコンテンツを作成するために使用されるテクノロジーのゆるいグループ化を指します。 Ajaxという用語は、もともとJesse Jによって造られました

＆＃x27; this＆＃x27; JavaScriptで？ Mar 04, 2025 am 01:15 AM

コアポイントこれは通常、メソッドを「所有」するオブジェクトを指しますが、関数がどのように呼び出されるかに依存します。現在のオブジェクトがない場合、これはグローバルオブジェクトを指します。 Webブラウザでは、ウィンドウで表されます。関数を呼び出すと、これはグローバルオブジェクトを維持しますが、オブジェクトコンストラクターまたはそのメソッドを呼び出すとき、これはオブジェクトのインスタンスを指します。 call（）、apply（）、bind（）などのメソッドを使用して、このコンテキストを変更できます。これらのメソッドは、与えられたこの値とパラメーターを使用して関数を呼び出します。 JavaScriptは優れたプログラミング言語です。数年前、この文はそうでした