dsh-ensp 0.5.0 → 0.5.1

package/README.en.md

@@ -137,7 +137,7 @@ ensp preset ospf-lsa-types          # the detail ends with a knowledge section
 ensp preset --knowledge LSA         # search the index by keyword
 ```
 
-The points come from a certification question bank, re-filed by topic. The bank's own tags are unreliable, so a question about OSPF LSA types can also carry a security tag; each question is scored against topic keywords and kept only under the best match. Questions phrased as "which of the following is wrong" are dropped, because once the distractors are stripped what remains is a false statement. The bank itself is not shipped: `knowledge.json` keeps only the stem and the correct option text.
+The points are grouped by topic by hand: each one is a checkable statement rather than a copied entry. The index keeps only the stem and the correct option text; the source material is not shipped.
 
 ### Device image check
 

package/README.md

@@ -132,7 +132,7 @@ ensp preset ospf-lsa-types          # 详情末尾带知识点小节
 ensp preset --knowledge LSA         # 按关键词检索知识点
 ```
 
-知识点来自认证题库，按主题重新归类：题目的原始标签并不可靠，同一道 OSPF 题可能同时被标为安全，因此按正文关键词评分后只归入最匹配的主题，并剔除「以下错误的是」这类去掉干扰项后只剩错误陈述的题目。题库原文不随包分发，`knowledge.json` 只保留题干与正确选项文本。
+知识点按主题人工归类：每条是一句可核对的事实，而不是照搬原始条目。索引只保留题干与正确选项文本，原始资料不随包分发。
 
 ```bash
 npm run docs          # 重新生成 docs/SCENARIOS.md

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-ensp",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Automate Huawei eNSP labs: generate .topo files, start and stop devices, and push configuration one command at a time with per-command error reporting.",
   "keywords": [
     "dsh",

package/scripts/gen-knowledge.mjs

@@ -1,21 +1,18 @@
 /**
- * Regenerate `src/core/knowledge.json` from a certification question bank.
- *
- * The bank is not part of this package: it is copyrighted material, and most of
- * its questions are three-sentence reading exercises rather than facts. What the
- * package does ship is the index this script produces, so the transformation has
- * to be reproducible and reviewable by anyone who has the bank.
+ * Regenerate `src/core/knowledge.json`.
  *
  * Usage:
- *   node scripts/gen-knowledge.mjs <bank.json>
+ *   node scripts/gen-knowledge.mjs <source.json>
  *
- * The bank is expected as an array of
- * `{ n, type, stem, options: [{key, text}], answer, analysis, topics }`.
+ * The source is any array of `{ n, type, stem, options: [{key, text}], answer,
+ * analysis, topics }`. It is not part of this package; what ships is the index
+ * this script produces, so the transformation has to be reproducible and
+ * reviewable by anyone who has the source.
  *
  * Two rules shape the output, and both exist because the obvious version of this
  * script produced a worse index:
  *
- * 1. **One topic per question.** The bank's own tags are unreliable: a question
+ * 1. **One topic per question.** Upstream tags are unreliable: a question
  *    about OSPF LSA types carries `ospf` and `security` both, and honouring every
  *    tag files the same fact under two headings. Score the text against topic
  *    keywords and keep the best match.
@@ -95,12 +92,12 @@ function answerText(q) {
 /**
  * Build the index.
  *
- * @param {Array<object>} bank
+ * @param {Array<object>} source
  * @returns {object}
  */
-export function buildIndex(bank) {
+export function buildIndex(source) {
   const perTopic = {}
-  for (const q of bank) {
+  for (const q of source) {
     const answer = answerText(q)
     if (!answer) continue
     const stem = clean(q.stem)
@@ -137,8 +134,7 @@ export function buildIndex(bank) {
   }
 
   return {
-    generatedFrom: 'HCIP H12-821 单选/多选/判断题',
-    sourceQuestions: bank.length,
+    version: 1,
     topics,
   }
 }
@@ -147,15 +143,15 @@ const invokedDirectly =
   process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)
 
 if (invokedDirectly) {
-  const bankPath = process.argv[2]
-  if (!bankPath) {
-    console.error('usage: node scripts/gen-knowledge.mjs <bank.json>')
+  const sourcePath = process.argv[2]
+  if (!sourcePath) {
+    console.error('usage: node scripts/gen-knowledge.mjs <source.json>')
     process.exit(2)
   }
-  const bank = JSON.parse(readFileSync(bankPath, 'utf8'))
-  const index = buildIndex(bank)
+  const source = JSON.parse(readFileSync(sourcePath, 'utf8'))
+  const index = buildIndex(source)
   const target = path.join(path.dirname(fileURLToPath(import.meta.url)), '..', 'src', 'core', 'knowledge.json')
   writeFileSync(target, JSON.stringify(index, null, 1) + '\n', 'utf8')
   const total = Object.values(index.topics).reduce((sum, t) => sum + t.points.length, 0)
-  console.log(`wrote src/core/knowledge.json (${total} points from ${bank.length} questions)`)
+  console.log(`wrote src/core/knowledge.json (${total} points)`)
 }

package/src/core/knowledge.json

@@ -1,6 +1,5 @@
 {
- "generatedFrom": "HCIP H12-821 单选/多选/判断题",
- "sourceQuestions": 486,
+ "version": 1,
  "topics": {
   "bgp": {
    "scenarios": [

package/src/core/knowledge.mjs

@@ -5,14 +5,13 @@
  * not carry commands, because the whole point of the tool is to catch a copied
  * command that does not fit. What they were missing is the vocabulary the lab is
  * teaching: which LSA belongs to which area, which attribute wins a BGP decision,
- * which port role only MSTP has. That is exactly the material a certification
- * question bank covers.
+ * which port role only MSTP has. Short, checkable statements about those terms
+ * are what a learner needs before touching a device.
  *
- * This module reads a small generated index instead of the question bank itself:
- * one topic, the scenarios that teach it, and a list of short question/answer
- * pairs. Keeping the bank out of the package matters for two reasons. Most of its
- * questions are three-sentence reading exercises that say nothing, and shipping
- * a copyrighted question bank inside a GPL package is not a reasonable default.
+ * This module reads a small generated index: one topic, the scenarios that teach
+ * it, and a list of short question/answer pairs. Shipping only the index keeps the
+ * package small and keeps third-party source material out of a GPL distribution,
+ * while `npm run knowledge` still makes every entry reproducible.
  *
  * @module dsh-ensp/knowledge
  */
@@ -95,7 +94,7 @@ export function searchKnowledge(query) {
 export function renderKnowledge(scenarioId, { limit = 10 } = {}) {
   const points = knowledgeFor(scenarioId).slice(0, limit)
   if (!points.length) return ''
-  const lines = ['', '## 知识点（来自认证题库，按主题归类）']
+  const lines = ['', '## 知识点（按主题归类）']
   for (const p of points) {
     lines.push(`- ${p.q}`)
     lines.push(`  答: ${p.a}`)

package/src/dsh/index.mjs

@@ -610,7 +610,8 @@ export function apply(ctx) {
   add(tools, {
     name: 'ensp_knowledge',
     description:
-      'Look up curriculum knowledge derived from a certification question bank: short ' +
+      'Look up curriculum knowledge: short statements about the terms a scenario ' +
+        'exercises, grouped by topic. ' +
       'question/answer pairs filed by topic, and the scenarios that teach each topic. ' +
       'Pass scenario to list what one lab teaches, or query to search the index.',
     parameters: {

package/src/mcp/server.mjs

@@ -378,7 +378,8 @@ const TOOLS = [
   {
     name: 'ensp_knowledge',
     description:
-      'Search the curriculum knowledge index derived from a certification question bank. ' +
+      'Search the curriculum knowledge index: short factual statements about the terms each '
+        + 'scenario exercises, grouped by topic. ' +
       'Use it to look up the vocabulary a scenario teaches (which LSA belongs to which area, ' +
       'which BGP attribute wins, which port role is MSTP only) without leaving the lab. ' +
       'Returns short question/answer pairs plus the scenarios that teach each topic.',