refactor(core): rename default router to "member"

Author: tgreyuk

commitlint.config.cjs

@@ -1,7 +1,11 @@
 module.exports = {
   extends: ['@commitlint/config-conventional'],
   rules: {
-    'type-enum': [2, 'always', ['chore', 'docs', 'feat', 'fix', 'test']],
+    'type-enum': [
+      2,
+      'always',
+      ['chore', 'docs', 'feat', 'fix', 'test', 'refactor'],
+    ],
     'scope-empty': [2, 'never'],
     'scope-enum': [
       2,

docs/content/docs/CHANGELOG.md

@@ -8,7 +8,7 @@ From a consumer perspective there should be no direct breaking change from the p
 
 ### Architectural Changes
 
-- This plugin now utilizes TypeDoc's [router](https://typedoc.org/documents/Options.Output.html#router) feature. This implementation replaces the now deprecated `"outputFileStrategy"` option. `"outputFileStrategy"` is still supported for now, but will now point to the "kind-structure" and "module" router keys respectively. Further details are contained in the documentation website.
+- This plugin now utilizes TypeDoc's [router](https://typedoc.org/documents/Options.Output.html#router) feature. This implementation replaces the now deprecated `"outputFileStrategy"` option. `"outputFileStrategy"` is still supported for now, but will now point to the "member" and "module" router keys respectively. Further details are contained in the documentation website.
 - Please note that separate strategies for output generation in different packages (when entryPointStrategy=packages) is no longer possible with this new architecture.
 
 ### Structural Changes

docs/content/docs/output-file-structure.mdx

@@ -12,19 +12,19 @@ This plugin now utilises this mechanism for output file generation.
 
 The plugin ships with the following custom built-in routers:
 
-### "kind-structure" (default)
+### "member" (default)
 
 ```json filename="typedoc.json"
 {
-  "router": "kind-structure"
+  "router": "member"
 }
 ```
 
 _Note: This is equivalent to the deprecated `outputFileStrategy="members"`._
 
 Generates an individual file for each exported module member kind. Pages are grouped by kind within their respective module hierarchy.
 
-This mirrors a combination of TypeDoc's `kind` and `structure` routers hence the name.
+This mirrors a combination of TypeDoc's `kind` and `structure` routers.
 
 This is the default router of the plugin.
 

packages/typedoc-plugin-markdown/CHANGELOG.md

@@ -8,7 +8,7 @@ From a consumer perspective there should be no direct breaking change from the p
 
 ### Architectural Changes
 
-- This plugin now utilizes TypeDoc's [router](https://typedoc.org/documents/Options.Output.html#router) feature. This implementation replaces the now deprecated `"outputFileStrategy"` option. `"outputFileStrategy"` is still supported for now, but will now point to the "kind-structure" and "module" router keys respectively. Further details are contained in the documentation website.
+- This plugin now utilizes TypeDoc's [router](https://typedoc.org/documents/Options.Output.html#router) feature. This implementation replaces the now deprecated `"outputFileStrategy"` option. `"outputFileStrategy"` is still supported for now, but will now point to the "member" and "module" router keys respectively. Further details are contained in the documentation website.
 - Please note that separate strategies for output generation in different packages (when entryPointStrategy=packages) is no longer possible with this new architecture.
 
 ### Structural Changes

packages/typedoc-plugin-markdown/src/renderer/render.ts

@@ -120,10 +120,9 @@ function prepareRouter(renderer: Renderer) {
     if (renderer.application.options.isSet('outputFileStrategy')) {
       const outputFileStrategy =
         renderer.application.options.getValue('outputFileStrategy');
-      routerOption =
-        outputFileStrategy === 'modules' ? 'module' : 'kind-structure';
+      routerOption = outputFileStrategy === 'modules' ? 'module' : 'member';
     } else {
-      routerOption = 'kind-structure';
+      routerOption = 'member';
     }
   }
 
@@ -134,7 +133,7 @@ function prepareRouter(renderer: Renderer) {
     renderer.application.logger.error(
       i18n.router_0_is_not_defined_available_are_1(
         routerOption,
-        ['kind-structure', 'module'].join(', '),
+        ['member', 'module'].join(', '),
       ),
     );
     return false;

packages/typedoc-plugin-markdown/src/renderer/setup.ts

@@ -24,7 +24,7 @@ export function setupRenderer(app: Application) {
 
   Object.defineProperty(app.renderer, 'routers', {
     value: new Map<string, new (app: Application) => MarkdownRouter>([
-      ['kind-structure', KindStructureRouter],
+      ['member', KindStructureRouter],
       ['module', ModuleRouter],
     ]),
   });

packages/typedoc-plugin-markdown/src/router/index.ts

@@ -4,5 +4,5 @@
  * @module
  */
 export * from './markdown-router.js';
-export * from './routers/kind-structure-router.js';
+export * from './routers/member-router.js';
 export * from './routers/module-router.js';

packages/typedoc-plugin-markdown/src/router/routers/kind-structure-router.ts renamed to packages/typedoc-plugin-markdown/src/router/routers/member-router.ts

@@ -59,7 +59,7 @@ const config = {
       tableColumnSettings: {
         leftAlignHeaders: true,
       },
-      router: 'kind-structure',
+      router: 'member',
       blockTagsPreserveOrder: ['@deprecated', '@see'],
     },
     options: [