@hadden-industries/markdown-quality 0.1.0-alpha.2
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 +661 -0
- package/LICENSES/MIT-universal-ontology.txt +9 -0
- package/README.md +45 -0
- package/THIRD-PARTY-NOTICES.md +34 -0
- package/assets/native-build.json +56 -0
- package/assets/native-rights.json +1832 -0
- package/assets/snapper.toml +4 -0
- package/assets/tool-manifest.json +1897 -0
- package/docs/ci-trust.md +40 -0
- package/docs/consumer-guide.md +87 -0
- package/docs/support-and-release.md +72 -0
- package/package.json +51 -0
- package/schemas/configuration.schema.json +48 -0
- package/schemas/result.schema.json +247 -0
- package/src/analysis.js +119 -0
- package/src/cli.js +85 -0
- package/src/configuration.js +123 -0
- package/src/contracts.js +55 -0
- package/src/document-analysis.js +79 -0
- package/src/document-worker.js +30 -0
- package/src/documents.js +136 -0
- package/src/formatting.js +44 -0
- package/src/native-tool.js +135 -0
- package/src/prose-diagnostics.js +58 -0
- package/src/quality.js +156 -0
- package/src/replacement.js +62 -0
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Markdown quality
|
|
2
|
+
|
|
3
|
+
This package supplies one CLI and library for Markdown layout, sentence lines, GFM linting, and contained local links.
|
|
4
|
+
Consumers declare their authored-document scope in `.markdown-quality.json`.
|
|
5
|
+
The package preserves the existing AGPL-3.0-only license.
|
|
6
|
+
|
|
7
|
+
The current version is a candidate for public alpha distribution.
|
|
8
|
+
Controlled native component clearance and Windows/Linux packed qualification passed for the retained binaries.
|
|
9
|
+
The public package tuple requires fresh registry qualification before use; both accepted pilots and recovery evidence still block stable v1.0.
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
markdown-quality check --root /path/to/repository
|
|
13
|
+
markdown-quality format --root /path/to/repository
|
|
14
|
+
markdown-quality inspect --root /path/to/repository --json
|
|
15
|
+
markdown-quality check --root /path/to/repository -- "docs/literal [1].md"
|
|
16
|
+
markdown-quality check --root /path/to/repository --files-json '[]'
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Checks never install tools or write documents.
|
|
20
|
+
Formatting validates the complete selected batch before any replacement.
|
|
21
|
+
It checks each file's original identity and bytes immediately before replacing it.
|
|
22
|
+
A failure after earlier replacements reports the completed and unprocessed paths.
|
|
23
|
+
Formatting is not a whole-batch transaction.
|
|
24
|
+
|
|
25
|
+
Read the [consumer guide](docs/consumer-guide.md) for configuration and installation.
|
|
26
|
+
The [support and release guide](docs/support-and-release.md) describes compatibility and release gates.
|
|
27
|
+
The [third-party notices](THIRD-PARTY-NOTICES.md) distinguish package code from upstream assets.
|
|
28
|
+
|
|
29
|
+
Development uses Node 24.21.0 and an existing Python 3.14 interpreter for asset preparation.
|
|
30
|
+
Consumers need no Python interpreter.
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
npm ci --ignore-scripts
|
|
34
|
+
python scripts/prepare-native.py --archives /path/to/verified/archives
|
|
35
|
+
npm test
|
|
36
|
+
npm run check:full
|
|
37
|
+
node scripts/pack.js /path/to/output
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
The builder accepts the frozen `snapper-windows.zip` and `snapper-linux.tar.xz` archives.
|
|
41
|
+
It verifies archive and executable hashes before copying fixed regular members.
|
|
42
|
+
Build acquisition is explicit; product operations never acquire executables.
|
|
43
|
+
|
|
44
|
+
Changed-document checking and a shared GitHub Action are deferred.
|
|
45
|
+
Required v1.0 checks always inspect the full authored scope.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Third-party notices
|
|
2
|
+
|
|
3
|
+
Package-owned implementation is AGPL-3.0-only.
|
|
4
|
+
The original repository license is retained byte-for-byte.
|
|
5
|
+
The narrow list-boundary recheck in `src/prose-diagnostics.js` adapts OwlAPI's approach at `1cdc5a33b9538cce8ced88f21af18138da7a8923`, originally from universal-ontology at `58a306013d3701f59dfe34341e96fac5a011e3ed`.
|
|
6
|
+
Copyright 2026 Hadden Industries Ltd; original MIT terms are retained in `LICENSES/MIT-universal-ontology.txt`.
|
|
7
|
+
The qualification tests are authored here.
|
|
8
|
+
|
|
9
|
+
| Direct runtime dependency | Version | Declared license |
|
|
10
|
+
| --------------------------- | ------- | --------------------------------- |
|
|
11
|
+
| Prettier | 3.9.9 | MIT |
|
|
12
|
+
| ESLint | 10.12.0 | MIT |
|
|
13
|
+
| ESLint Markdown | 8.0.3 | MIT |
|
|
14
|
+
| Ajv | 8.20.0 | MIT |
|
|
15
|
+
| mdast-util-from-markdown | 2.1.0 | MIT |
|
|
16
|
+
| mdast-util-gfm | 3.1.0 | MIT |
|
|
17
|
+
| micromark-extension-gfm | 3.0.0 | MIT |
|
|
18
|
+
| picomatch | 4.0.7 | MIT |
|
|
19
|
+
| Snapper upstream executable | 0.11.9 | MIT, Copyright 2026 Rohit Goswami |
|
|
20
|
+
|
|
21
|
+
Installed npm packages retain their upstream license files.
|
|
22
|
+
The lockfile freezes their exact integrity identities.
|
|
23
|
+
Native packages retain `LICENSE.snapper` and a fixed executable/repack component record.
|
|
24
|
+
The AGPL declaration applies to the packaging implementation and does not relabel upstream executable bytes.
|
|
25
|
+
|
|
26
|
+
Controlled native build run `37274204161` binds Snapper source, Cargo inputs, Rust toolchain and the exact Windows/Linux executable hashes.
|
|
27
|
+
Both native packages retain the original component inventories, complete harvested notices, official Rust runtime copyright report and unchanged MPL-2.0 `webpki-roots` 0.25.4 source.
|
|
28
|
+
The separately recorded [rights supplement](assets/native-rights.json) restores original notices omitted from published crate archives, including native per-file copyright comments.
|
|
29
|
+
Every native archive and package includes its exact `rights-evidence.json` and readable `SUPPLEMENTAL-NOTICES.txt`.
|
|
30
|
+
Independent reconciliation cleared the identified attribution gaps; the original hosted evidence remains unchanged.
|
|
31
|
+
Registry distribution still requires actual platform and packed-consumer qualification, restricted publication and readback.
|
|
32
|
+
No complete rights clearance or SLSA level is claimed from a hash or upstream MIT declaration alone.
|
|
33
|
+
|
|
34
|
+
Primary authorities: [Snapper license](https://github.com/TurtleTech-ehf/snapper/blob/v0.11.9/LICENSE), [Snapper source manifest](https://github.com/TurtleTech-ehf/snapper/blob/v0.11.9/Cargo.toml), [npm lock semantics](https://docs.npmjs.com/cli/v12/configuring-npm/package-lock-json/), and [AGPL text](https://www.gnu.org/licenses/agpl.en.html).
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": 1,
|
|
3
|
+
"sourceCommit": "407c2beb04607f6ccb421e6f6418dcc00e4c1e94",
|
|
4
|
+
"lockSha256": "ae679d5bed2cf65a72e422448bb7de70f9893ae4755f1d87ee38b3c27cfeb85d",
|
|
5
|
+
"manifestSha256": "58f9c619a86a9b8f1bb776c4c3022e393a5c596260cf44c5b40272833ec400ff",
|
|
6
|
+
"rust": "1.98.1",
|
|
7
|
+
"rustSourceCommit": "48a229ceaefd4985c50990b14116b6d856af0985",
|
|
8
|
+
"rustRuntimeLicenseInputs": [
|
|
9
|
+
{
|
|
10
|
+
"path": "LICENSE-MIT",
|
|
11
|
+
"url": "https://raw.githubusercontent.com/rust-lang/rust/48a229ceaefd4985c50990b14116b6d856af0985/LICENSE-MIT",
|
|
12
|
+
"sha256": "b71bd43a069ca0641a9ecfe585ca7b3c53b5cc1608f8b68321168698e28b5ea1"
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"path": "LICENSE-APACHE",
|
|
16
|
+
"url": "https://raw.githubusercontent.com/rust-lang/rust/48a229ceaefd4985c50990b14116b6d856af0985/LICENSE-APACHE",
|
|
17
|
+
"sha256": "62c7a1e35f56406896d7aa7ca52d0cc0d272ac022b5d2796e7d6905db8a3636a"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"path": "LICENSES/Unicode-3.0.txt",
|
|
21
|
+
"url": "https://raw.githubusercontent.com/rust-lang/rust/48a229ceaefd4985c50990b14116b6d856af0985/LICENSES/Unicode-3.0.txt",
|
|
22
|
+
"sha256": "f5062c9a188d81dfe66b56db4182dcf9e4b17c0d9b0d311a8e20b3a1b075c443"
|
|
23
|
+
}
|
|
24
|
+
],
|
|
25
|
+
"profile": "dist",
|
|
26
|
+
"features": ["cli", "neural", "lsp", "watch", "pandoc", "treesitter", "mcp"],
|
|
27
|
+
"auditExtractor": {
|
|
28
|
+
"url": "https://static.crates.io/crates/rust-audit-info/rust-audit-info-0.5.4.crate",
|
|
29
|
+
"sha256": "4691a1a98b31dc5c7b55a2968628c79ed035b1fad6b3b3849d872244e04bcf83",
|
|
30
|
+
"sourceCommit": "17fc93a92a952cc5e715bc51afc25e11049d7036"
|
|
31
|
+
},
|
|
32
|
+
"tools": {
|
|
33
|
+
"win32-x64": {
|
|
34
|
+
"target": "x86_64-pc-windows-msvc",
|
|
35
|
+
"cargo-auditable": {
|
|
36
|
+
"url": "https://github.com/rust-secure-code/cargo-auditable/releases/download/v0.7.7/cargo-auditable-x86_64-pc-windows-msvc.zip",
|
|
37
|
+
"sha256": "717ba2d3ed7997c501e9987ee7c94bebf9d7219b18b185a03009420ec7029c7d"
|
|
38
|
+
},
|
|
39
|
+
"cargo-about": {
|
|
40
|
+
"url": "https://github.com/EmbarkStudios/cargo-about/releases/download/0.9.2/cargo-about-0.9.2-x86_64-pc-windows-msvc.tar.gz",
|
|
41
|
+
"sha256": "1c03e5890238562497c2d89a3b75b02560af349c1fc3e713d3284f532a5cd748"
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
"linux-x64": {
|
|
45
|
+
"target": "x86_64-unknown-linux-gnu",
|
|
46
|
+
"cargo-auditable": {
|
|
47
|
+
"url": "https://github.com/rust-secure-code/cargo-auditable/releases/download/v0.7.7/cargo-auditable-x86_64-unknown-linux-gnu.tar.xz",
|
|
48
|
+
"sha256": "4c8d3b08c3c34e9f2333367224dbbfb4aab68067698b43de59fe19aded3416dd"
|
|
49
|
+
},
|
|
50
|
+
"cargo-about": {
|
|
51
|
+
"url": "https://github.com/EmbarkStudios/cargo-about/releases/download/0.9.2/cargo-about-0.9.2-x86_64-unknown-linux-musl.tar.gz",
|
|
52
|
+
"sha256": "9099a59e820c38a68b9d65f300662a567d56562f9a10f6aa4c7e86c17c2566af"
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|