fix(content-docs): improve sidebar shorthand normalization error message (#6745)

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

@@ -58,7 +58,7 @@ describe('loadSidebars', () => {
     await expect(() =>
       loadSidebars(sidebarPath, params),
     ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"Invalid category {\\"type\\":\\"category\\",\\"label\\":\\"Category Label\\",\\"items\\":\\"doc1\\"}: items must be an array of sidebar items or a category shorthand"`,
+      `"Invalid sidebar items collection \`\\"doc1\\"\` in \`items\` of the category Category Label: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a \`type\` property). See https://docusaurus.io/docs/sidebar/items for all valid syntaxes."`,
     );
   });
 

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

@@ -37,4 +37,53 @@ describe('normalization', () => {
       }),
     ).toMatchSnapshot();
   });
+  test('rejects some invalid cases', () => {
+    expect(() =>
+      normalizeSidebars({
+        sidebar: {
+          Category: {type: 'autogenerated', dirName: 'foo'},
+          Category2: {type: 'autogenerated', dirName: 'bar'},
+        },
+      }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"Invalid sidebar items collection \`{\\"type\\":\\"autogenerated\\",\\"dirName\\":\\"foo\\"}\` in \`items\` of the category Category: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a \`type\` property). See https://docusaurus.io/docs/sidebar/items for all valid syntaxes."`,
+    );
+
+    expect(() =>
+      normalizeSidebars({
+        sidebar: [
+          'foo',
+          {
+            Category: {
+              type: 'category',
+              items: ['bar', 'baz'],
+            },
+          },
+        ],
+      }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"Invalid sidebar items collection \`{\\"type\\":\\"category\\",\\"items\\":[\\"bar\\",\\"baz\\"]}\` in \`items\` of the category Category: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a \`type\` property). See https://docusaurus.io/docs/sidebar/items for all valid syntaxes."`,
+    );
+
+    expect(() =>
+      normalizeSidebars({
+        sidebar: [
+          'foo',
+          {
+            Category: 'bar',
+          },
+        ],
+      }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"Invalid sidebar items collection \`\\"bar\\"\` in \`items\` of the category Category: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a \`type\` property). See https://docusaurus.io/docs/sidebar/items for all valid syntaxes."`,
+    );
+
+    expect(() =>
+      normalizeSidebars({
+        sidebar: 'item',
+      }),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"Invalid sidebar items collection \`\\"item\\"\` in sidebar sidebar: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a \`type\` property). See https://docusaurus.io/docs/sidebar/items for all valid syntaxes."`,
+    );
+  });
 });