@millstone/synapse-schemas 0.1.0 → 0.4.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/README.md +8 -8
- package/package.json +14 -4
package/README.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
# @synapse
|
|
1
|
+
# @millstone/synapse-schemas
|
|
2
2
|
|
|
3
3
|
JSON Schema definitions for the Synapse documentation framework.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @synapse
|
|
8
|
+
npm install @millstone/synapse-schemas
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
This package is also installed automatically as a dependency of `@synapse
|
|
11
|
+
This package is also installed automatically as a dependency of `@millstone/synapse-cli`.
|
|
12
12
|
|
|
13
13
|
## Usage
|
|
14
14
|
|
|
@@ -22,7 +22,7 @@ import {
|
|
|
22
22
|
getFrontmatterSchemaDir,
|
|
23
23
|
getBodyGrammarDir,
|
|
24
24
|
getPluginSchemaDir
|
|
25
|
-
} from '@synapse
|
|
25
|
+
} from '@millstone/synapse-schemas';
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
### Direct imports
|
|
@@ -30,8 +30,8 @@ import {
|
|
|
30
30
|
Import schema files directly using subpath exports:
|
|
31
31
|
|
|
32
32
|
```js
|
|
33
|
-
import adrSchema from '@synapse
|
|
34
|
-
import adrGrammar from '@synapse
|
|
33
|
+
import adrSchema from '@millstone/synapse-schemas/frontmatter/adr.schema.json' assert { type: 'json' };
|
|
34
|
+
import adrGrammar from '@millstone/synapse-schemas/body-grammars/adr.body-grammar.json' assert { type: 'json' };
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
## Schema Categories
|
|
@@ -58,10 +58,10 @@ Available schemas: marketplace, plugin.
|
|
|
58
58
|
|
|
59
59
|
## Schema Cascade Resolution
|
|
60
60
|
|
|
61
|
-
When used with `@synapse
|
|
61
|
+
When used with `@millstone/synapse-cli`, schemas are resolved using a cascade:
|
|
62
62
|
|
|
63
63
|
1. **Local override**: `{projectRoot}/schemas/frontmatter/{name}.schema.json`
|
|
64
|
-
2. **This package**: Standard schemas bundled in `@synapse
|
|
64
|
+
2. **This package**: Standard schemas bundled in `@millstone/synapse-schemas`
|
|
65
65
|
3. **Error**: With a helpful message
|
|
66
66
|
|
|
67
67
|
This allows projects to override individual schemas for customization while using the standard set as a fallback.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@millstone/synapse-schemas",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "JSON Schema definitions for Synapse documentation framework",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -18,7 +18,9 @@
|
|
|
18
18
|
"index.js",
|
|
19
19
|
"README.md"
|
|
20
20
|
],
|
|
21
|
-
"publishConfig": {
|
|
21
|
+
"publishConfig": {
|
|
22
|
+
"access": "public"
|
|
23
|
+
},
|
|
22
24
|
"repository": {
|
|
23
25
|
"type": "git",
|
|
24
26
|
"url": "https://github.com/millstonehq/synapse.git",
|
|
@@ -28,7 +30,15 @@
|
|
|
28
30
|
"bugs": {
|
|
29
31
|
"url": "https://github.com/millstonehq/synapse/issues"
|
|
30
32
|
},
|
|
31
|
-
"keywords": [
|
|
32
|
-
|
|
33
|
+
"keywords": [
|
|
34
|
+
"synapse",
|
|
35
|
+
"schemas",
|
|
36
|
+
"json-schema",
|
|
37
|
+
"documentation",
|
|
38
|
+
"validation"
|
|
39
|
+
],
|
|
40
|
+
"engines": {
|
|
41
|
+
"node": ">=20.0.0"
|
|
42
|
+
},
|
|
33
43
|
"license": "MIT"
|
|
34
44
|
}
|