misc: replace all "Metadatas" with "Metadata" (#5871)

Co-authored-by: Josh-Cena <sidachen2003@gmail.com>

packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts

@@ -1021,7 +1021,7 @@ describe('site with full autogenerated sidebar', () => {
     });
   });
 
-  test('docs in fully generated sidebar have correct metadatas', async () => {
+  test('docs in fully generated sidebar have correct metadata', async () => {
     const {content, siteDir} = await loadSite();
     const version = content.loadedVersions[0];
 
@@ -1518,11 +1518,11 @@ describe('site with partial autogenerated sidebars', () => {
     });
   });
 
-  test('docs in partially generated sidebar have correct metadatas', async () => {
+  test('docs in partially generated sidebar have correct metadata', async () => {
     const {content, siteDir} = await loadSite();
     const version = content.loadedVersions[0];
 
-    // Only looking at the docs of the autogen sidebar, others metadatas should not be affected
+    // Only looking at the docs of the autogen sidebar, others metadata should not be affected
 
     expect(getDocById(version, 'API/api-end')).toEqual({
       ...defaultDocMetadata,

packages/docusaurus-plugin-content-docs/src/docFrontMatter.ts

@@ -15,7 +15,7 @@ import {
 import {DocFrontMatter} from './types';
 
 // NOTE: we don't add any default value on purpose here
-// We don't want default values to magically appear in doc metadatas and props
+// We don't want default values to magically appear in doc metadata and props
 // While the user did not provide those values explicitly
 // We use default values in code instead
 const DocFrontMatterSchema = Joi.object<DocFrontMatter>({

packages/docusaurus-plugin-content-docs/src/docs.ts

@@ -284,7 +284,7 @@ export function processDocMetadata(args: {
   } catch (e) {
     console.error(
       chalk.red(
-        `Can't process doc metadatas for doc at path "${args.docFile.filePath}" in version "${args.versionMetadata.versionName}"`,
+        `Can't process doc metadata for doc at path "${args.docFile.filePath}" in version "${args.versionMetadata.versionName}"`,
       ),
     );
     throw e;

packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts

@@ -5,10 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {
-  CategoryMetadatasFile,
-  DefaultSidebarItemsGenerator,
-} from '../generator';
+import {CategoryMetadataFile, DefaultSidebarItemsGenerator} from '../generator';
 import {Sidebar, SidebarItemsGenerator} from '../types';
 import fs from 'fs-extra';
 import {DefaultNumberPrefixParser} from '../../numberPrefix';
@@ -37,7 +34,7 @@ describe('DefaultSidebarItemsGenerator', () => {
   }
 
   function mockCategoryMetadataFiles(
-    categoryMetadataFiles: Record<string, Partial<CategoryMetadatasFile>>,
+    categoryMetadataFiles: Record<string, Partial<CategoryMetadataFile>>,
   ) {
     jest.spyOn(fs, 'pathExists').mockImplementation((metadataFilePath) => {
       return typeof categoryMetadataFiles[metadataFilePath] !== 'undefined';

packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts

@@ -27,7 +27,7 @@ const docIdPrefix = '$doc$/';
 export const CategoryMetadataFilenameBase = '_category_';
 export const CategoryMetadataFilenamePattern = '_category_.{json,yml,yaml}';
 
-export type CategoryMetadatasFile = {
+export type CategoryMetadataFile = {
   label?: string;
   position?: number;
   collapsed?: boolean;
@@ -50,7 +50,7 @@ type Dir = {
   [item: string]: Dir | null;
 };
 
-const CategoryMetadatasFileSchema = Joi.object<CategoryMetadatasFile>({
+const CategoryMetadataFileSchema = Joi.object<CategoryMetadataFile>({
   label: Joi.string(),
   position: Joi.number(),
   collapsed: Joi.boolean(),
@@ -62,14 +62,14 @@ const CategoryMetadatasFileSchema = Joi.object<CategoryMetadatasFile>({
 // Example use-case being able to disable number prefix parsing at the folder level, or customize the default route path segment for an intermediate directory...
 // TODO later if there is `CategoryFolder/index.md`, we may want to read the metadata as yaml on it
 // see https://github.com/facebook/docusaurus/issues/3464#issuecomment-818670449
-async function readCategoryMetadatasFile(
+async function readCategoryMetadataFile(
   categoryDirPath: string,
-): Promise<CategoryMetadatasFile | null> {
-  async function tryReadFile(filePath: string): Promise<CategoryMetadatasFile> {
+): Promise<CategoryMetadataFile | null> {
+  async function tryReadFile(filePath: string): Promise<CategoryMetadataFile> {
     const contentString = await fs.readFile(filePath, {encoding: 'utf8'});
     const unsafeContent = Yaml.load(contentString);
     try {
-      return Joi.attempt(unsafeContent, CategoryMetadatasFileSchema);
+      return Joi.attempt(unsafeContent, CategoryMetadataFileSchema);
     } catch (e) {
       console.error(
         chalk.red(
@@ -81,7 +81,7 @@ async function readCategoryMetadatasFile(
   }
   // eslint-disable-next-line no-restricted-syntax
   for (const ext of ['.json', '.yml', '.yaml']) {
-    // Simpler to use only posix paths for mocking file metadatas in tests
+    // Simpler to use only posix paths for mocking file metadata in tests
     const filePath = posixPath(
       path.join(categoryDirPath, `${CategoryMetadataFilenameBase}${ext}`),
     );
@@ -184,16 +184,16 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
       folderName: string,
     ): Promise<WithPosition<SidebarItemCategory>> {
       const categoryPath = path.join(version.contentPath, autogenDir, fullPath);
-      const categoryMetadatas = await readCategoryMetadatasFile(categoryPath);
-      const className = categoryMetadatas?.className;
+      const categoryMetadata = await readCategoryMetadataFile(categoryPath);
+      const className = categoryMetadata?.className;
       const {filename, numberPrefix} = numberPrefixParser(folderName);
       return {
         type: 'category',
-        label: categoryMetadatas?.label ?? filename,
+        label: categoryMetadata?.label ?? filename,
         collapsible:
-          categoryMetadatas?.collapsible ?? options.sidebarCollapsible,
-        collapsed: categoryMetadatas?.collapsed ?? options.sidebarCollapsed,
-        position: categoryMetadatas?.position ?? numberPrefix,
+          categoryMetadata?.collapsible ?? options.sidebarCollapsible,
+        collapsed: categoryMetadata?.collapsed ?? options.sidebarCollapsed,
+        position: categoryMetadata?.position ?? numberPrefix,
         ...(className !== undefined && {className}),
         items: await Promise.all(
           Object.entries(dir).map(([key, content]) =>

packages/docusaurus-plugin-content-docs/src/sidebars/types.ts

@@ -124,8 +124,8 @@ export type PropSidebars = {
 };
 
 // Reduce API surface for options.sidebarItemsGenerator
-// The user-provided generator fn should receive only a subset of metadatas
-// A change to any of these metadatas can be considered as a breaking change
+// The user-provided generator fn should receive only a subset of metadata
+// A change to any of these metadata can be considered as a breaking change
 export type SidebarItemsGeneratorDoc = Pick<
   DocMetadataBase,
   'id' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'

packages/docusaurus-plugin-content-docs/src/translations.ts

@@ -50,7 +50,7 @@ function getNormalizedSidebarName({
 }
 
 /*
-// Do we need to translate doc metadatas?
+// Do we need to translate doc metadata?
 // It seems translating frontmatter labels is good enough
 function getDocTranslations(doc: DocMetadata): TranslationFileContent {
   return {