@docusaurus/utils-validation 4.0.0-canary-6937 → 4.0.0-canary-6939
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.
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* This source code is licensed under the MIT license found in the
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
|
-
import { type
|
|
7
|
+
import { type FrontMatterLastUpdate } from '@docusaurus/utils';
|
|
8
8
|
import Joi from './Joi';
|
|
9
9
|
export declare const PluginIdSchema: Joi.StringSchema<string>;
|
|
10
10
|
export declare const RemarkPluginsSchema: Joi.ArraySchema<any[]>;
|
|
@@ -14,7 +14,7 @@ export declare const AdmonitionsSchema: Joi.AlternativesSchema<any>;
|
|
|
14
14
|
export declare const URISchema: Joi.AlternativesSchema<any>;
|
|
15
15
|
export declare const PathnameSchema: Joi.StringSchema<string>;
|
|
16
16
|
export declare const RouteBasePathSchema: Joi.AlternativesSchema<string>;
|
|
17
|
-
export declare const FrontMatterTagsSchema: Joi.ArraySchema<
|
|
17
|
+
export declare const FrontMatterTagsSchema: Joi.ArraySchema<string[]>;
|
|
18
18
|
export declare const FrontMatterTOCHeadingLevels: {
|
|
19
19
|
toc_min_heading_level: Joi.NumberSchema<number>;
|
|
20
20
|
toc_max_heading_level: Joi.NumberSchema<number>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validationSchemas.d.ts","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAGL,KAAK,
|
|
1
|
+
{"version":3,"file":"validationSchemas.d.ts","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAGL,KAAK,qBAAqB,EAC3B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,GAAG,MAAM,OAAO,CAAC;AAGxB,eAAO,MAAM,cAAc,0BAKE,CAAC;AAe9B,eAAO,MAAM,mBAAmB,wBAAwB,CAAC;AACzD,eAAO,MAAM,mBAAmB,wBAAwB,CAAC;AACzD,eAAO,MAAM,kBAAkB,wBAAwB,CAAC;AAExD,eAAO,MAAM,iBAAiB,6BAqB1B,CAAC;AAIL,eAAO,MAAM,SAAS,6BAiBpB,CAAC;AAEH,eAAO,MAAM,cAAc,0BASxB,CAAC;AAaJ,eAAO,MAAM,mBAAmB,gCAO7B,CAAC;AAQJ,eAAO,MAAM,qBAAqB,2BAK9B,CAAC;AAEL,eAAO,MAAM,2BAA2B;IACtC,qBAAqB;IAOrB,qBAAqB;CACtB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,eAAO,MAAM,uBAAuB,qCAiBxB,CAAC;AAEb,eAAO,MAAM,iCAAiC,sIACuF,CAAC;AAEtI,eAAO,MAAM,2BAA2B,yCAapC,CAAC"}
|
package/lib/validationSchemas.js
CHANGED
|
@@ -83,17 +83,10 @@ exports.RouteBasePathSchema = Joi_1.default
|
|
|
83
83
|
.custom((value) =>
|
|
84
84
|
// /!\ do not add trailing slash here
|
|
85
85
|
(0, utils_common_1.addLeadingSlash)(value));
|
|
86
|
-
const FrontMatterTagSchema = JoiFrontMatter_1.JoiFrontMatter.
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
JoiFrontMatter_1.JoiFrontMatter.object({
|
|
91
|
-
label: JoiFrontMatter_1.JoiFrontMatter.string().required(),
|
|
92
|
-
permalink: JoiFrontMatter_1.JoiFrontMatter.string().required(),
|
|
93
|
-
}).required())
|
|
94
|
-
.messages({
|
|
95
|
-
'alternatives.match': '{{#label}} does not look like a valid tag',
|
|
96
|
-
'alternatives.types': '{{#label}} does not look like a valid tag',
|
|
86
|
+
const FrontMatterTagSchema = JoiFrontMatter_1.JoiFrontMatter.string().messages({
|
|
87
|
+
'string.base': `{{#label}} does not look like a valid tag: front matter tags must be strings.
|
|
88
|
+
Tag objects with a custom label or permalink are not supported anymore: declare tags in a tags file (usually tags.yml) and reference them by key instead.
|
|
89
|
+
See https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#tags-file`,
|
|
97
90
|
});
|
|
98
91
|
exports.FrontMatterTagsSchema = JoiFrontMatter_1.JoiFrontMatter.array()
|
|
99
92
|
.items(FrontMatterTagSchema)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validationSchemas.js","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,
|
|
1
|
+
{"version":3,"file":"validationSchemas.js","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,6CAI2B;AAC3B,2DAAyD;AACzD,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;AAC5C,QAAA,kBAAkB,GAAG,qBAAqB,CAAC;AAE3C,QAAA,iBAAiB,GAAG,+BAAc,CAAC,YAAY,EAAE;KAC3D,GAAG,CACF,+BAAc,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EACnC,+BAAc,CAAC,MAAM,CAAC;IACpB,QAAQ,EAAE,+BAAc,CAAC,KAAK,EAAE,CAAC,KAAK,CACpC,+BAAc,CAAC,MAAM,EAAE,CAGxB;IACD,cAAc,EAAE,+BAAc,CAAC,OAAO,EAAE;IAExC,0BAA0B;IAC1B,GAAG,EAAE,aAAG,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC;QAClC,aAAa,EAAE,mIAAmI;KACnJ,CAAC;CACH,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,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACnC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACjB,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,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,CAAC;QAC1B,MAAM,IAAI,KAAK,EAAE,CAAC;IACpB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;KACD,OAAO,CACN,+HAA+H,CAChI,CAAC;AAEJ,sEAAsE;AACtE,mCAAmC;AACnC,yEAAyE;AACzE,EAAE;AACF,YAAY;AACZ,YAAY;AACZ,oBAAoB;AACpB,qBAAqB;AACrB,qBAAqB;AACrB,kCAAkC;AAClC,mEAAmE;AACtD,QAAA,mBAAmB,GAAG,aAAG;IACpC,kEAAkE;KACjE,YAAY,EAAE;KACd,GAAG,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KACtC,MAAM,CAAC,CAAC,KAAa,EAAE,EAAE;AACxB,qCAAqC;AACrC,IAAA,8BAAe,EAAC,KAAK,CAAC,CACvB,CAAC;AAEJ,MAAM,oBAAoB,GAAG,+BAAc,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC;IAC5D,aAAa,EAAE;;qFAEoE;CACpF,CAAC,CAAC;AAEU,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;AAOW,QAAA,uBAAuB,GAAG,+BAAc,CAAC,MAAM,CAG1D;IACA,KAAK,EAAE,+BAAc,CAAC,OAAO,EAAE;IAC/B,QAAQ,EAAE,+BAAc,CAAC,OAAO,EAAE;CACnC,CAAC;KACC,MAAM,CAAC,CAAC,WAA8B,EAAE,OAAO,EAAE,EAAE;IAClD,IAAI,WAAW,CAAC,KAAK,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;QAC9C,OAAO,OAAO,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;KACD,QAAQ,CAAC;IACR,mCAAmC,EACjC,+CAA+C;CAClD,CAAC;KACD,OAAO,EAAE,CAAC;AAEA,QAAA,iCAAiC,GAC5C,mIAAmI,CAAC;AAEzH,QAAA,2BAA2B,GAAG,aAAG,CAAC,MAAM,CAGnD;IACA,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE;IACpB,kDAAkD;IAClD,iEAAiE;IACjE,IAAI,EAAE,aAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,aAAG,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC;CAC/C,CAAC;KACC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;KACpB,QAAQ,CAAC;IACR,gBAAgB,EAAE,QAAA,iCAAiC;IACnD,aAAa,EAAE,QAAA,iCAAiC;CACjD,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/utils-validation",
|
|
3
|
-
"version": "4.0.0-canary-
|
|
3
|
+
"version": "4.0.0-canary-6939",
|
|
4
4
|
"description": "Node validation utility functions for Docusaurus packages.",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"types": "./lib/index.d.ts",
|
|
@@ -14,10 +14,10 @@
|
|
|
14
14
|
},
|
|
15
15
|
"license": "MIT",
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@docusaurus/fs": "4.0.0-canary-
|
|
18
|
-
"@docusaurus/logger": "4.0.0-canary-
|
|
19
|
-
"@docusaurus/utils": "4.0.0-canary-
|
|
20
|
-
"@docusaurus/utils-common": "4.0.0-canary-
|
|
17
|
+
"@docusaurus/fs": "4.0.0-canary-6939",
|
|
18
|
+
"@docusaurus/logger": "4.0.0-canary-6939",
|
|
19
|
+
"@docusaurus/utils": "4.0.0-canary-6939",
|
|
20
|
+
"@docusaurus/utils-common": "4.0.0-canary-6939",
|
|
21
21
|
"joi": "^18.2.8",
|
|
22
22
|
"js-yaml": "^5.4.1",
|
|
23
23
|
"lodash": "^4.18.1",
|
package/src/validationSchemas.ts
CHANGED
|
@@ -8,7 +8,6 @@
|
|
|
8
8
|
import {
|
|
9
9
|
isValidPathname,
|
|
10
10
|
DEFAULT_PLUGIN_ID,
|
|
11
|
-
type FrontMatterTag,
|
|
12
11
|
type FrontMatterLastUpdate,
|
|
13
12
|
} from '@docusaurus/utils';
|
|
14
13
|
import {addLeadingSlash} from '@docusaurus/utils-common';
|
|
@@ -114,20 +113,11 @@ export const RouteBasePathSchema = Joi
|
|
|
114
113
|
addLeadingSlash(value),
|
|
115
114
|
);
|
|
116
115
|
|
|
117
|
-
const FrontMatterTagSchema = JoiFrontMatter.
|
|
118
|
-
.
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
JoiFrontMatter.object<FrontMatterTag>({
|
|
123
|
-
label: JoiFrontMatter.string().required(),
|
|
124
|
-
permalink: JoiFrontMatter.string().required(),
|
|
125
|
-
}).required(),
|
|
126
|
-
)
|
|
127
|
-
.messages({
|
|
128
|
-
'alternatives.match': '{{#label}} does not look like a valid tag',
|
|
129
|
-
'alternatives.types': '{{#label}} does not look like a valid tag',
|
|
130
|
-
});
|
|
116
|
+
const FrontMatterTagSchema = JoiFrontMatter.string().messages({
|
|
117
|
+
'string.base': `{{#label}} does not look like a valid tag: front matter tags must be strings.
|
|
118
|
+
Tag objects with a custom label or permalink are not supported anymore: declare tags in a tags file (usually tags.yml) and reference them by key instead.
|
|
119
|
+
See https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#tags-file`,
|
|
120
|
+
});
|
|
131
121
|
|
|
132
122
|
export const FrontMatterTagsSchema = JoiFrontMatter.array()
|
|
133
123
|
.items(FrontMatterTagSchema)
|