@docusaurus/core 0.0.0-4895 → 0.0.0-4900

package/lib/commands/swizzle/components.js

@@ -18,6 +18,25 @@ const common_1 = require("./common");
 const tables_1 = require("./tables");
 const actions_1 = require("./actions");
 const formatComponentName = (componentName) => componentName.replace(/[/\\]index\.[jt]sx?/, '').replace(/\.[jt]sx?/, '');
+function sortComponentNames(componentNames) {
+    return componentNames.sort(); // Algo may change?
+}
+/**
+ * Expand a list of components to include and return parent folders.
+ * If a folder is not directly a component (no Folder/index.tsx file),
+ * we still want to be able to swizzle --eject that folder.
+ * See https://github.com/facebook/docusaurus/pull/7175#issuecomment-1103757218
+ *
+ * @param componentNames the original list of component names
+ */
+function getMissingIntermediateComponentFolderNames(componentNames) {
+    function getAllIntermediatePaths(componentName) {
+        const paths = componentName.split('/');
+        return lodash_1.default.range(1, paths.length + 1).map((i) => paths.slice(0, i).join('/'));
+    }
+    const expandedComponentNames = lodash_1.default.uniq(componentNames.flatMap((componentName) => getAllIntermediatePaths(componentName)));
+    return lodash_1.default.difference(expandedComponentNames, componentNames);
+}
 const skipReadDirNames = ['__test__', '__tests__', '__mocks__', '__fixtures__'];
 async function readComponentNames(themePath) {
     if (!(await fs_extra_1.default.pathExists(themePath))) {
@@ -48,8 +67,8 @@ async function readComponentNames(themePath) {
         }))).flat();
     }
     const componentFiles = await walk(themePath);
-    const componentFilesOrdered = lodash_1.default.orderBy(componentFiles, [(f) => f.componentName], ['asc']);
-    return componentFilesOrdered.map((f) => f.componentName);
+    const componentNames = componentFiles.map((f) => f.componentName);
+    return sortComponentNames(componentNames);
 }
 exports.readComponentNames = readComponentNames;
 function listComponentNames(themeComponents) {
@@ -72,11 +91,30 @@ async function getThemeComponents({ themeName, themePath, swizzleConfig, }) {
         },
         description: FallbackSwizzleComponentDescription,
     };
-    const allComponents = await readComponentNames(themePath);
+    const FallbackIntermediateFolderSwizzleComponentConfig = {
+        actions: {
+            // It doesn't make sense to wrap an intermediate folder
+            // because it has not any index component
+            wrap: 'forbidden',
+            eject: FallbackSwizzleActionStatus,
+        },
+        description: FallbackSwizzleComponentDescription,
+    };
+    const allInitialComponents = await readComponentNames(themePath);
+    const missingIntermediateComponentFolderNames = getMissingIntermediateComponentFolderNames(allInitialComponents);
+    const allComponents = sortComponentNames(allInitialComponents.concat(missingIntermediateComponentFolderNames));
     function getConfig(component) {
         if (!allComponents.includes(component)) {
             throw new Error(`Can't get component config: component doesn't exist: ${component}`);
         }
+        const config = swizzleConfig.components[component];
+        if (config) {
+            return config;
+        }
+        const isIntermediateFolder = missingIntermediateComponentFolderNames.includes(component);
+        if (isIntermediateFolder) {
+            return FallbackIntermediateFolderSwizzleComponentConfig;
+        }
         return (swizzleConfig.components[component] ?? FallbackSwizzleComponentConfig);
     }
     function getDescription(component) {

package/lib/commands/swizzle/config.js

@@ -36,20 +36,23 @@ function getModuleSwizzleConfig(swizzlePlugin) {
     }
     return undefined;
 }
-function normalizeSwizzleConfig(unsafeSwizzleConfig) {
-    const schema = utils_validation_1.Joi.object({
-        components: utils_validation_1.Joi.object()
-            .pattern(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
-            actions: utils_validation_1.Joi.object().pattern(utils_validation_1.Joi.string().valid(...common_1.SwizzleActions), utils_validation_1.Joi.string().valid(...common_1.SwizzleActionsStatuses)),
-            description: utils_validation_1.Joi.string(),
-        }))
-            .required(),
-    });
-    const result = schema.validate(unsafeSwizzleConfig);
+const SwizzleConfigSchema = utils_validation_1.Joi.object({
+    components: utils_validation_1.Joi.object()
+        .pattern(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
+        actions: utils_validation_1.Joi.object().pattern(utils_validation_1.Joi.string().valid(...common_1.SwizzleActions), utils_validation_1.Joi.string().valid(...common_1.SwizzleActionsStatuses)),
+        description: utils_validation_1.Joi.string(),
+    }))
+        .required(),
+});
+function validateSwizzleConfig(unsafeSwizzleConfig) {
+    const result = SwizzleConfigSchema.validate(unsafeSwizzleConfig);
     if (result.error) {
         throw new Error(`Swizzle config does not match expected schema: ${result.error.message}`);
     }
-    const swizzleConfig = result.value;
+    return result.value;
+}
+function normalizeSwizzleConfig(unsafeSwizzleConfig) {
+    const swizzleConfig = validateSwizzleConfig(unsafeSwizzleConfig);
     // Ensure all components always declare all actions
     Object.values(swizzleConfig.components).forEach((componentConfig) => {
         common_1.SwizzleActions.forEach((action) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4895",
+  "version": "0.0.0-4900",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.17.9",
     "@babel/runtime-corejs3": "^7.17.9",
     "@babel/traverse": "^7.17.9",
-    "@docusaurus/cssnano-preset": "0.0.0-4895",
-    "@docusaurus/logger": "0.0.0-4895",
-    "@docusaurus/mdx-loader": "0.0.0-4895",
+    "@docusaurus/cssnano-preset": "0.0.0-4900",
+    "@docusaurus/logger": "0.0.0-4900",
+    "@docusaurus/mdx-loader": "0.0.0-4900",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4895",
-    "@docusaurus/utils-common": "0.0.0-4895",
-    "@docusaurus/utils-validation": "0.0.0-4895",
+    "@docusaurus/utils": "0.0.0-4900",
+    "@docusaurus/utils-common": "0.0.0-4900",
+    "@docusaurus/utils-validation": "0.0.0-4900",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.4",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.4",
@@ -105,8 +105,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4895",
-    "@docusaurus/types": "0.0.0-4895",
+    "@docusaurus/module-type-aliases": "0.0.0-4900",
+    "@docusaurus/types": "0.0.0-4900",
     "@types/detect-port": "^1.3.2",
     "@types/nprogress": "^0.2.0",
     "@types/react-dom": "^18.0.1",
@@ -127,5 +127,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "8845bdf725b98ed6da91b2270a8a3d268bce3fa4"
+  "gitHead": "2b685fb483506ef5f6eb97d4a48b8524e3ce3ce9"
 }