dsh-paper-doc-adapter 0.0.0-stage → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,15 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ Licensed under the Apache License, Version 2.0 (the "License");
6
+ you may not use this file except in compliance with the License.
7
+ You may obtain a copy of the License at
8
+
9
+ http://www.apache.org/licenses/LICENSE-2.0
10
+
11
+ Unless required by applicable law or agreed to in writing, software
12
+ distributed under the License is distributed on an "AS IS" BASIS,
13
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ See the License for the specific language governing permissions and
15
+ limitations under the License.
package/README-es.md ADDED
@@ -0,0 +1,94 @@
1
+ # dsh-paper-doc-adapter
2
+
3
+ **Boundary:** this plugin checks a **试卷解析结果** for structural self-consistency — that each question records its
4
+ number and stem, that an answer or an explanation is present, that the question scores total the paper's score,
5
+ that the question type comes from your vocabulary, that the difficulty coefficient falls inside your range, that
6
+ question identifiers are present and unique, that a knowledge point is recorded, and that no placeholder survives.
7
+ It does **not** decide whether a question is well written, whether an answer is correct, whether the difficulty is
8
+ appropriate, or whether the paper meets its assessment objectives.
9
+
10
+ > ### ⚠️ What this plugin deliberately does not do
11
+ >
12
+ > **It treats the paper as a generic table and performs no question-type-specific checking.** So it **does not
13
+ > verify that an answer letter falls within the options offered**, that a fill-in-the-blank has the right number of
14
+ > blanks, or that a multiple-choice question has exactly one correct option. Those need the structure of each
15
+ > question type parsed, which this adapter does not attempt. That boundary is stated in the pack's header and in
16
+ > the troubleshooting section.
17
+ >
18
+ > **It never checks whether data is fit to import into a question bank beyond key presence and uniqueness.** A
19
+ > duplicate identifier is the dangerous case — importing would silently overwrite an existing question — which is
20
+ > why `PD-006` is `warn` and why it reports itself in `skipped` when no identifier column is present rather than
21
+ > checking the wrong column.
22
+ >
23
+ > **The difficulty range `0–1` is a local convention, not the only scale.** It is the common convention, larger
24
+ > meaning easier; a unit using 1–5 or a percentage can change `min`/`max` or disable the rule.
25
+ >
26
+ > **Every `excerpt` in the rule pack says, in so many words, that the clause text was not obtained** — the
27
+ > verification pass retrieved neither JY/T 0606's text nor the yotta platform's field specification. When the
28
+ > texts are in hand, replace each `excerpt` with the real clause and raise `kind` to `direct`.
29
+
30
+ ## Compatibility
31
+
32
+ | Superficie | Estado |
33
+ |---|---|
34
+ | Harness | Rango de peers `>=0.1.2-rc.1 <0.2.0 \|\| >=0.2.0-0 <0.3.0` — verificado para aceptar tanto `0.2.0-rc.2` como `0.2.1-alpha.1`. **No se declara `engines.dsh`**: no tiene lector y no puede rechazar ningún host |
35
+ | Node | `^22.19.0 || >=24.0.0` |
36
+ | Plataformas | Todas (ESM puro; sin código nativo, sin red, sin llamada al modelo) |
37
+ | Modo de herramienta | Funciona en `native`, `ptc` y `both`; para un directorio completo use `ptc` |
38
+
39
+ ## What it does
40
+
41
+ La tabla de reglas, los campos y el comportamiento detallado están en [README.md](README.md#what-it-does) (versión principal en inglés). El plugin sólo enumera divergencias literales frente a las cláusulas citadas e indica en `skipped` cada comprobación que no pudo ejecutarse.
42
+
43
+ ## Install
44
+
45
+ ```sh
46
+ dsh plugin --profile <name> add dsh-paper-doc-adapter
47
+ dsh --profile <name> --dump-config | grep 'dsh-paper-doc-adapter'
48
+ ```
49
+
50
+ ## Configuration
51
+
52
+ Todos los parámetros ajustables viven en el esquema Schemastery de `src/config.ts`, por lo que se cambian desde `cordis.yml` sin tocar el código; los umbrales por regla están en el paquete de reglas bajo `rules/`.
53
+
54
+ | Clave | Tipo | Predeterminado | Descripción |
55
+ |---|---|---|---|
56
+ | `rulesFile` | string | `rules/paper-doc-adapter.yaml` | Ruta del paquete de reglas, relativa a la raíz del paquete |
57
+ | `disabledRules` | string[] | `[]` | Ids de reglas que se dejan de ejecutar; cada una aparece en `skipped` |
58
+ | `onlyRules` | string[] | `[]` | Ejecutar solo estas reglas; vacío ejecuta todas |
59
+ | `skipNotes` | string | `""` | Nota añadida a cada motivo de `skipped` |
60
+ | `timeoutMs` | number | `120000` | Presupuesto de tiempo de espera cooperativo de la herramienta |
61
+
62
+ ## Material format
63
+
64
+ Acepta JSON o YAML. El ejemplo completo de campos está en [README.md](README.md#material-format) (versión principal en inglés). Los campos son opcionales en la capa de lectura y los valida el motor, de modo que una exportación parcial produce hallazgos sobre lo que falta en lugar de un fallo.
65
+
66
+ ## Rule sources
67
+
68
+ Los datos de las reglas están separados del código: cada regla lleva documento, número, cláusula en la numeración propia de la fuente, extracto literal y URL de origen. El cargador impone que el extracto sea una cita real de al menos ocho caracteres y que una comprobación basada sólo en un principio general (`kind: derived-from-principle`, tope `warn`) o en una política local (`kind: institutional-configuration`, tope `info`) nunca se declare `error`.
69
+
70
+ Los límites verificados y las conclusiones deliberadamente **no** afirmadas están en [README.md](README.md#rule-sources) (versión principal en inglés) y en `rules/evidence/`.
71
+
72
+ ## Troubleshooting
73
+
74
+ - **El plugin se instala pero la herramienta no aparece**: compruebe que `main` resuelve a `lib/index.mjs` y que `pnpm run build` lo generó.
75
+ - **`dsh plugin add` rechaza el paquete**: la faixa de peers cubre `0.1.x` y `0.2.x`; fuera de ella, conceda una exención explícita con `dsh plugin --profile <name> allow-version <pkg@ver> --dsh-version <runtime> --accept-risk`.
76
+ - **Una regla no se ejecutó**: lea el arreglo `skipped`.
77
+ - **`check` informa `manifest-peers` como fallo**: es un problema conocido de `dsh-plugin-dev`; el runtime aplica la compatibilidad al instalar.
78
+ - **Los horarios parecen desplazados**: toda la aritmética es de hora local sobre las cadenas entregadas.
79
+
80
+ ## Development
81
+
82
+ ```sh
83
+ pnpm install
84
+ pnpm run typecheck
85
+ pnpm test
86
+ pnpm run build
87
+ node ../scripts/sync-shared.mjs dsh-paper-doc-adapter
88
+ ```
89
+
90
+ El último comando copia el kit compartido de `../_shared` a `src/shared/`; vuelva a ejecutarlo tras cada cambio compartido.
91
+
92
+ ## License
93
+
94
+ [Apache License 2.0](LICENSE) © 2026 dsh-paper-doc-adapter contributors.
package/README-hi.md ADDED
@@ -0,0 +1,94 @@
1
+ # dsh-paper-doc-adapter
2
+
3
+ **Boundary:** this plugin checks a **试卷解析结果** for structural self-consistency — that each question records its
4
+ number and stem, that an answer or an explanation is present, that the question scores total the paper's score,
5
+ that the question type comes from your vocabulary, that the difficulty coefficient falls inside your range, that
6
+ question identifiers are present and unique, that a knowledge point is recorded, and that no placeholder survives.
7
+ It does **not** decide whether a question is well written, whether an answer is correct, whether the difficulty is
8
+ appropriate, or whether the paper meets its assessment objectives.
9
+
10
+ > ### ⚠️ What this plugin deliberately does not do
11
+ >
12
+ > **It treats the paper as a generic table and performs no question-type-specific checking.** So it **does not
13
+ > verify that an answer letter falls within the options offered**, that a fill-in-the-blank has the right number of
14
+ > blanks, or that a multiple-choice question has exactly one correct option. Those need the structure of each
15
+ > question type parsed, which this adapter does not attempt. That boundary is stated in the pack's header and in
16
+ > the troubleshooting section.
17
+ >
18
+ > **It never checks whether data is fit to import into a question bank beyond key presence and uniqueness.** A
19
+ > duplicate identifier is the dangerous case — importing would silently overwrite an existing question — which is
20
+ > why `PD-006` is `warn` and why it reports itself in `skipped` when no identifier column is present rather than
21
+ > checking the wrong column.
22
+ >
23
+ > **The difficulty range `0–1` is a local convention, not the only scale.** It is the common convention, larger
24
+ > meaning easier; a unit using 1–5 or a percentage can change `min`/`max` or disable the rule.
25
+ >
26
+ > **Every `excerpt` in the rule pack says, in so many words, that the clause text was not obtained** — the
27
+ > verification pass retrieved neither JY/T 0606's text nor the yotta platform's field specification. When the
28
+ > texts are in hand, replace each `excerpt` with the real clause and raise `kind` to `direct`.
29
+
30
+ ## Compatibility
31
+
32
+ | सतह | स्थिति |
33
+ |---|---|
34
+ | Harness | peer रेंज `>=0.1.2-rc.1 <0.2.0 \|\| >=0.2.0-0 <0.3.0` — `0.2.0-rc.2` और `0.2.1-alpha.1` दोनों को स्वीकार करने के लिए सत्यापित। **`engines.dsh` जानबूझकर घोषित नहीं**: इसका कोई पाठक नहीं और यह किसी होस्ट को अस्वीकार नहीं कर सकता |
35
+ | Node | `^22.19.0 || >=24.0.0` |
36
+ | प्लेटफ़ॉर्म | सभी (शुद्ध ESM; कोई नेटिव कोड नहीं, कोई नेटवर्क नहीं, कोई मॉडल कॉल नहीं) |
37
+ | टूल मोड | `native`, `ptc` और `both` में काम करता है; पूरे फ़ोल्डर के लिए `ptc` चुनें |
38
+
39
+ ## What it does
40
+
41
+ नियम-सूची, फ़ील्ड और विस्तृत व्यवहार [README.md](README.md#what-it-does) (अंग्रेज़ी मुख्य संस्करण) में हैं। यह प्लगइन केवल उद्धृत धाराओं के सामने शाब्दिक अंतर सूचीबद्ध करता है और हर न चल पाई जाँच को `skipped` में बताता है।
42
+
43
+ ## Install
44
+
45
+ ```sh
46
+ dsh plugin --profile <name> add dsh-paper-doc-adapter
47
+ dsh --profile <name> --dump-config | grep 'dsh-paper-doc-adapter'
48
+ ```
49
+
50
+ ## Configuration
51
+
52
+ सभी समायोज्य पैरामीटर `src/config.ts` की Schemastery स्कीमा में हैं, इसलिए कोड बदले बिना `cordis.yml` से बदले जा सकते हैं; प्रति-नियम सीमाएँ `rules/` के नियम-पैक में हैं।
53
+
54
+ | कुंजी | प्रकार | डिफ़ॉल्ट | विवरण |
55
+ |---|---|---|---|
56
+ | `rulesFile` | string | `rules/paper-doc-adapter.yaml` | नियम-पैक का पथ, पैकेज रूट के सापेक्ष |
57
+ | `disabledRules` | string[] | `[]` | बंद करने वाले नियम id; प्रत्येक `skipped` में दिखता है |
58
+ | `onlyRules` | string[] | `[]` | केवल ये नियम चलाएँ; खाली होने पर सभी नियम चलते हैं |
59
+ | `skipNotes` | string | `""` | हर `skipped` कारण के आगे जोड़ी जाने वाली टिप्पणी |
60
+ | `timeoutMs` | number | `120000` | उपकरण का सहकारी समय-सीमा बजट |
61
+
62
+ ## Material format
63
+
64
+ JSON या YAML स्वीकार्य है। पूरा फ़ील्ड उदाहरण [README.md](README.md#material-format) (अंग्रेज़ी मुख्य संस्करण) में है। पढ़ने की परत में फ़ील्ड वैकल्पिक हैं और जाँच इंजन उन्हें सत्यापित करता है, इसलिए आंशिक निर्यात पर क्रैश के बजाय "अनुपस्थित" श्रेणी के निष्कर्ष मिलते हैं।
65
+
66
+ ## Rule sources
67
+
68
+ नियम-डेटा कोड से अलग है: प्रत्येक नियम में दस्तावेज़, संख्या, स्रोत की अपनी क्रमांकन-प्रणाली के अनुसार धारा, शब्दशः उद्धरण और स्रोत URL होता है। लोडर लागू करता है कि उद्धरण कम से कम आठ अक्षरों का वास्तविक उद्धरण हो, और जिस जाँच का आधार केवल सामान्य सिद्धांत (`kind: derived-from-principle`, अधिकतम `warn`) या स्थानीय नीति (`kind: institutional-configuration`, अधिकतम `info`) हो, उसे कभी `error` घोषित न किया जाए।
69
+
70
+ सत्यापित सीमाएँ और जान-बूझकर **न** कहे गए निष्कर्ष [README.md](README.md#rule-sources) (अंग्रेज़ी मुख्य संस्करण) और `rules/evidence/` में हैं।
71
+
72
+ ## Troubleshooting
73
+
74
+ - **प्लगइन इंस्टॉल हो गया पर टूल दिखता नहीं**: जाँचें कि `main` `lib/index.mjs` पर जाता है और `pnpm run build` ने उसे बनाया है।
75
+ - **`dsh plugin add` असंगत बताकर मना करता है**: peer range `0.1.x` और `0.2.x` दोनों को कवर करती है; बाहर होने पर स्पष्ट छूट दें: `dsh plugin --profile <name> allow-version <pkg@ver> --dsh-version <runtime> --accept-risk`।
76
+ - **कोई नियम नहीं चला**: `skipped` सरणी देखें।
77
+ - **`check` में `manifest-peers` विफल दिखता है**: यह `dsh-plugin-dev` की ज्ञात अपस्ट्रीम समस्या है; रनटाइम इंस्टॉल के समय अनुकूलता लागू करता है।
78
+ - **समय खिसका हुआ लगता है**: सारी गणना दिए गए स्ट्रिंग पर वॉल-क्लॉक है।
79
+
80
+ ## Development
81
+
82
+ ```sh
83
+ pnpm install
84
+ pnpm run typecheck
85
+ pnpm test
86
+ pnpm run build
87
+ node ../scripts/sync-shared.mjs dsh-paper-doc-adapter
88
+ ```
89
+
90
+ अंतिम कमांड `../_shared` का साझा किट `src/shared/` में कॉपी करता है; हर साझा बदलाव के बाद इसे दोबारा चलाएँ।
91
+
92
+ ## License
93
+
94
+ [Apache License 2.0](LICENSE) © 2026 dsh-paper-doc-adapter contributors.
package/README-pt.md ADDED
@@ -0,0 +1,94 @@
1
+ # dsh-paper-doc-adapter
2
+
3
+ **Boundary:** this plugin checks a **试卷解析结果** for structural self-consistency — that each question records its
4
+ number and stem, that an answer or an explanation is present, that the question scores total the paper's score,
5
+ that the question type comes from your vocabulary, that the difficulty coefficient falls inside your range, that
6
+ question identifiers are present and unique, that a knowledge point is recorded, and that no placeholder survives.
7
+ It does **not** decide whether a question is well written, whether an answer is correct, whether the difficulty is
8
+ appropriate, or whether the paper meets its assessment objectives.
9
+
10
+ > ### ⚠️ What this plugin deliberately does not do
11
+ >
12
+ > **It treats the paper as a generic table and performs no question-type-specific checking.** So it **does not
13
+ > verify that an answer letter falls within the options offered**, that a fill-in-the-blank has the right number of
14
+ > blanks, or that a multiple-choice question has exactly one correct option. Those need the structure of each
15
+ > question type parsed, which this adapter does not attempt. That boundary is stated in the pack's header and in
16
+ > the troubleshooting section.
17
+ >
18
+ > **It never checks whether data is fit to import into a question bank beyond key presence and uniqueness.** A
19
+ > duplicate identifier is the dangerous case — importing would silently overwrite an existing question — which is
20
+ > why `PD-006` is `warn` and why it reports itself in `skipped` when no identifier column is present rather than
21
+ > checking the wrong column.
22
+ >
23
+ > **The difficulty range `0–1` is a local convention, not the only scale.** It is the common convention, larger
24
+ > meaning easier; a unit using 1–5 or a percentage can change `min`/`max` or disable the rule.
25
+ >
26
+ > **Every `excerpt` in the rule pack says, in so many words, that the clause text was not obtained** — the
27
+ > verification pass retrieved neither JY/T 0606's text nor the yotta platform's field specification. When the
28
+ > texts are in hand, replace each `excerpt` with the real clause and raise `kind` to `direct`.
29
+
30
+ ## Compatibility
31
+
32
+ | Superfície | Estado |
33
+ |---|---|
34
+ | Harness | Faixa de peers `>=0.1.2-rc.1 <0.2.0 \|\| >=0.2.0-0 <0.3.0` — verificada para aceitar tanto `0.2.0-rc.2` quanto `0.2.1-alpha.1`. **`engines.dsh` não é declarado**: não tem leitor e não pode recusar nenhum host |
35
+ | Node | `^22.19.0 || >=24.0.0` |
36
+ | Plataformas | Todas (ESM puro; sem código nativo, sem rede, sem chamada ao modelo) |
37
+ | Modo de ferramenta | Funciona em `native`, `ptc` e `both`; para um diretório inteiro use `ptc` |
38
+
39
+ ## What it does
40
+
41
+ A tabela de regras, os campos e o comportamento detalhado estão em [README.md](README.md#what-it-does) (versão principal em inglês). O plugin apenas lista divergências literais frente às cláusulas citadas e indica em `skipped` cada verificação que não pôde ser executada.
42
+
43
+ ## Install
44
+
45
+ ```sh
46
+ dsh plugin --profile <name> add dsh-paper-doc-adapter
47
+ dsh --profile <name> --dump-config | grep 'dsh-paper-doc-adapter'
48
+ ```
49
+
50
+ ## Configuration
51
+
52
+ Todos os parâmetros ajustáveis ficam no esquema Schemastery de `src/config.ts`, portanto mudam pelo `cordis.yml` sem editar código; os limites por regra ficam no pacote de regras sob `rules/`.
53
+
54
+ | Chave | Tipo | Padrão | Descrição |
55
+ |---|---|---|---|
56
+ | `rulesFile` | string | `rules/paper-doc-adapter.yaml` | Caminho do pacote de regras, relativo à raiz do pacote |
57
+ | `disabledRules` | string[] | `[]` | Ids de regras a desativar; cada uma aparece em `skipped` |
58
+ | `onlyRules` | string[] | `[]` | Executar apenas estas regras; vazio executa todas |
59
+ | `skipNotes` | string | `""` | Nota acrescentada a cada motivo de `skipped` |
60
+ | `timeoutMs` | number | `120000` | Orçamento de tempo limite cooperativo da ferramenta |
61
+
62
+ ## Material format
63
+
64
+ Aceita JSON ou YAML. O exemplo completo de campos está em [README.md](README.md#material-format) (versão principal em inglês). Os campos são opcionais na camada de leitura e validados pelo motor, de modo que uma exportação parcial gera achados sobre o que falta em vez de falhar.
65
+
66
+ ## Rule sources
67
+
68
+ Os dados das regras ficam separados do código: cada regra traz documento, número, cláusula na numeração própria da fonte, trecho literal e URL de origem. O carregador impõe que o trecho seja citação real de pelo menos oito caracteres e que uma verificação baseada apenas em princípio geral (`kind: derived-from-principle`, teto `warn`) ou em política local (`kind: institutional-configuration`, teto `info`) nunca seja declarada `error`.
69
+
70
+ Os limites verificados e as conclusões deliberadamente **não** afirmadas estão em [README.md](README.md#rule-sources) (versão principal em inglês) e em `rules/evidence/`.
71
+
72
+ ## Troubleshooting
73
+
74
+ - **O plugin instala mas a ferramenta não aparece**: confirme que `main` resolve para `lib/index.mjs` e que `pnpm run build` o gerou.
75
+ - **`dsh plugin add` recusa o pacote**: a faixa de peers cobre `0.1.x` e `0.2.x`; fora dela, conceda isenção explícita com `dsh plugin --profile <name> allow-version <pkg@ver> --dsh-version <runtime> --accept-risk`.
76
+ - **Uma regra não executou**: leia o arranjo `skipped`.
77
+ - **`check` informa `manifest-peers` como falha**: problema conhecido do `dsh-plugin-dev`; o runtime aplica a compatibilidade na instalação.
78
+ - **Os horários parecem deslocados**: toda a aritmética é de hora local sobre as cadeias fornecidas.
79
+
80
+ ## Development
81
+
82
+ ```sh
83
+ pnpm install
84
+ pnpm run typecheck
85
+ pnpm test
86
+ pnpm run build
87
+ node ../scripts/sync-shared.mjs dsh-paper-doc-adapter
88
+ ```
89
+
90
+ O último comando copia o kit compartilhado de `../_shared` para `src/shared/`; execute-o novamente após cada alteração compartilhada.
91
+
92
+ ## License
93
+
94
+ [Apache License 2.0](LICENSE) © 2026 dsh-paper-doc-adapter contributors.
package/README-zh.md ADDED
@@ -0,0 +1,94 @@
1
+ # dsh-paper-doc-adapter
2
+
3
+ **Boundary:** this plugin checks a **试卷解析结果** for structural self-consistency — that each question records its
4
+ number and stem, that an answer or an explanation is present, that the question scores total the paper's score,
5
+ that the question type comes from your vocabulary, that the difficulty coefficient falls inside your range, that
6
+ question identifiers are present and unique, that a knowledge point is recorded, and that no placeholder survives.
7
+ It does **not** decide whether a question is well written, whether an answer is correct, whether the difficulty is
8
+ appropriate, or whether the paper meets its assessment objectives.
9
+
10
+ > ### ⚠️ What this plugin deliberately does not do
11
+ >
12
+ > **It treats the paper as a generic table and performs no question-type-specific checking.** So it **does not
13
+ > verify that an answer letter falls within the options offered**, that a fill-in-the-blank has the right number of
14
+ > blanks, or that a multiple-choice question has exactly one correct option. Those need the structure of each
15
+ > question type parsed, which this adapter does not attempt. That boundary is stated in the pack's header and in
16
+ > the troubleshooting section.
17
+ >
18
+ > **It never checks whether data is fit to import into a question bank beyond key presence and uniqueness.** A
19
+ > duplicate identifier is the dangerous case — importing would silently overwrite an existing question — which is
20
+ > why `PD-006` is `warn` and why it reports itself in `skipped` when no identifier column is present rather than
21
+ > checking the wrong column.
22
+ >
23
+ > **The difficulty range `0–1` is a local convention, not the only scale.** It is the common convention, larger
24
+ > meaning easier; a unit using 1–5 or a percentage can change `min`/`max` or disable the rule.
25
+ >
26
+ > **Every `excerpt` in the rule pack says, in so many words, that the clause text was not obtained** — the
27
+ > verification pass retrieved neither JY/T 0606's text nor the yotta platform's field specification. When the
28
+ > texts are in hand, replace each `excerpt` with the real clause and raise `kind` to `direct`.
29
+
30
+ ## Compatibility
31
+
32
+ | 项目 | 状态 |
33
+ |---|---|
34
+ | Harness | 对等版本范围 `>=0.1.2-rc.1 <0.2.0 \|\| >=0.2.0-0 <0.3.0` —— 已实测同时接受 `0.2.0-rc.2` 与 `0.2.1-alpha.1`。**刻意不声明 `engines.dsh`**:它没有任何读取者,也无法拒装任何宿主 |
35
+ | Node | `^22.19.0 || >=24.0.0` |
36
+ | 平台 | 全平台(纯 ESM;无原生代码、无联网、不调用模型) |
37
+ | 工具模式 | `native` / `ptc` / `both` 均可;批量校验整个目录时建议 `ptc`,schema 成本只付一次 |
38
+
39
+ ## What it does
40
+
41
+ 规则表、字段说明与行为细节见 [README.md](README.md#what-it-does)(英文主版本)。本插件只列出材料与所引条款之间的字面差异,并对无法执行的检查在 `skipped` 中逐项说明。
42
+
43
+ ## Install
44
+
45
+ ```sh
46
+ dsh plugin --profile <name> add dsh-paper-doc-adapter
47
+ dsh --profile <name> --dump-config | grep 'dsh-paper-doc-adapter'
48
+ ```
49
+
50
+ ## Configuration
51
+
52
+ 全部可调参数都在 `src/config.ts` 的 Schemastery schema 中,只改 `cordis.yml` 即可生效,无需改代码;逐条阈值在 `rules/` 下的规则库文件里。
53
+
54
+ | 键 | 类型 | 默认值 | 说明 |
55
+ |---|---|---|---|
56
+ | `rulesFile` | string | `rules/paper-doc-adapter.yaml` | 规则库文件路径,相对插件包根目录 |
57
+ | `disabledRules` | string[] | `[]` | 要停用的规则 id 列表;每条都会出现在 `skipped` 中 |
58
+ | `onlyRules` | string[] | `[]` | 只执行这些规则 id;留空表示执行全部规则 |
59
+ | `skipNotes` | string | `""` | 附加到每条 `skipped` 说明后的备注 |
60
+ | `timeoutMs` | number | `120000` | 工具协作式超时预算(毫秒) |
61
+
62
+ ## Material format
63
+
64
+ 支持 JSON 与 YAML。完整字段示例见 [README.md](README.md#material-format)(英文主版本)。字段在读取层是可选的,由检查引擎校验,因此部分导出的材料会产生"缺项"类差异,而不是让程序崩溃。
65
+
66
+ ## Rule sources
67
+
68
+ 规则数据与代码分离,每条规则都带文件名、文号、按原文自身编号体系的条款号、逐字摘录与来源地址。加载期强制:摘录必须是真实引文且不少于八个字符;依据仅为原则性条款(`kind: derived-from-principle`,严重级上限 `warn`)或本机构配置(`kind: institutional-configuration`,上限 `info`)的检查不得标为 `error`。夸大依据的规则库会在加载期失败,而不会产出一份看起来很有底气的报告。
69
+
70
+ 核验中确认的边界与"刻意没有作出的结论"见 [README.md](README.md#rule-sources)(英文主版本)与随包的 `rules/evidence/` 目录。
71
+
72
+ ## Troubleshooting
73
+
74
+ - **插件装上了但工具不出现**:确认 `main` 指向 `lib/index.mjs` 且 `pnpm run build` 已生成该文件;`main` 写错会让加载器静默跳过该条目。
75
+ - **`dsh plugin add` 报版本不兼容**:peer 范围覆盖 `0.1.x` 与 `0.2.x`;若运行时在其之外,可显式豁免:`dsh plugin --profile <name> allow-version <包名@版本> --dsh-version <runtime> --accept-risk`
76
+ - **某条规则没有执行**:查看 `skipped` 数组,其中写明了规则 id 与原因。
77
+ - **`check` 报 `manifest-peers` 失败**:静态检查器比对的是一份早于 0.2 世代的硬编码 peer 范围;安装期的 peer 校验以运行时为准。这是 `dsh-plugin-dev` 的已知上游问题。
78
+ - **时间看起来偏移**:全部计算都是对输入字符串做墙上时钟运算,不做时区换算。
79
+
80
+ ## Development
81
+
82
+ ```sh
83
+ pnpm install
84
+ pnpm run typecheck
85
+ pnpm test
86
+ pnpm run build
87
+ node ../scripts/sync-shared.mjs dsh-paper-doc-adapter
88
+ ```
89
+
90
+ 第 4 项把 `../_shared` 的共享件同步进 `src/shared/`;每次改动共享件后都要重跑。
91
+
92
+ ## License
93
+
94
+ [Apache License 2.0](LICENSE) © 2026 dsh-paper-doc-adapter contributors.
package/README.md CHANGED
@@ -1,3 +1,144 @@
1
- # Temporary Holding Version
1
+ # dsh-paper-doc-adapter
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ **Boundary:** this plugin checks a **试卷解析结果** for structural self-consistency — that each question records its
4
+ number and stem, that an answer or an explanation is present, that the question scores total the paper's score,
5
+ that the question type comes from your vocabulary, that the difficulty coefficient falls inside your range, that
6
+ question identifiers are present and unique, that a knowledge point is recorded, and that no placeholder survives.
7
+ It does **not** decide whether a question is well written, whether an answer is correct, whether the difficulty is
8
+ appropriate, or whether the paper meets its assessment objectives.
9
+
10
+ > ### ⚠️ What this plugin deliberately does not do
11
+ >
12
+ > **It treats the paper as a generic table and performs no question-type-specific checking.** So it **does not
13
+ > verify that an answer letter falls within the options offered**, that a fill-in-the-blank has the right number of
14
+ > blanks, or that a multiple-choice question has exactly one correct option. Those need the structure of each
15
+ > question type parsed, which this adapter does not attempt. That boundary is stated in the pack's header and in
16
+ > the troubleshooting section.
17
+ >
18
+ > **It never checks whether data is fit to import into a question bank beyond key presence and uniqueness.** A
19
+ > duplicate identifier is the dangerous case — importing would silently overwrite an existing question — which is
20
+ > why `PD-006` is `warn` and why it reports itself in `skipped` when no identifier column is present rather than
21
+ > checking the wrong column.
22
+ >
23
+ > **The difficulty range `0–1` is a local convention, not the only scale.** It is the common convention, larger
24
+ > meaning easier; a unit using 1–5 or a percentage can change `min`/`max` or disable the rule.
25
+ >
26
+ > **Every `excerpt` in the rule pack says, in so many words, that the clause text was not obtained** — the
27
+ > verification pass retrieved neither JY/T 0606's text nor the yotta platform's field specification. When the
28
+ > texts are in hand, replace each `excerpt` with the real clause and raise `kind` to `direct`.
29
+
30
+ ## Compatibility
31
+
32
+ | Surface | Status |
33
+ |---|---|
34
+ | Harness | Peer range `>=0.1.2-rc.1 <0.2.0 \|\| >=0.2.0-0 <0.3.0` — verified to accept both `0.2.0-rc.2` and `0.2.1-alpha.1`. `engines.dsh` is deliberately not declared: it has no reader and cannot reject a host |
35
+ | Node | `^22.19.0 || >=24.0.0` |
36
+ | Platforms | All (plain ESM; no native code, no network, no model call) |
37
+ | Tool mode | Works in `native`, `ptc` and `both`; for a full paper use `ptc` |
38
+
39
+ ## What it does
40
+
41
+ Registers the `paper_doc_adapter` tool. It reads one parsed paper — the paper header plus one row per question —
42
+ applies a versioned rule pack, and returns a report.
43
+
44
+ | Rule | Check | Severity | Basis kind |
45
+ |---|---|---|---|
46
+ | `PD-001` | the question number and stem are recorded | warn | principle |
47
+ | `PD-002` | an answer or an explanation is present | warn | principle |
48
+ | `PD-003` | the question scores total the paper score | warn | principle |
49
+ | `PD-004` | the question type comes from your vocabulary (off by default) | info | local |
50
+ | `PD-005` | the difficulty coefficient is inside your range | info | local |
51
+ | `PD-006` | question identifiers are present and unique | warn | principle |
52
+ | `PD-007` | a knowledge point is recorded | warn | principle |
53
+ | `PD-008` | the stem holds no unreplaced placeholder | warn | principle |
54
+
55
+ ## Install
56
+
57
+ ```sh
58
+ dsh plugin --profile <name> add dsh-paper-doc-adapter
59
+ dsh --profile <name> --dump-config | grep 'dsh-paper-doc-adapter'
60
+ ```
61
+
62
+ ## Configuration
63
+
64
+ | Key | Type | Default | Description |
65
+ |---|---|---|---|
66
+ | `rulesFile` | string | `rules/paper-doc-adapter.yaml` | Rule-pack path, relative to the package root |
67
+ | `disabledRules` | string[] | `[]` | Rule ids to stop running; each appears in `skipped` |
68
+ | `onlyRules` | string[] | `[]` | Run only these rule ids; empty runs every rule |
69
+ | `skipNotes` | string | `""` | Note appended to every `skipped` reason |
70
+ | `timeoutMs` | number | `120000` | Cooperative tool timeout budget |
71
+
72
+ Rule-level parameters worth knowing:
73
+
74
+ - `PD-003` `field` / `headerField` / `tolerance` — the score column and the header total it must match.
75
+ - `PD-004` `values` — your question types, e.g.
76
+ `[单选题, 多选题, 判断题, 填空题, 简答题, 计算题, 作文题]`. Empty means no check.
77
+ - `PD-005` `min` / `max` — the difficulty range, `0` to `1` by default. **A local convention**, not a standard
78
+ figure.
79
+ - `PD-008` `terms` — the placeholders to look for.
80
+
81
+ ## Material format
82
+
83
+ The tool accepts JSON or YAML:
84
+
85
+ ```yaml
86
+ paperTitle: 某某科目 2026 年模拟试卷
87
+ subject: 某某科目
88
+ grade: 高二
89
+ paperVersion: 2026 版
90
+ totalScore: '3'
91
+ durationMin: '90'
92
+ rows:
93
+ - { 序号: '1', 题号: '1', 题型: 单选题, 题干: 下列关于……的说法,正确的是(  ),
94
+ 选项: A. ……;B. ……;C. ……;D. ……, 答案: B,
95
+ 解析: 本题考查……,依据……,故 B 正确。, 分值: '3', 难度: '0.72',
96
+ 知识点: 某某章节 某某知识点, 题目ID: YOTTA-2026-0001, 标签: 基础题 }
97
+ ```
98
+
99
+ Column names are matched case-insensitively and ignoring spaces, underscores and hyphens; the paper's own column
100
+ names are kept, so a finding names the column it read. Note that 序号 is read as the row's display number — give
101
+ the question number its own column (题号).
102
+
103
+ ## Rule sources
104
+
105
+ Rule data lives in `rules/paper-doc-adapter.yaml`. Its header explains what the plugin does not check, and each
106
+ rule's `note` repeats the part that matters for that rule. The load-time guard still requires a document, clause,
107
+ excerpt and source per rule, and still forbids a locally configured check from being `error`.
108
+
109
+ ## Troubleshooting
110
+
111
+ - **It did not notice that an answer letter is outside the options.** By design: the plugin treats the paper as a
112
+ generic table and performs no question-type-specific validation.
113
+ - **`PD-006` reports itself as skipped.** No identifier column is present, so the uniqueness check has nothing to
114
+ key on. It reports that rather than checking the wrong column.
115
+ - **`PD-005` fires on a difficulty of `1.8`.** The default range is `0`–`1`; change `min`/`max` if your bank uses
116
+ another scale.
117
+ - **`PD-003` fires although the paper adds up.** The header total and the sum of the rows disagree — usually a
118
+ missing question or a mistyped score.
119
+ - **`PD-004` never runs.** Its vocabulary is empty; fill it with your bank's question types.
120
+ - **The plugin installs but the tool never appears.** Check that `main` resolves to `lib/index.mjs` and
121
+ that `pnpm run build` produced it; a wrong `main` makes the loader skip the entry silently.
122
+ - **`dsh plugin add` refuses the package as incompatible.** The peer range covers `0.1.x` and `0.2.x`; if
123
+ your runtime sits outside it, grant an explicit exemption:
124
+ `dsh plugin --profile <name> allow-version dsh-paper-doc-adapter@0.1.0 --dsh-version <runtime> --accept-risk`
125
+ - **`check` reports `manifest-peers` as failed.** The static checker compares against a hard-coded peer
126
+ range that predates the 0.2 line. The runtime enforces peer compatibility at install time, so the
127
+ declared range is the correct one; this is a known upstream issue in `dsh-plugin-dev`.
128
+
129
+ ## Development
130
+
131
+ ```sh
132
+ pnpm install
133
+ pnpm run typecheck # tsc --noEmit
134
+ pnpm test # vitest, the shared table-plugin suite plus paired fixtures
135
+ pnpm run build # tsdown -> lib/index.mjs + lib/index.d.mts
136
+ node ../scripts/sync-shared.mjs dsh-paper-doc-adapter # refresh src/shared from ../_shared
137
+ ```
138
+
139
+ The plugin is **data-only**: `src/model.ts` declares the table shape, the shared kit supplies the reader and the
140
+ check engine, and the rule pack declares every check.
141
+
142
+ ## License
143
+
144
+ [Apache License 2.0](LICENSE) © 2026 dsh-paper-doc-adapter contributors.
@@ -0,0 +1,8 @@
1
+ # dsh-paper-doc-adapter bundle layer: register this plugin as a bundle row.
2
+ # This file is the `dsh.bundle.patch` layer (see package.json#dsh.bundle.patch).
3
+ # Layer semantics: a YAML array of row verbs; `insert` adds plugin rows to the
4
+ # composed config. A row's `id` must be unique within the layer stack; `name`
5
+ # resolves the plugin module through the installed package (package.json#main).
6
+ - insert:
7
+ - id: dsh-paper-doc-adapter
8
+ name: dsh-paper-doc-adapter
package/icon.svg ADDED
@@ -0,0 +1,6 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="Paper document check">
2
+ <rect width="64" height="64" rx="12" fill="#0f766e"/>
3
+ <path d="M16 20h32M16 32h22M16 44h26" stroke="#ffffff" stroke-width="4" stroke-linecap="round"/>
4
+ <circle cx="50" cy="46" r="9" fill="#ffffff"/>
5
+ <path d="M46 46l3 3 5-6" stroke="#0f766e" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" fill="none"/>
6
+ </svg>
@@ -0,0 +1,52 @@
1
+ import Schema from "@deepseek-ai/schemastery";
2
+ import { Context } from "@deepseek-ai/cordis";
3
+ //#region src/config.d.ts
4
+ /**
5
+ * Every tunable lives here so an operator can change behaviour from
6
+ * `cordis.yml` without editing code (the family's "no hard-coded tunables"
7
+ * redline). The rule pack itself is data as well and can be pointed elsewhere.
8
+ */
9
+ interface Config {
10
+ /** Rule-pack path relative to the plugin package root. */
11
+ rulesFile: string;
12
+ /** Rule ids disabled for this deployment. */
13
+ disabledRules: string[];
14
+ /** When non-empty, only these rule ids run. */
15
+ onlyRules: string[];
16
+ /** Extra note appended to every `skipped` reason. */
17
+ skipNotes: string;
18
+ /** Tool timeout budget in milliseconds. */
19
+ timeoutMs: number;
20
+ }
21
+ declare const Config: Schema<Config>;
22
+ //#endregion
23
+ //#region src/index.d.ts
24
+ declare const name = "dsh-paper-doc-adapter";
25
+ declare const inject: string[];
26
+ /** Tool id exposed to the model, and the row id in `cordis.patch.yml`. */
27
+ declare const TOOL_NAME = "paper_doc_adapter";
28
+ /**
29
+ * Locate a package-owned file such as the rule pack.
30
+ *
31
+ * Resolution order: absolute path, then every ancestor of the module directory,
32
+ * then the process working directory. A wrong silent fallback would build a
33
+ * report from the wrong rule pack, so a miss throws with the paths tried.
34
+ *
35
+ * @param relative - configured path, relative to the plugin package root.
36
+ * @returns the resolved absolute path.
37
+ * @throws Error naming every location tried, when the file is absent.
38
+ */
39
+ declare function resolvePackageFile(relative: string): string;
40
+ /**
41
+ * Register the checker tool.
42
+ *
43
+ * Registration is an effect: `ctx.tools.register` returns the disposer that
44
+ * removes the tool when this plugin unloads, which is what keeps the plugin
45
+ * hot-reloadable.
46
+ *
47
+ * @param ctx - plugin context, with `tools` already available.
48
+ * @param config - validated configuration.
49
+ */
50
+ declare function apply(ctx: Context, config: Config): () => void;
51
+ //#endregion
52
+ export { Config, TOOL_NAME, apply, inject, name, resolvePackageFile };