Pengesanan Perihalan Lapuk

Dokumentasi pembangun biasanya termasuk penerangan dalam setiap fail. Perihalan ini boleh menjadi lapuk, membawa kepada kekeliruan dan maklumat yang salah. Untuk mengelakkan ini, anda boleh mengautomasikan pengesanan perihalan lapuk dalam dokumentasi anda menggunakan sedikit AI dan GenAIScript.

Markdown dan frontmatter

Banyak sistem dokumentasi menggunakan format markdown untuk menulis dokumentasi dan pengepala 'frontmatter' untuk menyimpan metadata. Berikut ialah contoh fail markdown dengan frontmatter:

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

# My Document

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Matlamatnya adalah untuk mencipta skrip yang mengesan apabila medan penerangan dalam frontmatter sudah lapuk.

Skrip

GenAIScript bertujuan untuk dijalankan pada fail dan menyediakan env.files pembolehubah khas yang mengandungi senarai fail untuk dianalisis. Anda boleh menggunakan pembolehubah ini untuk memasukkan fail dalam konteks menggunakan fungsi def. Kami mengehadkan setiap fail kepada 2000 token untuk mengelakkan kandungan meletup pada fail besar.

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

Langkah seterusnya ialah memberikan tugasan kepada skrip. Dalam kes ini, pastikan medan kandungan dan huraian dalam frontmatter sepadan.

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

Akhir sekali, kami memanfaatkan ciri penjanaan diagnostik terbina dalam untuk membuat ralat bagi setiap penerangan yang sudah lapuk.

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

Berjalan dalam Kod Visual Studio

Sebaik sahaja anda menyimpan skrip ini dalam ruang kerja anda, anda akan dapat melaksanakannya pada fail atau folder melalui menu konteks
dengan memilih Jalankan GenAIScript....

Automasi

Anda boleh menjalankan alat ini secara automatik pada fail dokumentasi anda untuk mengenal pasti perihalan lapuk menggunakan cli.

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

Skrip ini boleh disepadukan ke dalam saluran paip CI/CD anda untuk mengautomasikan proses pengesanan.

Atas ialah kandungan terperinci Pengesanan Perihalan Lapuk. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!