@ckeditor/ckeditor5-dev-manual-server 56.3.0 → 56.4.0

package/dist/index.d.ts

@@ -3,7 +3,7 @@
 * For licensing, see LICENSE.md.
 */
 export { manualTestsPlugin } from "./manual-test-plugin/plugin.js";
-export type { ManualData } from "./manual-test-plugin/plugin.js";
+export type { ManualData, ManualTestsPluginOptions } from "./manual-test-plugin/plugin.js";
 export { refreshPlugin } from "./refresh-plugin/plugin.js";
 export { rawHtmlPlugin } from "./raw-plugin/plugin.js";
 export { stringifyValues } from "./utils.js";

package/dist/index.js

@@ -312,13 +312,15 @@ const MANUAL_CATALOG_FILE_PATH = resolve(MANUAL_THEME_ROOT, "catalog.html");
 const MANUAL_CATALOG_SCRIPT_FILE_PATH = resolve(MANUAL_THEME_ROOT, "catalog.ts");
 const MANUAL_SHELL_TEMPLATE_FILE_PATH = resolve(MANUAL_THEME_ROOT, "shell.html");
 const MANUAL_SHELL_SCRIPT_FILE_PATH = resolve(MANUAL_THEME_ROOT, "shell.ts");
-function manualTestsPlugin(manualTestPatterns) {
+function manualTestsPlugin(options) {
 	let workspaceRoot = process.cwd();
 	let base = "/";
+	const manualTestPatterns = options.paths;
 	const manualPagePatterns = manualTestPatterns.map(toManualPagePattern);
-	const manualPagesCache = cacheValue(() => collectManualPages(manualPagePatterns, workspaceRoot));
-	const manualStaticAssetsCache = cacheValue(() => collectManualStaticAssets(manualTestPatterns, workspaceRoot));
+	const includePackageNames = (options.include || []).filter(Boolean);
+	const manualPagesCache = cacheValue(() => filterManualPages(collectManualPages(manualPagePatterns, workspaceRoot), includePackageNames));
 	const getManualPages = manualPagesCache.get;
+	const manualStaticAssetsCache = cacheValue(() => collectManualStaticAssets(getManualStaticAssetPatterns(getManualPages(), manualTestPatterns, includePackageNames), workspaceRoot));
 	const getManualStaticAssets = manualStaticAssetsCache.get;
 	const invalidateManualFileCaches = () => {
 		manualPagesCache.invalidate();
@@ -327,8 +329,8 @@ function manualTestsPlugin(manualTestPatterns) {
 	const getManualPageEntryForFile = (filePath) => {
 		return getManualPages().get(toPublicSpecifier(relative(workspaceRoot, filePath)));
 	};
-	const getManualCatalogPublicPath = () => toPublicFilePath(MANUAL_CATALOG_FILE_PATH, workspaceRoot);
 	const getManualCatalogBuildInputFilePath = () => resolve(workspaceRoot, "index.html");
+	const getManualCatalogPublicPath = () => toPublicFilePath(getManualCatalogBuildInputFilePath(), workspaceRoot);
 	const getManualCatalogScriptPublicPath = () => toPublicFilePath(MANUAL_CATALOG_SCRIPT_FILE_PATH, workspaceRoot);
 	const getManualShellScriptPublicPath = () => toPublicFilePath(MANUAL_SHELL_SCRIPT_FILE_PATH, workspaceRoot);
 	const getManualCatalogClientPath = (entry) => toBaseCatalogPath(base, entry.htmlFilePath);
@@ -429,6 +431,23 @@ function toManualPagePattern(pattern) {
 	if (/\.(?:html|js|md|ts|\{[^}]*\})$/.test(pattern)) return pattern;
 	return `${pattern}.{html,js,md,ts}`;
 }
+function filterManualPages(manualPages, includePackageNames) {
+	if (includePackageNames.length == 0) return manualPages;
+	const normalizedIncludePackageNames = new Set(includePackageNames.map(normalizePackageName));
+	return new Map([...manualPages].filter(([, entry]) => normalizedIncludePackageNames.has(normalizePackageName(entry.packageName))));
+}
+function normalizePackageName(packageName) {
+	return packageName.replace(/^ckeditor5-/, "");
+}
+function getManualStaticAssetPatterns(manualPages, manualTestPatterns, includePackageNames) {
+	if (includePackageNames.length == 0) return manualTestPatterns;
+	return [...new Set([...manualPages.values()].map(getManualTestRootDirectory))].map((manualTestRootDirectory) => `${manualTestRootDirectory}/**/*`);
+}
+function getManualTestRootDirectory(entry) {
+	const htmlFilePath = stripLeadingSlash(entry.htmlFilePath);
+	const manualDirectoryIndex = htmlFilePath.indexOf("/tests/manual/");
+	return htmlFilePath.slice(0, manualDirectoryIndex + 14 - 1);
+}
 function isManualCatalogHtmlFile(filePath, catalogBuildInputFilePath) {
 	const normalizedFilePath = toPosixPath(filePath);
 	return normalizedFilePath == toPosixPath(MANUAL_CATALOG_FILE_PATH) || normalizedFilePath == toPosixPath(catalogBuildInputFilePath);

package/dist/manual-test-plugin/plugin.d.ts

@@ -4,4 +4,8 @@
 */
 import type { Plugin } from "vite";
 export type { ManualData } from "./types.js";
-export declare function manualTestsPlugin(manualTestPatterns: Array<string>): Plugin;
+export interface ManualTestsPluginOptions {
+	paths: Array<string>;
+	include?: Array<string>;
+}
+export declare function manualTestsPlugin(options: ManualTestsPluginOptions): Plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-manual-server",
-  "version": "56.3.0",
+  "version": "56.4.0",
   "description": "Used to extend Vite to create a manual test server for CKEditor 5.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",