@ckeditor/ckeditor5-dev-docs 44.0.0-alpha.4 → 44.0.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/lib/build.js +11 -11
- package/lib/validators/fires-validator/index.js +2 -2
- package/lib/validators/index.js +3 -3
- package/lib/validators/link-validator/index.js +2 -2
- package/lib/validators/module-validator/index.js +2 -2
- package/lib/validators/overloads-validator/index.js +2 -2
- package/lib/validators/see-validator/index.js +2 -2
- package/package.json +3 -3
package/lib/build.js
CHANGED
|
@@ -94,29 +94,29 @@ export default async function build( config ) {
|
|
|
94
94
|
}
|
|
95
95
|
|
|
96
96
|
/**
|
|
97
|
-
* @typedef {
|
|
97
|
+
* @typedef {object} TypedocConfig
|
|
98
98
|
*
|
|
99
|
-
* @property {
|
|
99
|
+
* @property {object} config
|
|
100
100
|
*
|
|
101
|
-
* @property {
|
|
101
|
+
* @property {string} cwd
|
|
102
102
|
*
|
|
103
|
-
* @property {
|
|
103
|
+
* @property {string} tsconfig
|
|
104
104
|
*
|
|
105
|
-
* @property {Array.<
|
|
105
|
+
* @property {Array.<string>} sourceFiles Glob pattern with source files.
|
|
106
106
|
*
|
|
107
|
-
* @property {Array.<
|
|
107
|
+
* @property {Array.<string>} [ignoreFiles=[]] Glob pattern with files to ignore.
|
|
108
108
|
*
|
|
109
|
-
* @property {
|
|
109
|
+
* @property {boolean} [strict=false] If `true`, errors found during the validation will finish the process
|
|
110
110
|
* and exit code will be changed to `1`.
|
|
111
|
-
* @property {
|
|
111
|
+
* @property {string} [outputPath] A path to the place where extracted doclets will be saved. Is an optional value due to tests.
|
|
112
112
|
*
|
|
113
|
-
* @property {
|
|
113
|
+
* @property {string} [extraPlugins=[]] An array of path to extra plugins that will be added to Typedoc.
|
|
114
114
|
*
|
|
115
115
|
* @property {TypedocValidator} [validatorOptions={}] An optional configuration object for validator.
|
|
116
116
|
*/
|
|
117
117
|
|
|
118
118
|
/**
|
|
119
|
-
* @typedef {
|
|
119
|
+
* @typedef {object} TypedocValidator
|
|
120
120
|
*
|
|
121
|
-
* @property {
|
|
121
|
+
* @property {boolean} [enableOverloadValidator=false] If set to `true`, the overloads validator will be enabled.
|
|
122
122
|
*/
|
|
@@ -11,8 +11,8 @@ import typedocPlugins from '@ckeditor/typedoc-plugins';
|
|
|
11
11
|
*
|
|
12
12
|
* It checks if the event in the "@fires" tag exists.
|
|
13
13
|
*
|
|
14
|
-
* @param {
|
|
15
|
-
* @param {
|
|
14
|
+
* @param {object} project Generated output from TypeDoc to validate.
|
|
15
|
+
* @param {function} onError A callback that is executed when a validation error is detected.
|
|
16
16
|
*/
|
|
17
17
|
export default function validate( project, onError ) {
|
|
18
18
|
const { utils } = typedocPlugins;
|
package/lib/validators/index.js
CHANGED
|
@@ -13,10 +13,10 @@ import overloadsValidator from './overloads-validator/index.js';
|
|
|
13
13
|
/**
|
|
14
14
|
* Validates the CKEditor 5 documentation.
|
|
15
15
|
*
|
|
16
|
-
* @param {
|
|
17
|
-
* @param {
|
|
16
|
+
* @param {object} project Generated output from TypeDoc to validate.
|
|
17
|
+
* @param {object} typeDoc A TypeDoc application instance.
|
|
18
18
|
* @param {TypedocValidator} [options={}] A configuration object.
|
|
19
|
-
* @returns {
|
|
19
|
+
* @returns {boolean}
|
|
20
20
|
*/
|
|
21
21
|
export default {
|
|
22
22
|
validate( project, typeDoc, options = {} ) {
|
|
@@ -11,8 +11,8 @@ import typedocPlugins from '@ckeditor/typedoc-plugins';
|
|
|
11
11
|
*
|
|
12
12
|
* It checks if the identifier in the "@link" tag points to an existing doclet.
|
|
13
13
|
*
|
|
14
|
-
* @param {
|
|
15
|
-
* @param {
|
|
14
|
+
* @param {object} project Generated output from TypeDoc to validate.
|
|
15
|
+
* @param {function} onError A callback that is executed when a validation error is detected.
|
|
16
16
|
*/
|
|
17
17
|
export default function validate( project, onError ) {
|
|
18
18
|
const { utils } = typedocPlugins;
|
|
@@ -13,8 +13,8 @@ const AUGMENTATION_MODULE_REGEXP = /[^\\/]+[\\/]src[\\/]augmentation/;
|
|
|
13
13
|
*
|
|
14
14
|
* It checks if the module name matches the path to the file where the module is defined.
|
|
15
15
|
*
|
|
16
|
-
* @param {
|
|
17
|
-
* @param {
|
|
16
|
+
* @param {object} project Generated output from TypeDoc to validate.
|
|
17
|
+
* @param {function} onError A callback that is executed when a validation error is detected.
|
|
18
18
|
*/
|
|
19
19
|
export default function validate( project, onError ) {
|
|
20
20
|
const { utils } = typedocPlugins;
|
|
@@ -16,8 +16,8 @@ import typedocPlugins from '@ckeditor/typedoc-plugins';
|
|
|
16
16
|
*
|
|
17
17
|
* Also, it prevents using the same name twice for overloaded structures.
|
|
18
18
|
*
|
|
19
|
-
* @param {
|
|
20
|
-
* @param {
|
|
19
|
+
* @param {object} project Generated output from TypeDoc to validate.
|
|
20
|
+
* @param {function} onError A callback that is executed when a validation error is detected.
|
|
21
21
|
*/
|
|
22
22
|
export default function validate( project, onError ) {
|
|
23
23
|
const { utils } = typedocPlugins;
|
|
@@ -11,8 +11,8 @@ import typedocPlugins from '@ckeditor/typedoc-plugins';
|
|
|
11
11
|
*
|
|
12
12
|
* It checks if the identifier in the "@see" tag points to an existing doclet.
|
|
13
13
|
*
|
|
14
|
-
* @param {
|
|
15
|
-
* @param {
|
|
14
|
+
* @param {object} project Generated output from TypeDoc to validate.
|
|
15
|
+
* @param {function} onError A callback that is executed when a validation error is detected.
|
|
16
16
|
*/
|
|
17
17
|
export default function validate( project, onError ) {
|
|
18
18
|
const { utils } = typedocPlugins;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ckeditor/ckeditor5-dev-docs",
|
|
3
|
-
"version": "44.0.0
|
|
3
|
+
"version": "44.0.0",
|
|
4
4
|
"description": "Tasks used to build and verify the documentation for CKEditor 5.",
|
|
5
5
|
"keywords": [],
|
|
6
6
|
"author": "CKSource (http://cksource.com/)",
|
|
@@ -22,8 +22,8 @@
|
|
|
22
22
|
"lib"
|
|
23
23
|
],
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@ckeditor/ckeditor5-dev-utils": "^44.0.0
|
|
26
|
-
"@ckeditor/typedoc-plugins": "^44.0.0
|
|
25
|
+
"@ckeditor/ckeditor5-dev-utils": "^44.0.0",
|
|
26
|
+
"@ckeditor/typedoc-plugins": "^44.0.0",
|
|
27
27
|
"glob": "^10.0.0",
|
|
28
28
|
"fs-extra": "^11.0.0",
|
|
29
29
|
"tmp": "^0.2.1",
|