Files
documentation/node_modules/@docusaurus/plugin-sitemap/lib/options.js
2024-03-22 03:47:51 +05:30

40 lines
1.7 KiB
JavaScript

"use strict";
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
const utils_validation_1 = require("@docusaurus/utils-validation");
const sitemap_1 = require("sitemap");
exports.DEFAULT_OPTIONS = {
changefreq: sitemap_1.EnumChangefreq.WEEKLY,
priority: 0.5,
ignorePatterns: [],
filename: 'sitemap.xml',
};
const PluginOptionSchema = utils_validation_1.Joi.object({
// @ts-expect-error: forbidden
cacheTime: utils_validation_1.Joi.forbidden().messages({
'any.unknown': 'Option `cacheTime` in sitemap config is deprecated. Please remove it.',
}),
changefreq: utils_validation_1.Joi.string()
.valid(...Object.values(sitemap_1.EnumChangefreq))
.default(exports.DEFAULT_OPTIONS.changefreq),
priority: utils_validation_1.Joi.number().min(0).max(1).default(exports.DEFAULT_OPTIONS.priority),
ignorePatterns: utils_validation_1.Joi.array()
.items(utils_validation_1.Joi.string())
.default(exports.DEFAULT_OPTIONS.ignorePatterns),
trailingSlash: utils_validation_1.Joi.forbidden().messages({
'any.unknown': 'Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it.',
}),
filename: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.filename),
});
function validateOptions({ validate, options, }) {
const validatedOptions = validate(PluginOptionSchema, options);
return validatedOptions;
}
exports.validateOptions = validateOptions;