dsh-eia-guide-check 0.0.0-stage → 0.2.1

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/CHANGELOG.md ADDED
@@ -0,0 +1,20 @@
1
+ # Changelog
2
+
3
+ ## 0.2.1
4
+
5
+ - Ship `CHANGELOG.md` and `SECURITY.md` inside the package. `files` is an
6
+ allowlist and neither was on it, so no release note had ever reached anyone
7
+ who installed this package, and npm had no changelog section to show.
8
+ ## 0.2.0
9
+
10
+ - Release infrastructure brought to the family standard: `verify:self-contained`,
11
+ `check:lockfile`, `check:readmes` and `check:citations` gates, a `prepublishOnly` that
12
+ re-runs the whole chain, SECURITY.md, dependabot, and the OpenSSF Scorecard workflow.
13
+ - `check:citations` enforces the rule this pack's own header states: every `excerpt`
14
+ must be a verbatim quotation, findable in `rules/evidence/`. Rules that are not
15
+ traceable yet are listed in `rules/citations-baseline.json`, and that file can only
16
+ shrink - anything new has to be sourced before it can land.
17
+ - The README install command now names the published package instead of a local tarball.
18
+ - Five-language READMEs hold the same section count and the same configuration keys.
19
+ - Rule pack: 7 rules across EG-001..EG-007.
20
+ - Licensed Apache-2.0.
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,95 @@
1
+ # dsh-eia-guide-check
2
+
3
+ **Boundary:** this plugin checks an **环评导则适用性核对表** for traceability — that each environmental element
4
+ names its applicable guideline, that the guideline number follows its published form, that the guideline's status
5
+ comes from your vocabulary, that an assessment method or an applicable standard is recorded, that elements are
6
+ not double-registered, that the sheet names its project and report type, and that no placeholder survives. It does
7
+ **not** decide whether an environmental assessment is compliant, whether the assessment level is right, whether a
8
+ prediction model applies, or whether the conclusions hold.
9
+
10
+ > ### ⚠️ What this plugin deliberately cannot do
11
+ >
12
+ > **It does not contain the guideline catalogue, and it does not map an element onto the guideline that should
13
+ > govern it.** Because of that it **cannot find the most consequential error: using the wrong guideline for an
14
+ > element.** Choosing between HJ 2.2, HJ 2.3, HJ 2.4, HJ 964 and the rest turns on the project's category and the
15
+ > element in question, and confirming it means reading the classification list and each guideline's scope. This
16
+ > limit is stated in the pack's header, in `EG-001`'s note, and in the troubleshooting section below.
17
+ >
18
+ > The 适用导则 column is therefore the register's own statement. Everything here checks what can be checked
19
+ > mechanically: is it written down, does the number look like a guideline number, is the status one you
20
+ > recognise, is a method or standard recorded.
21
+ >
22
+ > **The plugin also ships no current-version table** — tracking which guidelines are in force and which have
23
+ > been superseded means following the ministry's announcements, and the status vocabulary is yours to configure.
24
+ > `EG-002` checks the *form* of a number (`HJ 2.3—2018`) and never whether that number exists, is current, or
25
+ > matches the name next to it.
26
+ >
27
+ > **Every `excerpt` in the rule pack says, in so many words, that the clause text was not obtained** — the
28
+ > verification pass did not retrieve the guidelines' verbatim text, nor verify each one's current version.
29
+ > When the texts are in hand, replace each `excerpt` with the real clause and raise `kind` to `direct`.
30
+
31
+ ## Compatibility
32
+
33
+ | Superficie | Estado |
34
+ |---|---|
35
+ | 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 |
36
+ | Node | `^22.19.0 || >=24.0.0` |
37
+ | Plataformas | Todas (ESM puro; sin código nativo, sin red, sin llamada al modelo) |
38
+ | Modo de herramienta | Funciona en `native`, `ptc` y `both`; para un directorio completo use `ptc` |
39
+
40
+ ## What it does
41
+
42
+ 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.
43
+
44
+ ## Install
45
+
46
+ ```sh
47
+ dsh plugin --profile <name> add dsh-eia-guide-check
48
+ dsh --profile <name> --dump-config | grep 'dsh-eia-guide-check'
49
+ ```
50
+
51
+ ## Configuration
52
+
53
+ 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/`.
54
+
55
+ | Clave | Tipo | Predeterminado | Descripción |
56
+ |---|---|---|---|
57
+ | `rulesFile` | string | `rules/eia-guide-check.yaml` | Ruta del paquete de reglas, relativa a la raíz del paquete |
58
+ | `disabledRules` | string[] | `[]` | Ids de reglas que se dejan de ejecutar; cada una aparece en `skipped` |
59
+ | `onlyRules` | string[] | `[]` | Ejecutar solo estas reglas; vacío ejecuta todas |
60
+ | `skipNotes` | string | `""` | Nota añadida a cada motivo de `skipped` |
61
+ | `timeoutMs` | number | `120000` | Presupuesto de tiempo de espera cooperativo de la herramienta |
62
+
63
+ ## Material format
64
+
65
+ 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.
66
+
67
+ ## Rule sources
68
+
69
+ 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`.
70
+
71
+ 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/`.
72
+
73
+ ## Troubleshooting
74
+
75
+ - **El plugin se instala pero la herramienta no aparece**: compruebe que `main` resuelve a `lib/index.mjs` y que `pnpm run build` lo generó.
76
+ - **`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`.
77
+ - **Una regla no se ejecutó**: lea el arreglo `skipped`.
78
+ - **`check` informa `manifest-peers` como fallo**: es un problema conocido de `dsh-plugin-dev`; el runtime aplica la compatibilidad al instalar.
79
+ - **Los horarios parecen desplazados**: toda la aritmética es de hora local sobre las cadenas entregadas.
80
+
81
+ ## Development
82
+
83
+ ```sh
84
+ pnpm install
85
+ pnpm run typecheck
86
+ pnpm test
87
+ pnpm run build
88
+ node ../scripts/sync-shared.mjs dsh-eia-guide-check
89
+ ```
90
+
91
+ El último comando copia el kit compartido de `../_shared` a `src/shared/`; vuelva a ejecutarlo tras cada cambio compartido.
92
+
93
+ ## License
94
+
95
+ [Apache License 2.0](LICENSE) © 2026 dsh-eia-guide-check contributors.
package/README-hi.md ADDED
@@ -0,0 +1,95 @@
1
+ # dsh-eia-guide-check
2
+
3
+ **Boundary:** this plugin checks an **环评导则适用性核对表** for traceability — that each environmental element
4
+ names its applicable guideline, that the guideline number follows its published form, that the guideline's status
5
+ comes from your vocabulary, that an assessment method or an applicable standard is recorded, that elements are
6
+ not double-registered, that the sheet names its project and report type, and that no placeholder survives. It does
7
+ **not** decide whether an environmental assessment is compliant, whether the assessment level is right, whether a
8
+ prediction model applies, or whether the conclusions hold.
9
+
10
+ > ### ⚠️ What this plugin deliberately cannot do
11
+ >
12
+ > **It does not contain the guideline catalogue, and it does not map an element onto the guideline that should
13
+ > govern it.** Because of that it **cannot find the most consequential error: using the wrong guideline for an
14
+ > element.** Choosing between HJ 2.2, HJ 2.3, HJ 2.4, HJ 964 and the rest turns on the project's category and the
15
+ > element in question, and confirming it means reading the classification list and each guideline's scope. This
16
+ > limit is stated in the pack's header, in `EG-001`'s note, and in the troubleshooting section below.
17
+ >
18
+ > The 适用导则 column is therefore the register's own statement. Everything here checks what can be checked
19
+ > mechanically: is it written down, does the number look like a guideline number, is the status one you
20
+ > recognise, is a method or standard recorded.
21
+ >
22
+ > **The plugin also ships no current-version table** — tracking which guidelines are in force and which have
23
+ > been superseded means following the ministry's announcements, and the status vocabulary is yours to configure.
24
+ > `EG-002` checks the *form* of a number (`HJ 2.3—2018`) and never whether that number exists, is current, or
25
+ > matches the name next to it.
26
+ >
27
+ > **Every `excerpt` in the rule pack says, in so many words, that the clause text was not obtained** — the
28
+ > verification pass did not retrieve the guidelines' verbatim text, nor verify each one's current version.
29
+ > When the texts are in hand, replace each `excerpt` with the real clause and raise `kind` to `direct`.
30
+
31
+ ## Compatibility
32
+
33
+ | सतह | स्थिति |
34
+ |---|---|
35
+ | 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` जानबूझकर घोषित नहीं**: इसका कोई पाठक नहीं और यह किसी होस्ट को अस्वीकार नहीं कर सकता |
36
+ | Node | `^22.19.0 || >=24.0.0` |
37
+ | प्लेटफ़ॉर्म | सभी (शुद्ध ESM; कोई नेटिव कोड नहीं, कोई नेटवर्क नहीं, कोई मॉडल कॉल नहीं) |
38
+ | टूल मोड | `native`, `ptc` और `both` में काम करता है; पूरे फ़ोल्डर के लिए `ptc` चुनें |
39
+
40
+ ## What it does
41
+
42
+ नियम-सूची, फ़ील्ड और विस्तृत व्यवहार [README.md](README.md#what-it-does) (अंग्रेज़ी मुख्य संस्करण) में हैं। यह प्लगइन केवल उद्धृत धाराओं के सामने शाब्दिक अंतर सूचीबद्ध करता है और हर न चल पाई जाँच को `skipped` में बताता है।
43
+
44
+ ## Install
45
+
46
+ ```sh
47
+ dsh plugin --profile <name> add dsh-eia-guide-check
48
+ dsh --profile <name> --dump-config | grep 'dsh-eia-guide-check'
49
+ ```
50
+
51
+ ## Configuration
52
+
53
+ सभी समायोज्य पैरामीटर `src/config.ts` की Schemastery स्कीमा में हैं, इसलिए कोड बदले बिना `cordis.yml` से बदले जा सकते हैं; प्रति-नियम सीमाएँ `rules/` के नियम-पैक में हैं।
54
+
55
+ | कुंजी | प्रकार | डिफ़ॉल्ट | विवरण |
56
+ |---|---|---|---|
57
+ | `rulesFile` | string | `rules/eia-guide-check.yaml` | नियम-पैक का पथ, पैकेज रूट के सापेक्ष |
58
+ | `disabledRules` | string[] | `[]` | बंद करने वाले नियम id; प्रत्येक `skipped` में दिखता है |
59
+ | `onlyRules` | string[] | `[]` | केवल ये नियम चलाएँ; खाली होने पर सभी नियम चलते हैं |
60
+ | `skipNotes` | string | `""` | हर `skipped` कारण के आगे जोड़ी जाने वाली टिप्पणी |
61
+ | `timeoutMs` | number | `120000` | उपकरण का सहकारी समय-सीमा बजट |
62
+
63
+ ## Material format
64
+
65
+ JSON या YAML स्वीकार्य है। पूरा फ़ील्ड उदाहरण [README.md](README.md#material-format) (अंग्रेज़ी मुख्य संस्करण) में है। पढ़ने की परत में फ़ील्ड वैकल्पिक हैं और जाँच इंजन उन्हें सत्यापित करता है, इसलिए आंशिक निर्यात पर क्रैश के बजाय "अनुपस्थित" श्रेणी के निष्कर्ष मिलते हैं।
66
+
67
+ ## Rule sources
68
+
69
+ नियम-डेटा कोड से अलग है: प्रत्येक नियम में दस्तावेज़, संख्या, स्रोत की अपनी क्रमांकन-प्रणाली के अनुसार धारा, शब्दशः उद्धरण और स्रोत URL होता है। लोडर लागू करता है कि उद्धरण कम से कम आठ अक्षरों का वास्तविक उद्धरण हो, और जिस जाँच का आधार केवल सामान्य सिद्धांत (`kind: derived-from-principle`, अधिकतम `warn`) या स्थानीय नीति (`kind: institutional-configuration`, अधिकतम `info`) हो, उसे कभी `error` घोषित न किया जाए।
70
+
71
+ सत्यापित सीमाएँ और जान-बूझकर **न** कहे गए निष्कर्ष [README.md](README.md#rule-sources) (अंग्रेज़ी मुख्य संस्करण) और `rules/evidence/` में हैं।
72
+
73
+ ## Troubleshooting
74
+
75
+ - **प्लगइन इंस्टॉल हो गया पर टूल दिखता नहीं**: जाँचें कि `main` `lib/index.mjs` पर जाता है और `pnpm run build` ने उसे बनाया है।
76
+ - **`dsh plugin add` असंगत बताकर मना करता है**: peer range `0.1.x` और `0.2.x` दोनों को कवर करती है; बाहर होने पर स्पष्ट छूट दें: `dsh plugin --profile <name> allow-version <pkg@ver> --dsh-version <runtime> --accept-risk`।
77
+ - **कोई नियम नहीं चला**: `skipped` सरणी देखें।
78
+ - **`check` में `manifest-peers` विफल दिखता है**: यह `dsh-plugin-dev` की ज्ञात अपस्ट्रीम समस्या है; रनटाइम इंस्टॉल के समय अनुकूलता लागू करता है।
79
+ - **समय खिसका हुआ लगता है**: सारी गणना दिए गए स्ट्रिंग पर वॉल-क्लॉक है।
80
+
81
+ ## Development
82
+
83
+ ```sh
84
+ pnpm install
85
+ pnpm run typecheck
86
+ pnpm test
87
+ pnpm run build
88
+ node ../scripts/sync-shared.mjs dsh-eia-guide-check
89
+ ```
90
+
91
+ अंतिम कमांड `../_shared` का साझा किट `src/shared/` में कॉपी करता है; हर साझा बदलाव के बाद इसे दोबारा चलाएँ।
92
+
93
+ ## License
94
+
95
+ [Apache License 2.0](LICENSE) © 2026 dsh-eia-guide-check contributors.
package/README-pt.md ADDED
@@ -0,0 +1,95 @@
1
+ # dsh-eia-guide-check
2
+
3
+ **Boundary:** this plugin checks an **环评导则适用性核对表** for traceability — that each environmental element
4
+ names its applicable guideline, that the guideline number follows its published form, that the guideline's status
5
+ comes from your vocabulary, that an assessment method or an applicable standard is recorded, that elements are
6
+ not double-registered, that the sheet names its project and report type, and that no placeholder survives. It does
7
+ **not** decide whether an environmental assessment is compliant, whether the assessment level is right, whether a
8
+ prediction model applies, or whether the conclusions hold.
9
+
10
+ > ### ⚠️ What this plugin deliberately cannot do
11
+ >
12
+ > **It does not contain the guideline catalogue, and it does not map an element onto the guideline that should
13
+ > govern it.** Because of that it **cannot find the most consequential error: using the wrong guideline for an
14
+ > element.** Choosing between HJ 2.2, HJ 2.3, HJ 2.4, HJ 964 and the rest turns on the project's category and the
15
+ > element in question, and confirming it means reading the classification list and each guideline's scope. This
16
+ > limit is stated in the pack's header, in `EG-001`'s note, and in the troubleshooting section below.
17
+ >
18
+ > The 适用导则 column is therefore the register's own statement. Everything here checks what can be checked
19
+ > mechanically: is it written down, does the number look like a guideline number, is the status one you
20
+ > recognise, is a method or standard recorded.
21
+ >
22
+ > **The plugin also ships no current-version table** — tracking which guidelines are in force and which have
23
+ > been superseded means following the ministry's announcements, and the status vocabulary is yours to configure.
24
+ > `EG-002` checks the *form* of a number (`HJ 2.3—2018`) and never whether that number exists, is current, or
25
+ > matches the name next to it.
26
+ >
27
+ > **Every `excerpt` in the rule pack says, in so many words, that the clause text was not obtained** — the
28
+ > verification pass did not retrieve the guidelines' verbatim text, nor verify each one's current version.
29
+ > When the texts are in hand, replace each `excerpt` with the real clause and raise `kind` to `direct`.
30
+
31
+ ## Compatibility
32
+
33
+ | Superfície | Estado |
34
+ |---|---|
35
+ | 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 |
36
+ | Node | `^22.19.0 || >=24.0.0` |
37
+ | Plataformas | Todas (ESM puro; sem código nativo, sem rede, sem chamada ao modelo) |
38
+ | Modo de ferramenta | Funciona em `native`, `ptc` e `both`; para um diretório inteiro use `ptc` |
39
+
40
+ ## What it does
41
+
42
+ 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.
43
+
44
+ ## Install
45
+
46
+ ```sh
47
+ dsh plugin --profile <name> add dsh-eia-guide-check
48
+ dsh --profile <name> --dump-config | grep 'dsh-eia-guide-check'
49
+ ```
50
+
51
+ ## Configuration
52
+
53
+ 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/`.
54
+
55
+ | Chave | Tipo | Padrão | Descrição |
56
+ |---|---|---|---|
57
+ | `rulesFile` | string | `rules/eia-guide-check.yaml` | Caminho do pacote de regras, relativo à raiz do pacote |
58
+ | `disabledRules` | string[] | `[]` | Ids de regras a desativar; cada uma aparece em `skipped` |
59
+ | `onlyRules` | string[] | `[]` | Executar apenas estas regras; vazio executa todas |
60
+ | `skipNotes` | string | `""` | Nota acrescentada a cada motivo de `skipped` |
61
+ | `timeoutMs` | number | `120000` | Orçamento de tempo limite cooperativo da ferramenta |
62
+
63
+ ## Material format
64
+
65
+ 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.
66
+
67
+ ## Rule sources
68
+
69
+ 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`.
70
+
71
+ 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/`.
72
+
73
+ ## Troubleshooting
74
+
75
+ - **O plugin instala mas a ferramenta não aparece**: confirme que `main` resolve para `lib/index.mjs` e que `pnpm run build` o gerou.
76
+ - **`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`.
77
+ - **Uma regra não executou**: leia o arranjo `skipped`.
78
+ - **`check` informa `manifest-peers` como falha**: problema conhecido do `dsh-plugin-dev`; o runtime aplica a compatibilidade na instalação.
79
+ - **Os horários parecem deslocados**: toda a aritmética é de hora local sobre as cadeias fornecidas.
80
+
81
+ ## Development
82
+
83
+ ```sh
84
+ pnpm install
85
+ pnpm run typecheck
86
+ pnpm test
87
+ pnpm run build
88
+ node ../scripts/sync-shared.mjs dsh-eia-guide-check
89
+ ```
90
+
91
+ O último comando copia o kit compartilhado de `../_shared` para `src/shared/`; execute-o novamente após cada alteração compartilhada.
92
+
93
+ ## License
94
+
95
+ [Apache License 2.0](LICENSE) © 2026 dsh-eia-guide-check contributors.
package/README-zh.md ADDED
@@ -0,0 +1,95 @@
1
+ # dsh-eia-guide-check
2
+
3
+ **Boundary:** this plugin checks an **环评导则适用性核对表** for traceability — that each environmental element
4
+ names its applicable guideline, that the guideline number follows its published form, that the guideline's status
5
+ comes from your vocabulary, that an assessment method or an applicable standard is recorded, that elements are
6
+ not double-registered, that the sheet names its project and report type, and that no placeholder survives. It does
7
+ **not** decide whether an environmental assessment is compliant, whether the assessment level is right, whether a
8
+ prediction model applies, or whether the conclusions hold.
9
+
10
+ > ### ⚠️ What this plugin deliberately cannot do
11
+ >
12
+ > **It does not contain the guideline catalogue, and it does not map an element onto the guideline that should
13
+ > govern it.** Because of that it **cannot find the most consequential error: using the wrong guideline for an
14
+ > element.** Choosing between HJ 2.2, HJ 2.3, HJ 2.4, HJ 964 and the rest turns on the project's category and the
15
+ > element in question, and confirming it means reading the classification list and each guideline's scope. This
16
+ > limit is stated in the pack's header, in `EG-001`'s note, and in the troubleshooting section below.
17
+ >
18
+ > The 适用导则 column is therefore the register's own statement. Everything here checks what can be checked
19
+ > mechanically: is it written down, does the number look like a guideline number, is the status one you
20
+ > recognise, is a method or standard recorded.
21
+ >
22
+ > **The plugin also ships no current-version table** — tracking which guidelines are in force and which have
23
+ > been superseded means following the ministry's announcements, and the status vocabulary is yours to configure.
24
+ > `EG-002` checks the *form* of a number (`HJ 2.3—2018`) and never whether that number exists, is current, or
25
+ > matches the name next to it.
26
+ >
27
+ > **Every `excerpt` in the rule pack says, in so many words, that the clause text was not obtained** — the
28
+ > verification pass did not retrieve the guidelines' verbatim text, nor verify each one's current version.
29
+ > When the texts are in hand, replace each `excerpt` with the real clause and raise `kind` to `direct`.
30
+
31
+ ## Compatibility
32
+
33
+ | 项目 | 状态 |
34
+ |---|---|
35
+ | 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`**:它没有任何读取者,也无法拒装任何宿主 |
36
+ | Node | `^22.19.0 || >=24.0.0` |
37
+ | 平台 | 全平台(纯 ESM;无原生代码、无联网、不调用模型) |
38
+ | 工具模式 | `native` / `ptc` / `both` 均可;批量校验整个目录时建议 `ptc`,schema 成本只付一次 |
39
+
40
+ ## What it does
41
+
42
+ 规则表、字段说明与行为细节见 [README.md](README.md#what-it-does)(英文主版本)。本插件只列出材料与所引条款之间的字面差异,并对无法执行的检查在 `skipped` 中逐项说明。
43
+
44
+ ## Install
45
+
46
+ ```sh
47
+ dsh plugin --profile <name> add dsh-eia-guide-check
48
+ dsh --profile <name> --dump-config | grep 'dsh-eia-guide-check'
49
+ ```
50
+
51
+ ## Configuration
52
+
53
+ 全部可调参数都在 `src/config.ts` 的 Schemastery schema 中,只改 `cordis.yml` 即可生效,无需改代码;逐条阈值在 `rules/` 下的规则库文件里。
54
+
55
+ | 键 | 类型 | 默认值 | 说明 |
56
+ |---|---|---|---|
57
+ | `rulesFile` | string | `rules/eia-guide-check.yaml` | 规则库文件路径,相对插件包根目录 |
58
+ | `disabledRules` | string[] | `[]` | 要停用的规则 id 列表;每条都会出现在 `skipped` 中 |
59
+ | `onlyRules` | string[] | `[]` | 只执行这些规则 id;留空表示执行全部规则 |
60
+ | `skipNotes` | string | `""` | 附加到每条 `skipped` 说明后的备注 |
61
+ | `timeoutMs` | number | `120000` | 工具协作式超时预算(毫秒) |
62
+
63
+ ## Material format
64
+
65
+ 支持 JSON 与 YAML。完整字段示例见 [README.md](README.md#material-format)(英文主版本)。字段在读取层是可选的,由检查引擎校验,因此部分导出的材料会产生"缺项"类差异,而不是让程序崩溃。
66
+
67
+ ## Rule sources
68
+
69
+ 规则数据与代码分离,每条规则都带文件名、文号、按原文自身编号体系的条款号、逐字摘录与来源地址。加载期强制:摘录必须是真实引文且不少于八个字符;依据仅为原则性条款(`kind: derived-from-principle`,严重级上限 `warn`)或本机构配置(`kind: institutional-configuration`,上限 `info`)的检查不得标为 `error`。夸大依据的规则库会在加载期失败,而不会产出一份看起来很有底气的报告。
70
+
71
+ 核验中确认的边界与"刻意没有作出的结论"见 [README.md](README.md#rule-sources)(英文主版本)与随包的 `rules/evidence/` 目录。
72
+
73
+ ## Troubleshooting
74
+
75
+ - **插件装上了但工具不出现**:确认 `main` 指向 `lib/index.mjs` 且 `pnpm run build` 已生成该文件;`main` 写错会让加载器静默跳过该条目。
76
+ - **`dsh plugin add` 报版本不兼容**:peer 范围覆盖 `0.1.x` 与 `0.2.x`;若运行时在其之外,可显式豁免:`dsh plugin --profile <name> allow-version <包名@版本> --dsh-version <runtime> --accept-risk`
77
+ - **某条规则没有执行**:查看 `skipped` 数组,其中写明了规则 id 与原因。
78
+ - **`check` 报 `manifest-peers` 失败**:静态检查器比对的是一份早于 0.2 世代的硬编码 peer 范围;安装期的 peer 校验以运行时为准。这是 `dsh-plugin-dev` 的已知上游问题。
79
+ - **时间看起来偏移**:全部计算都是对输入字符串做墙上时钟运算,不做时区换算。
80
+
81
+ ## Development
82
+
83
+ ```sh
84
+ pnpm install
85
+ pnpm run typecheck
86
+ pnpm test
87
+ pnpm run build
88
+ node ../scripts/sync-shared.mjs dsh-eia-guide-check
89
+ ```
90
+
91
+ 第 4 项把 `../_shared` 的共享件同步进 `src/shared/`;每次改动共享件后都要重跑。
92
+
93
+ ## License
94
+
95
+ [Apache License 2.0](LICENSE) © 2026 dsh-eia-guide-check contributors.
package/README.md CHANGED
@@ -1,3 +1,141 @@
1
- # Temporary Holding Version
1
+ # dsh-eia-guide-check
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 an **环评导则适用性核对表** for traceability — that each environmental element
4
+ names its applicable guideline, that the guideline number follows its published form, that the guideline's status
5
+ comes from your vocabulary, that an assessment method or an applicable standard is recorded, that elements are
6
+ not double-registered, that the sheet names its project and report type, and that no placeholder survives. It does
7
+ **not** decide whether an environmental assessment is compliant, whether the assessment level is right, whether a
8
+ prediction model applies, or whether the conclusions hold.
9
+
10
+ > ### ⚠️ What this plugin deliberately cannot do
11
+ >
12
+ > **It does not contain the guideline catalogue, and it does not map an element onto the guideline that should
13
+ > govern it.** Because of that it **cannot find the most consequential error: using the wrong guideline for an
14
+ > element.** Choosing between HJ 2.2, HJ 2.3, HJ 2.4, HJ 964 and the rest turns on the project's category and the
15
+ > element in question, and confirming it means reading the classification list and each guideline's scope. This
16
+ > limit is stated in the pack's header, in `EG-001`'s note, and in the troubleshooting section below.
17
+ >
18
+ > The 适用导则 column is therefore the register's own statement. Everything here checks what can be checked
19
+ > mechanically: is it written down, does the number look like a guideline number, is the status one you
20
+ > recognise, is a method or standard recorded.
21
+ >
22
+ > **The plugin also ships no current-version table** — tracking which guidelines are in force and which have
23
+ > been superseded means following the ministry's announcements, and the status vocabulary is yours to configure.
24
+ > `EG-002` checks the *form* of a number (`HJ 2.3—2018`) and never whether that number exists, is current, or
25
+ > matches the name next to it.
26
+ >
27
+ > **Every `excerpt` in the rule pack says, in so many words, that the clause text was not obtained** — the
28
+ > verification pass did not retrieve the guidelines' verbatim text, nor verify each one's current version.
29
+ > When the texts are in hand, replace each `excerpt` with the real clause and raise `kind` to `direct`.
30
+
31
+ ## Compatibility
32
+
33
+ | Surface | Status |
34
+ |---|---|
35
+ | 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 |
36
+ | Node | `^22.19.0 || >=24.0.0` |
37
+ | Platforms | All (plain ESM; no native code, no network, no model call) |
38
+ | Tool mode | Works in `native`, `ptc` and `both`; for a full assessment sheet use `ptc` |
39
+
40
+ ## What it does
41
+
42
+ Registers the `eia_guide_check` tool. It reads one guideline-applicability sheet — the project header plus one row
43
+ per element — applies a versioned rule pack, and returns a report.
44
+
45
+ | Rule | Check | Severity | Basis kind |
46
+ |---|---|---|---|
47
+ | `EG-001` | each element names its applicable guideline | warn | principle |
48
+ | `EG-002` | the guideline number follows its published form | warn | principle |
49
+ | `EG-003` | the guideline status comes from your vocabulary (off by default) | info | local |
50
+ | `EG-004` | a method or an applicable standard is recorded | warn | principle |
51
+ | `EG-005` | elements are not double-registered | warn | principle |
52
+ | `EG-006` | the sheet names its project and report type | warn | principle |
53
+ | `EG-007` | the standard column holds no unreplaced placeholder | warn | principle |
54
+
55
+ ## Install
56
+
57
+ ```sh
58
+ dsh plugin --profile <name> add dsh-eia-guide-check
59
+ dsh --profile <name> --dump-config | grep 'dsh-eia-guide-check'
60
+ ```
61
+
62
+ ## Configuration
63
+
64
+ | Key | Type | Default | Description |
65
+ |---|---|---|---|
66
+ | `rulesFile` | string | `rules/eia-guide-check.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
+ - `EG-002` `pattern` — the number's shape, `HJ 数字(可带小数)—四位年份` by default. Widen it if your
75
+ register writes numbers another way.
76
+ - `EG-003` `values` — your status vocabulary, e.g. `[现行, 已废止, 被替代, 部分适用]`. Empty means no check;
77
+ no current-version table is built in.
78
+ - `EG-007` `terms` — the placeholders to look for.
79
+
80
+ ## Material format
81
+
82
+ The tool accepts JSON or YAML:
83
+
84
+ ```yaml
85
+ project: 某某建设项目
86
+ industry: 某某行业
87
+ reportType: 报告书
88
+ compiler: 某某环评单位
89
+ rows:
90
+ - { 序号: '1', 评价要素: 环境空气, 导则名称: 环境影响评价技术导则 大气环境,
91
+ 导则编号代码: HJ 2.2—2018, 导则状态: 现行, 应用章节: 第 5 章 大气环境影响预测与评价,
92
+ 评价方法: AERMOD 预测模式, 评价范围: 二级评价,边长 5 km 矩形,
93
+ 评价因子: PM10、PM2.5、SO2、NOx, 执行标准: GB 3095—2012 环境空气质量标准 }
94
+ ```
95
+
96
+ Column names are matched case-insensitively and ignoring spaces, underscores and hyphens; the sheet's own column
97
+ names are kept, so a finding names the column it read.
98
+
99
+ ## Rule sources
100
+
101
+ Rule data lives in `rules/eia-guide-check.yaml`. Its header explains that the plugin holds no guideline
102
+ catalogue, does no element-to-guideline mapping, and did not verify each guideline's current version. The
103
+ load-time guard still requires a document, clause, excerpt and source per rule, and still forbids a
104
+ principle-derived or locally configured check from being `error`.
105
+
106
+ ## Troubleshooting
107
+
108
+ - **It did not flag the wrong guideline for an element.** By design: it has no catalogue and never maps an
109
+ element to one. Confirm against the classification list and each guideline's scope yourself.
110
+ - **`EG-002` passes a number I know is withdrawn.** The check reads the number's form, never its validity or
111
+ currency. Tracking versions is a different job.
112
+ - **`EG-002` fires on a number I wrote correctly.** The pattern wants the `HJ` prefix, the number, and a
113
+ four-digit year separated by a dash or em dash. Adjust the pattern, or fix the cell.
114
+ - **`EG-003` never runs.** Its vocabulary is empty; fill it with the statuses your quality system uses.
115
+ - **`EG-005` fires on two rows for one element.** Assessing one element by medium (surface water quality and
116
+ sediment, for instance) is legitimate — write the sub-item into the element name rather than deleting a row.
117
+ - **The plugin installs but the tool never appears.** Check that `main` resolves to `lib/index.mjs` and
118
+ that `pnpm run build` produced it; a wrong `main` makes the loader skip the entry silently.
119
+ - **`dsh plugin add` refuses the package as incompatible.** The peer range covers `0.1.x` and `0.2.x`; if
120
+ your runtime sits outside it, grant an explicit exemption:
121
+ `dsh plugin --profile <name> allow-version dsh-eia-guide-check@0.1.0 --dsh-version <runtime> --accept-risk`
122
+ - **`check` reports `manifest-peers` as failed.** The static checker compares against a hard-coded peer
123
+ range that predates the 0.2 line. The runtime enforces peer compatibility at install time, so the
124
+ declared range is the correct one; this is a known upstream issue in `dsh-plugin-dev`.
125
+
126
+ ## Development
127
+
128
+ ```sh
129
+ pnpm install
130
+ pnpm run typecheck # tsc --noEmit
131
+ pnpm test # vitest, the shared table-plugin suite plus paired fixtures
132
+ pnpm run build # tsdown -> lib/index.mjs + lib/index.d.mts
133
+ node ../scripts/sync-shared.mjs dsh-eia-guide-check # refresh src/shared from ../_shared
134
+ ```
135
+
136
+ The plugin is **data-only**: `src/model.ts` declares the table shape, the shared kit supplies the reader and
137
+ the check engine, and the rule pack declares every check.
138
+
139
+ ## License
140
+
141
+ [Apache License 2.0](LICENSE) © 2026 dsh-eia-guide-check contributors.
package/SECURITY.md ADDED
@@ -0,0 +1,39 @@
1
+ # Security Policy
2
+
3
+ ## Reporting a vulnerability
4
+
5
+ Please report security vulnerabilities **privately** through GitHub's private
6
+ vulnerability reporting:
7
+
8
+ **Security → Report a vulnerability** at
9
+ https://github.com/PerryLink/dsh-eia-guide-check/security/advisories/new
10
+
11
+ Do **not** open a public issue for security findings.
12
+
13
+ Before reporting, **sanitize everything you paste**: remove tokens, API keys,
14
+ credentials, authorization headers, session contents, and personal data. Logs
15
+ without secrets only.
16
+
17
+ ## Scope note
18
+
19
+ This plugin is an offline checker. It reads the material you hand it and
20
+ compares it against a versioned rule pack; it makes no network calls and no
21
+ model calls, and it stores nothing.
22
+
23
+ ## What to include
24
+
25
+ - affected package version (and DeepSeek Harness runtime version)
26
+ - a minimal reproduction
27
+ - your impact assessment
28
+
29
+ ## Response expectations
30
+
31
+ - acknowledgement within **7 days**
32
+ - status updates at least every **14 days** until resolution
33
+ - coordinated disclosure: the fix and advisory are prepared first; the finding
34
+ is disclosed publicly after the fix ships
35
+
36
+ ## Credits and disclosure
37
+
38
+ - reporters are credited in the advisory and CHANGELOG unless they ask to stay anonymous
39
+ - advisories follow GitHub's advisory workflow and are published together with the fix
@@ -0,0 +1,8 @@
1
+ # dsh-eia-guide-check 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-eia-guide-check
8
+ name: dsh-eia-guide-check
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="EIA guideline 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>