chore(all): convert to esm / TypeDoc 0.27 fixes

.husky/commit-msg

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx commitlint --edit ${1}

devtools/examples/docusaurus/sidebars.js

@@ -24,15 +24,15 @@ const sidebars = {
       },
       items: require('./docs/api/typedoc-sidebar.cjs'),
     },
-    /*{
+    {
       type: 'category',
       label: 'DOCS 2',
       link: {
         type: 'doc',
         id: 'api-2/index',
       },
       items: require('./docs/api-2/typedoc-sidebar.cjs'),
-    },
+    } /*
     {
       type: 'category',
       label: 'DOCS 3',
@@ -41,7 +41,7 @@ const sidebars = {
         id: 'api-3/index',
       },
       items: require('./docs/api-3/typedoc-sidebar.cjs'),
-    },*/
+    },*/,
   ],
 };
 

devtools/packages/fixtures/cli.ts

@@ -1,18 +1,27 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env tsx
 
-import { getPackageName } from '@devtools/helpers';
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+import { getPackageName } from '@devtools/helpers/index.js';
 import { spawn } from 'child_process';
 import { consola } from 'consola';
-import * as fs from 'fs-extra';
+import fs from 'fs-extra';
 import * as path from 'path';
-import { Fixture } from './models';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { Fixture } from './models.js';
+
+export const __filename = fileURLToPath(import.meta.url);
+export const __dirname = dirname(__filename);
 
 const timeStart = new Date().getTime();
 
 main();
 
 async function main() {
-  fs.removeSync(path.join(process.cwd(), 'test', 'fixtures', 'out'));
+  const outPath = path.join(process.cwd(), 'test', 'fixtures', 'out');
+
+  fs.removeSync(outPath);
 
   const config: Record<string, Fixture> = await import(
     path.join(process.cwd(), process.argv[3])
@@ -41,7 +50,7 @@ async function main() {
     const outputFileStrategies: ('members' | 'modules')[] =
       config.outputFileStrategies || ['members', 'modules'];
 
-    //writeHtml(key, config.entryPoints);
+    writeHtml(key, config.entryPoints);
     outputFileStrategies.forEach((outputFileStrategy) => {
       config.options.forEach((optionGroup, index: number) => {
         const options = {

devtools/packages/fixtures/package.json

@@ -2,6 +2,7 @@
   "name": "@devtools/fixtures",
   "version": "0.0.0",
   "private": true,
+  "type": "module",
   "files": [
     "/"
   ],

devtools/packages/fixtures/typedoc.cjs

@@ -12,6 +12,16 @@ module.exports = {
       URL: 'https://developer.mozilla.org/en-US/docs/Web/API/URL',
     },
   },
+  /*outputs: [
+    {
+      name: 'html',
+      path: './docs-html',
+    },
+    {
+      name: 'markdown',
+      path: './docs-markdown',
+    },
+  ],*/
   locales: {
     en: {
       theme_defined_in: 'Source',

devtools/packages/helpers/constants.ts

@@ -1,4 +1,4 @@
-import { DocsConfig } from './models';
+import { DocsConfig } from './models.js';
 
 export const SRC_PATH = `${process.cwd()}/src`;
 export const PRESETS_PATH = `${process.cwd()}/src/options/presets.ts`;

devtools/packages/helpers/index.ts

@@ -1,3 +1,3 @@
-export * from './constants';
-export * from './methods';
-export * from './models';
+export * from './constants.js';
+export * from './methods.js';
+export * from './models.js';

devtools/packages/helpers/package.json

@@ -2,6 +2,7 @@
   "name": "@devtools/helpers",
   "version": "0.0.0",
   "private": true,
+  "type": "module",
   "main": "index.ts",
   "files": [
     "/"

devtools/packages/prebuild-options/cli.ts

@@ -1,9 +1,9 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env tsx
 
 import { DOCS_CONFIG, DocsConfig, getPackageName } from '@devtools/helpers';
 import { consola } from 'consola';
-import { generateOptionsDocs } from './tasks/generate-docs';
-import { generateOptionsModels } from './tasks/generate-models';
+import { generateOptionsDocs } from './tasks/generate-docs.js';
+import { generateOptionsModels } from './tasks/generate-models.js';
 
 main();
 

devtools/packages/prebuild-options/package.json

@@ -2,6 +2,7 @@
   "name": "@devtools/prebuild-options",
   "version": "0.0.0",
   "private": true,
+  "type": "module",
   "files": [
     "/"
   ],

devtools/packages/prebuild-options/tasks/generate-docs.ts

@@ -1,9 +1,16 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable no-empty */
 import { DocsConfig } from '@devtools/helpers';
 import * as fs from 'fs';
 import * as path from 'path';
+import { dirname } from 'path';
 import * as prettier from 'prettier';
 import { Project, VariableStatement } from 'ts-morph';
 import { ParameterType } from 'typedoc';
+import { fileURLToPath } from 'url';
+
+export const __filename = fileURLToPath(import.meta.url);
+export const __dirname = dirname(__filename);
 
 export async function generateOptionsDocs(docsConfig: DocsConfig) {
   const project = new Project({
@@ -53,9 +60,14 @@ ${presetsJson}
     const optionsVariableStatements =
       configFileTs?.getVariableStatements() as VariableStatement[];
 
-    const parsedConfig = Object.entries(declarationsConfig)
-      .map(([name, option]: any, i) => {
-        const docs = optionsVariableStatements[i].getJsDocs().map((doc) => {
+    const parsedConfig = optionsVariableStatements
+      .map((variableStatement) => {
+        const name = (
+          variableStatement.compilerNode.declarationList.declarations[0]
+            .name as any
+        ).escapedText;
+        const option = declarationsConfig[name];
+        const docs = variableStatement.getJsDocs().map((doc) => {
           return {
             comments: (doc.getComment() as string)
               ?.replace(/\\\//g, '/')
@@ -125,7 +137,7 @@ ${presetsJson}
           : '',
       ];
       const optionLevel =
-        categories.length === 1 && !Boolean(docsConfig.presets) ? '##' : '##';
+        categories.length === 1 && !docsConfig.presets ? '##' : '##';
       if (categories.length > 1) {
         out.push(`# ${getDocsTitle(categoryName)}`);
         if (Object.keys(categoryDescriptions)?.length) {
@@ -142,19 +154,15 @@ ${presetsJson}
       options.forEach((option) => {
         optionsLi.push(
           `- [${
-            Boolean(option.deprecated)
-              ? `~--${option.name}~`
-              : `--${option.name}`
+            option.deprecated ? `~--${option.name}~` : `--${option.name}`
           }](./options/${categoryName.toLowerCase()}-options.mdx#--${option.name.toLowerCase()})`,
         );
         out.push(
           `${optionLevel} ${
-            Boolean(option.deprecated)
-              ? `~--${option.name}~`
-              : `--${option.name}`
+            option.deprecated ? `~--${option.name}~` : `--${option.name}`
           }`,
         );
-        if (Boolean(option.deprecated)) {
+        if (option.deprecated) {
           out.push(
             `<Callout type="warning">Deprecated: ${option.deprecated}</Callout>`,
           );
@@ -195,15 +203,18 @@ ${presetsJson}
             //out.push('Below is the full list of keys and default values:');
           }
         }
+
+        let exampleJson = {};
+
+        try {
+          exampleJson = JSON.parse(`{
+            "${option.name}": ${getExampleValue(option)}
+          }`);
+        } catch (e) {}
+
         out.push(`
 \`\`\`json filename="typedoc.json"
-${JSON.stringify(
-  JSON.parse(`{
-          "${option.name}": ${getExampleValue(option)}
-        }`),
-  null,
-  2,
-)}
+${JSON.stringify(exampleJson, null, 2)}
 \`\`\``);
       });
       if (categories.length > 1) {
@@ -303,7 +314,7 @@ function getType(option: any) {
 }
 
 function getDefaultValue(option) {
-  if (Boolean(option.default)) {
+  if (option.default) {
     return option.default;
   }
 

devtools/packages/prebuild-options/tasks/generate-models.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
 import { DocsConfig, SRC_PATH } from '@devtools/helpers';
 import * as fs from 'fs';
 import * as path from 'path';
@@ -45,7 +46,7 @@ import { ManuallyValidatedOption } from 'typedoc'`);
       if (
         !ignoreTypes.map((t) => t.toLowerCase()).includes(option.toLowerCase())
       ) {
-        out.push(`import { ${option} } from './types/options';`);
+        out.push(`import { ${option} } from './types/options.js';`);
       }
     });
   }
@@ -66,6 +67,8 @@ import { ManuallyValidatedOption } from 'typedoc'`);
         theme_default_type: [];
         theme_description: [];
         theme_event: [];
+        theme_re_exports: [];
+        theme_renames_and_re_exports: [];
         theme_extends: [];
         theme_extended_by: [];
         theme_globals: [];

jest.config.base.js

@@ -1,4 +1,3 @@
-const path = require('path');
 module.exports = {
   transform: {
     '^.+\\.tsx?$': [