@docusaurus/plugin-content-docs 0.0.0-4291 → 0.0.0-4297

package/lib/cli.js

@@ -13,6 +13,7 @@ const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const sidebars_1 = require("./sidebars");
 const utils_1 = require("@docusaurus/utils");
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, version, }) {
     // Load current sidebar and create a new versioned sidebars file (if needed).
     // Note: we don't need the sidebars file to be normalized: it's ok to let plugin option changes to impact older, versioned sidebars
@@ -80,6 +81,6 @@ function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     versions.unshift(version);
     fs_extra_1.default.ensureDirSync(path_1.default.dirname(versionsJSONFile));
     fs_extra_1.default.writeFileSync(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
-    console.log(`${pluginIdLogPrefix}: version ${version} created!`);
+    logger_1.default.success `name=${pluginIdLogPrefix}: version name=${version} created!`;
 }
 exports.cliDocsVersionCommand = cliDocsVersionCommand;

package/lib/docs.js

@@ -10,7 +10,7 @@ exports.createDocsByIdIndex = exports.getDocIds = exports.isConventionalDocIndex
 const tslib_1 = require("tslib");
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const lodash_1 = require("lodash");
 const utils_1 = require("@docusaurus/utils");
 const lastUpdate_1 = require("./lastUpdate");
@@ -171,7 +171,7 @@ function processDocMetadata(args) {
         return doProcessDocMetadata(args);
     }
     catch (e) {
-        console.error(chalk_1.default.red(`Can't process doc metadata for doc at path "${args.docFile.filePath}" in version "${args.versionMetadata.versionName}"`));
+        logger_1.default.error `Can't process doc metadata for doc at path path=${args.docFile.filePath} in version name=${args.versionMetadata.versionName}`;
         throw e;
     }
 }

package/lib/index.js

@@ -20,7 +20,7 @@ const lodash_1 = require("lodash");
 const globalData_1 = require("./globalData");
 const props_1 = require("./props");
 const translations_1 = require("./translations");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const tags_1 = require("./tags");
 const routes_1 = require("./routes");
 const utils_2 = require("./sidebars/utils");
@@ -126,7 +126,7 @@ function pluginContentDocs(context, options) {
                     return await doLoadVersion(versionMetadata);
                 }
                 catch (e) {
-                    console.error(chalk_1.default.red(`Loading of version failed for version "${versionMetadata.versionName}"`));
+                    logger_1.default.error `Loading of version failed for version name=${versionMetadata.versionName}`;
                     throw e;
                 }
             }

package/lib/lastUpdate.js

