Skip to content

Commit

Permalink
Other (docs): Support for passing an array of files to ignore when pr…
Browse files Browse the repository at this point in the history
…eparing API.
  • Loading branch information
pomek committed Sep 23, 2024
1 parent 833ac92 commit 3c85828
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion packages/ckeditor5-dev-docs/lib/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,12 @@ export default async function build( config ) {
const sourceFilePatterns = config.sourceFiles.filter( Boolean );
const strictMode = config.strict || false;
const extraPlugins = config.extraPlugins || [];
const ignoreFiles = config.ignoreFiles || [];
const validatorOptions = config.validatorOptions || {};

const files = await glob( sourceFilePatterns );
const files = await glob( sourceFilePatterns, {
ignore: ignoreFiles
} );
const typeDoc = new TypeDoc.Application();

typeDoc.options.addReader( new TypeDoc.TSConfigReader() );
Expand Down Expand Up @@ -101,6 +104,8 @@ export default async function build( config ) {
*
* @property {Array.<String>} sourceFiles Glob pattern with source files.
*
* @property {Array.<String>} [ignoreFiles=[]] Glob pattern with files to ignore.
*
* @property {Boolean} [strict=false] If `true`, errors found during the validation will finish the process
* and exit code will be changed to `1`.
* @property {String} [outputPath] A path to the place where extracted doclets will be saved. Is an optional value due to tests.
Expand Down

0 comments on commit 3c85828

Please sign in to comment.