@docusaurus/utils-validation 2.0.0-beta.21 → 2.0.0-beta.22
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.
|
@@ -8,7 +8,7 @@ import Joi from './Joi';
|
|
|
8
8
|
export declare const PluginIdSchema: Joi.StringSchema;
|
|
9
9
|
export declare const RemarkPluginsSchema: Joi.ArraySchema;
|
|
10
10
|
export declare const RehypePluginsSchema: Joi.ArraySchema;
|
|
11
|
-
export declare const AdmonitionsSchema: Joi.
|
|
11
|
+
export declare const AdmonitionsSchema: Joi.AlternativesSchema;
|
|
12
12
|
export declare const URISchema: Joi.AlternativesSchema;
|
|
13
13
|
export declare const PathnameSchema: Joi.StringSchema;
|
|
14
14
|
export declare const FrontMatterTagsSchema: Joi.ArraySchema;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validationSchemas.d.ts","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,GAAG,MAAM,OAAO,CAAC;AAGxB,eAAO,MAAM,cAAc,kBAKE,CAAC;AAe9B,eAAO,MAAM,mBAAmB,iBAAwB,CAAC;AACzD,eAAO,MAAM,mBAAmB,iBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"validationSchemas.d.ts","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,GAAG,MAAM,OAAO,CAAC;AAGxB,eAAO,MAAM,cAAc,kBAKE,CAAC;AAe9B,eAAO,MAAM,mBAAmB,iBAAwB,CAAC;AACzD,eAAO,MAAM,mBAAmB,iBAAwB,CAAC;AAQzD,eAAO,MAAM,iBAAiB,wBAkB1B,CAAC;AAIL,eAAO,MAAM,SAAS,wBAgBpB,CAAC;AAEH,eAAO,MAAM,cAAc,kBASxB,CAAC;AAeJ,eAAO,MAAM,qBAAqB,iBAK9B,CAAC;AAEL,eAAO,MAAM,2BAA2B;;;CASvC,CAAC"}
|
package/lib/validationSchemas.js
CHANGED
|
@@ -25,7 +25,24 @@ const MarkdownPluginsSchema = Joi_1.default.array()
|
|
|
25
25
|
.default([]);
|
|
26
26
|
exports.RemarkPluginsSchema = MarkdownPluginsSchema;
|
|
27
27
|
exports.RehypePluginsSchema = MarkdownPluginsSchema;
|
|
28
|
-
|
|
28
|
+
const LegacyAdmonitionConfigSchema = Joi_1.default.forbidden().messages({
|
|
29
|
+
'any.unknown': `The Docusaurus admonitions system has changed, and the option {#label} does not exist anymore.
|
|
30
|
+
You now need to swizzle the admonitions component to provide UI customizations such as icons.
|
|
31
|
+
Please refer to https://github.com/facebook/docusaurus/pull/7152 for detailed upgrade instructions.`,
|
|
32
|
+
});
|
|
33
|
+
exports.AdmonitionsSchema = JoiFrontMatter_1.JoiFrontMatter.alternatives()
|
|
34
|
+
.try(JoiFrontMatter_1.JoiFrontMatter.boolean().required(), JoiFrontMatter_1.JoiFrontMatter.object({
|
|
35
|
+
tag: JoiFrontMatter_1.JoiFrontMatter.string(),
|
|
36
|
+
keywords: JoiFrontMatter_1.JoiFrontMatter.array().items(JoiFrontMatter_1.JoiFrontMatter.string().required()),
|
|
37
|
+
// TODO Remove before 2023
|
|
38
|
+
customTypes: LegacyAdmonitionConfigSchema,
|
|
39
|
+
icons: LegacyAdmonitionConfigSchema,
|
|
40
|
+
infima: LegacyAdmonitionConfigSchema,
|
|
41
|
+
}).required())
|
|
42
|
+
.default(true)
|
|
43
|
+
.messages({
|
|
44
|
+
'alternatives.types': '{{#label}} does not look like a valid admonitions config',
|
|
45
|
+
});
|
|
29
46
|
// TODO how can we make this emit a custom error message :'(
|
|
30
47
|
// Joi is such a pain, good luck to annoying trying to improve this
|
|
31
48
|
exports.URISchema = Joi_1.default.alternatives(Joi_1.default.string().uri({ allowRelative: true }),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validationSchemas.js","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,6CAA+E;AAC/E,wDAAwB;AACxB,qDAAgD;AAEnC,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,EAAE;KACvC,KAAK,CAAC,UAAU,CAAC;KACjB,OAAO,CACN,oGAAoG,CACrG;KACA,OAAO,CAAC,yBAAiB,CAAC,CAAC;AAE9B,MAAM,qBAAqB,GAAG,aAAG,CAAC,KAAK,EAAE;KACtC,KAAK,CACJ,aAAG,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,aAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,aAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,EACpE,aAAG,CAAC,QAAQ,EAAE,EACd,aAAG,CAAC,MAAM,EAAE,CACb;KACA,QAAQ,CAAC;IACR,gBAAgB,EAAE;;mDAE6B;CAChD,CAAC;KACD,OAAO,CAAC,EAAE,CAAC,CAAC;AAEF,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AAC5C,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"validationSchemas.js","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,6CAA+E;AAC/E,wDAAwB;AACxB,qDAAgD;AAEnC,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,EAAE;KACvC,KAAK,CAAC,UAAU,CAAC;KACjB,OAAO,CACN,oGAAoG,CACrG;KACA,OAAO,CAAC,yBAAiB,CAAC,CAAC;AAE9B,MAAM,qBAAqB,GAAG,aAAG,CAAC,KAAK,EAAE;KACtC,KAAK,CACJ,aAAG,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,aAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,aAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,EACpE,aAAG,CAAC,QAAQ,EAAE,EACd,aAAG,CAAC,MAAM,EAAE,CACb;KACA,QAAQ,CAAC;IACR,gBAAgB,EAAE;;mDAE6B;CAChD,CAAC;KACD,OAAO,CAAC,EAAE,CAAC,CAAC;AAEF,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AAC5C,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AAEzD,MAAM,4BAA4B,GAAG,aAAG,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC;IAC5D,aAAa,EAAE;;oGAEmF;CACnG,CAAC,CAAC;AAEU,QAAA,iBAAiB,GAAG,+BAAc,CAAC,YAAY,EAAE;KAC3D,GAAG,CACF,+BAAc,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EACnC,+BAAc,CAAC,MAAM,CAAC;IACpB,GAAG,EAAE,+BAAc,CAAC,MAAM,EAAE;IAC5B,QAAQ,EAAE,+BAAc,CAAC,KAAK,EAAE,CAAC,KAAK,CACpC,+BAAc,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CACnC;IACD,0BAA0B;IAC1B,WAAW,EAAE,4BAA4B;IACzC,KAAK,EAAE,4BAA4B;IACnC,MAAM,EAAE,4BAA4B;CACrC,CAAC,CAAC,QAAQ,EAAE,CACd;KACA,OAAO,CAAC,IAAI,CAAC;KACb,QAAQ,CAAC;IACR,oBAAoB,EAClB,0DAA0D;CAC7D,CAAC,CAAC;AAEL,4DAA4D;AAC5D,oEAAoE;AACvD,QAAA,SAAS,GAAG,aAAG,CAAC,YAAY,CACvC,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC;AACvC,wEAAwE;AACxE,+BAA+B;AAC/B,aAAG,CAAC,MAAM,CAAC,CAAC,GAAY,EAAE,OAAO,EAAE,EAAE;IACnC,IAAI;QACF,kCAAkC;QAClC,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACrB,OAAO,GAAG,CAAC;KACZ;IAAC,MAAM;QACN,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;KACrC;AACH,CAAC,CAAC,CACH,CAAC,QAAQ,CAAC;IACT,oBAAoB,EAClB,gEAAgE;CACnE,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,EAAE;KACvC,MAAM,CAAC,CAAC,GAAW,EAAE,EAAE;IACtB,IAAI,CAAC,IAAA,uBAAe,EAAC,GAAG,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,EAAE,CAAC;KACnB;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;KACD,OAAO,CACN,kHAAkH,CACnH,CAAC;AAEJ,MAAM,oBAAoB,GAAG,+BAAc,CAAC,YAAY,EAAE;KACvD,GAAG,CACF,+BAAc,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAClC,+BAAc,CAAC,MAAM,CAAM;IACzB,KAAK,EAAE,+BAAc,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,SAAS,EAAE,+BAAc,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9C,CAAC,CAAC,QAAQ,EAAE,CACd;KACA,QAAQ,CAAC;IACR,oBAAoB,EAAE,2CAA2C;IACjE,oBAAoB,EAAE,2CAA2C;CAClE,CAAC,CAAC;AAEQ,QAAA,qBAAqB,GAAG,+BAAc,CAAC,KAAK,EAAE;KACxD,KAAK,CAAC,oBAAoB,CAAC;KAC3B,QAAQ,CAAC;IACR,YAAY,EACV,gEAAgE;CACnE,CAAC,CAAC;AAEQ,QAAA,2BAA2B,GAAG;IACzC,qBAAqB,EAAE,+BAAc,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,uBAAuB,EAAE;QAC3E,EAAE,EAAE,+BAAc,CAAC,KAAK,EAAE;QAC1B,IAAI,EAAE,+BAAc,CAAC,MAAM,EAAE;aAC1B,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,+BAAc,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACnD,SAAS,EAAE,+BAAc,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KACjD,CAAC;IACF,qBAAqB,EAAE,+BAAc,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CAC7D,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/utils-validation",
|
|
3
|
-
"version": "2.0.0-beta.
|
|
3
|
+
"version": "2.0.0-beta.22",
|
|
4
4
|
"description": "Node validation utility functions for Docusaurus packages.",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"types": "./lib/index.d.ts",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
},
|
|
19
19
|
"license": "MIT",
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@docusaurus/logger": "2.0.0-beta.
|
|
22
|
-
"@docusaurus/utils": "2.0.0-beta.
|
|
21
|
+
"@docusaurus/logger": "2.0.0-beta.22",
|
|
22
|
+
"@docusaurus/utils": "2.0.0-beta.22",
|
|
23
23
|
"joi": "^17.6.0",
|
|
24
24
|
"js-yaml": "^4.1.0",
|
|
25
25
|
"tslib": "^2.4.0"
|
|
@@ -27,5 +27,5 @@
|
|
|
27
27
|
"engines": {
|
|
28
28
|
"node": ">=16.14"
|
|
29
29
|
},
|
|
30
|
-
"gitHead": "
|
|
30
|
+
"gitHead": "daf9e462c4eebb7ac26a940932311f987e768f87"
|
|
31
31
|
}
|
package/src/validationSchemas.ts
CHANGED
|
@@ -32,7 +32,31 @@ const MarkdownPluginsSchema = Joi.array()
|
|
|
32
32
|
export const RemarkPluginsSchema = MarkdownPluginsSchema;
|
|
33
33
|
export const RehypePluginsSchema = MarkdownPluginsSchema;
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
const LegacyAdmonitionConfigSchema = Joi.forbidden().messages({
|
|
36
|
+
'any.unknown': `The Docusaurus admonitions system has changed, and the option {#label} does not exist anymore.
|
|
37
|
+
You now need to swizzle the admonitions component to provide UI customizations such as icons.
|
|
38
|
+
Please refer to https://github.com/facebook/docusaurus/pull/7152 for detailed upgrade instructions.`,
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
export const AdmonitionsSchema = JoiFrontMatter.alternatives()
|
|
42
|
+
.try(
|
|
43
|
+
JoiFrontMatter.boolean().required(),
|
|
44
|
+
JoiFrontMatter.object({
|
|
45
|
+
tag: JoiFrontMatter.string(),
|
|
46
|
+
keywords: JoiFrontMatter.array().items(
|
|
47
|
+
JoiFrontMatter.string().required(),
|
|
48
|
+
),
|
|
49
|
+
// TODO Remove before 2023
|
|
50
|
+
customTypes: LegacyAdmonitionConfigSchema,
|
|
51
|
+
icons: LegacyAdmonitionConfigSchema,
|
|
52
|
+
infima: LegacyAdmonitionConfigSchema,
|
|
53
|
+
}).required(),
|
|
54
|
+
)
|
|
55
|
+
.default(true)
|
|
56
|
+
.messages({
|
|
57
|
+
'alternatives.types':
|
|
58
|
+
'{{#label}} does not look like a valid admonitions config',
|
|
59
|
+
});
|
|
36
60
|
|
|
37
61
|
// TODO how can we make this emit a custom error message :'(
|
|
38
62
|
// Joi is such a pain, good luck to annoying trying to improve this
|