@@ -9,6 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFileLastUpdate = void 0;
 const tslib_1 = require("tslib");
 const shelljs_1 = (0, tslib_1.__importDefault)(require("shelljs"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const GIT_COMMIT_TIMESTAMP_AUTHOR_REGEX = /^(\d+),(.+)$/;
 let showedGitRequirementError = false;
 async function getFileLastUpdate(filePath) {
@@ -30,7 +31,7 @@ async function getFileLastUpdate(filePath) {
         if (!shelljs_1.default.which('git')) {
             if (!showedGitRequirementError) {
                 showedGitRequirementError = true;
-                console.warn('Sorry, the docs plugin last update options require Git.');
+                logger_1.default.warn('Sorry, the docs plugin last update options require Git.');
             }
             return null;
         }
@@ -42,8 +43,8 @@ async function getFileLastUpdate(filePath) {
         }
         return getTimestampAndAuthor(result.stdout.trim());
     }
-    catch (error) {
-        console.error(error);
+    catch (e) {
+        logger_1.default.error(e);
     }
     return null;
 }

package/lib/options.js

@@ -10,7 +10,7 @@ exports.validateOptions = exports.OptionsSchema = exports.DEFAULT_OPTIONS = void
 const tslib_1 = require("tslib");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_1 = require("@docusaurus/utils");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const remark_admonitions_1 = (0, tslib_1.__importDefault)(require("remark-admonitions"));
 const generator_1 = require("./sidebars/generator");
 const numberPrefix_1 = require("./numberPrefix");
@@ -111,7 +111,7 @@ function validateOptions({ validate, options: userOptions, }) {
             };
         }
         if (options.sidebarCollapsed) {
-            console.warn(chalk_1.default.yellow('The docs plugin config is inconsistent. It does not make sense to use sidebarCollapsible=false and sidebarCollapsed=true at the same time. sidebarCollapsed=false will be ignored.'));
+            logger_1.default.warn `The docs plugin config is inconsistent. It does not make sense to use code=${'sidebarCollapsible: false'} and code=${'sidebarCollapsed: true'} at the same time. code=${'sidebarCollapsed: true'} will be ignored.`;
             options = {
                 ...options,
                 sidebarCollapsed: false,

package/lib/routes.js

@@ -10,7 +10,7 @@ exports.createVersionRoutes = exports.createDocRoutes = exports.createCategoryGe
 const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
 const props_1 = require("./props");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 async function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, }) {
     const slugs = (0, utils_1.createSlugger)();
     async function createCategoryGeneratedIndexRoute(categoryGeneratedIndex) {
@@ -98,7 +98,7 @@ async function createVersionRoutes({ loadedVersion, actions, docItemComponent, d
         return await doCreateVersionRoutes(loadedVersion);
     }
     catch (e) {
-        console.error(chalk_1.default.red(`Can't create version routes for version "${loadedVersion.versionName}"`));
+        logger_1.default.error `Can't create version routes for version name=${loadedVersion.versionName}`;
         throw e;
     }
 }

package/lib/sidebars/generator.js

@@ -10,7 +10,7 @@ exports.DefaultSidebarItemsGenerator = exports.CategoryMetadataFilenamePattern =
 const tslib_1 = require("tslib");
 const lodash_1 = require("lodash");
 const utils_1 = require("@docusaurus/utils");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
 const js_yaml_1 = (0, tslib_1.__importDefault)(require("js-yaml"));
@@ -37,7 +37,7 @@ async function readCategoryMetadataFile(categoryDirPath) {
             return (0, validation_1.validateCategoryMetadataFile)(unsafeContent);
         }
         catch (e) {
-            console.error(chalk_1.default.red(`The docs sidebar category metadata file looks invalid!\nPath: ${filePath}`));
+            logger_1.default.error `The docs sidebar category metadata file path=${filePath} looks invalid!`;
             throw e;
         }
     }
@@ -78,7 +78,7 @@ const DefaultSidebarItemsGenerator = async ({ numberPrefixParser, docs: allDocs,
         }
         const docs = allDocs.filter(isInAutogeneratedDir);
         if (docs.length === 0) {
-            console.warn(chalk_1.default.yellow(`No docs found in dir ${autogenDir}: can't auto-generate a sidebar.`));
+            logger_1.default.warn `No docs found in path=${autogenDir}: can't auto-generate a sidebar.`;
         }
         return docs;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4291",
+  "version": "0.0.0-4297",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-docs.d.ts",
@@ -18,11 +18,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4291",
-    "@docusaurus/mdx-loader": "0.0.0-4291",
-    "@docusaurus/utils": "0.0.0-4291",
-    "@docusaurus/utils-validation": "0.0.0-4291",
-    "chalk": "^4.1.2",
+    "@docusaurus/core": "0.0.0-4297",
+    "@docusaurus/logger": "0.0.0-4297",
+    "@docusaurus/mdx-loader": "0.0.0-4297",
+    "@docusaurus/utils": "0.0.0-4297",
+    "@docusaurus/utils-validation": "0.0.0-4297",
     "combine-promises": "^1.1.0",
     "escape-string-regexp": "^4.0.0",
     "fs-extra": "^10.0.0",
@@ -38,8 +38,8 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4291",
-    "@docusaurus/types": "0.0.0-4291",
+    "@docusaurus/module-type-aliases": "0.0.0-4297",
+    "@docusaurus/types": "0.0.0-4297",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
@@ -53,5 +53,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "7097980fb8a57b1950c0714707966eea27f69975"
+  "gitHead": "84ae34c33c664bf856f3a92047919a074e087d77"
 }

package/src/cli.ts

@@ -15,6 +15,7 @@ import path from 'path';
 import type {PathOptions, SidebarOptions} from './types';
 import {loadSidebarsFile, resolveSidebarPathOption} from './sidebars';
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
+import logger from '@docusaurus/logger';
 
 function createVersionedSidebarFile({
   siteDir,
@@ -133,5 +134,5 @@ export function cliDocsVersionCommand(
   fs.ensureDirSync(path.dirname(versionsJSONFile));
   fs.writeFileSync(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
 
-  console.log(`${pluginIdLogPrefix}: version ${version} created!`);
+  logger.success`name=${pluginIdLogPrefix}: version name=${version} created!`;
 }

package/src/docs.ts

@@ -7,7 +7,7 @@
 
 import path from 'path';
 import fs from 'fs-extra';
-import chalk from 'chalk';
+import logger from '@docusaurus/logger';
 import {keyBy, last} from 'lodash';
 import {
   aliasedSitePath,
@@ -274,11 +274,7 @@ export function processDocMetadata(args: {
   try {
     return doProcessDocMetadata(args);
   } catch (e) {
-    console.error(
-      chalk.red(
-        `Can't process doc metadata for doc at path "${args.docFile.filePath}" in version "${args.versionMetadata.versionName}"`,
-      ),
-    );
+    logger.error`Can't process doc metadata for doc at path path=${args.docFile.filePath} in version name=${args.versionMetadata.versionName}`;
     throw e;
   }
 }

package/src/index.ts

@@ -51,7 +51,7 @@ import {
   translateLoadedContent,
   getLoadedContentTranslationFiles,
 } from './translations';
-import chalk from 'chalk';
+import logger from '@docusaurus/logger';
 import {getVersionTags} from './tags';
 import {createVersionRoutes} from './routes';
 import type {PropTagsListPage} from '@docusaurus/plugin-content-docs';
@@ -203,11 +203,7 @@ export default function pluginContentDocs(
         try {
           return await doLoadVersion(versionMetadata);
         } catch (e) {
-          console.error(
-            chalk.red(
-              `Loading of version failed for version "${versionMetadata.versionName}"`,
-            ),
-          );
+          logger.error`Loading of version failed for version name=${versionMetadata.versionName}`;
           throw e;
         }
       }

package/src/lastUpdate.ts

@@ -6,6 +6,7 @@
  */
 
 import shell from 'shelljs';
+import logger from '@docusaurus/logger';
 
 type FileLastUpdateData = {timestamp?: number; author?: string};
 
@@ -36,7 +37,7 @@ export async function getFileLastUpdate(
     if (!shell.which('git')) {
       if (!showedGitRequirementError) {
         showedGitRequirementError = true;
-        console.warn('Sorry, the docs plugin last update options require Git.');
+        logger.warn('Sorry, the docs plugin last update options require Git.');
       }
 
       return null;
@@ -51,8 +52,8 @@ export async function getFileLastUpdate(
       );
     }
     return getTimestampAndAuthor(result.stdout.trim());
-  } catch (error) {
-    console.error(error);
+  } catch (e) {
+    logger.error(e);
   }
 
   return null;

package/src/options.ts

@@ -19,7 +19,7 @@ import type {
   OptionValidationContext,
   ValidationResult,
 } from '@docusaurus/types';
-import chalk from 'chalk';
+import logger from '@docusaurus/logger';
 import admonitions from 'remark-admonitions';
 import {DefaultSidebarItemsGenerator} from './sidebars/generator';
 import {
@@ -157,11 +157,7 @@ export function validateOptions({
       };
     }
     if (options.sidebarCollapsed) {
-      console.warn(
-        chalk.yellow(
-          'The docs plugin config is inconsistent. It does not make sense to use sidebarCollapsible=false and sidebarCollapsed=true at the same time. sidebarCollapsed=false will be ignored.',
-        ),
-      );
+      logger.warn`The docs plugin config is inconsistent. It does not make sense to use code=${'sidebarCollapsible: false'} and code=${'sidebarCollapsed: true'} at the same time. code=${'sidebarCollapsed: true'} will be ignored.`;
       options = {
         ...options,
         sidebarCollapsed: false,

package/src/routes.ts

@@ -14,7 +14,7 @@ import {
 } from './types';
 import type {PropCategoryGeneratedIndex} from '@docusaurus/plugin-content-docs';
 import {toVersionMetadataProp} from './props';
-import chalk from 'chalk';
+import logger from '@docusaurus/logger';
 
 export async function createCategoryGeneratedIndexRoutes({
   version,
@@ -163,11 +163,7 @@ export async function createVersionRoutes({
   try {
     return await doCreateVersionRoutes(loadedVersion);
   } catch (e) {
-    console.error(
-      chalk.red(
-        `Can't create version routes for version "${loadedVersion.versionName}"`,
-      ),
-    );
+    logger.error`Can't create version routes for version name=${loadedVersion.versionName}`;
     throw e;
   }
 }

package/src/sidebars/generator.ts

@@ -16,7 +16,7 @@ import type {
 } from './types';
 import {sortBy, last} from 'lodash';
 import {addTrailingSlash, posixPath} from '@docusaurus/utils';
-import chalk from 'chalk';
+import logger from '@docusaurus/logger';
 import path from 'path';
 import fs from 'fs-extra';
 import Yaml from 'js-yaml';
@@ -72,11 +72,7 @@ async function readCategoryMetadataFile(
     try {
       return validateCategoryMetadataFile(unsafeContent);
     } catch (e) {
-      console.error(
-        chalk.red(
-          `The docs sidebar category metadata file looks invalid!\nPath: ${filePath}`,
-        ),
-      );
+      logger.error`The docs sidebar category metadata file path=${filePath} looks invalid!`;
       throw e;
     }
   }
@@ -134,11 +130,7 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
     const docs = allDocs.filter(isInAutogeneratedDir);
 
     if (docs.length === 0) {
-      console.warn(
-        chalk.yellow(
-          `No docs found in dir ${autogenDir}: can't auto-generate a sidebar.`,
-        ),
-      );
+      logger.warn`No docs found in path=${autogenDir}: can't auto-generate a sidebar.`;
     }
     return docs;
   }