add a new, bundled version of the docs.d.ts, use that in OT

ionic-team · Jul 25, 2023 · bc700f6 · bc700f6
1 parent 73893ac
commit bc700f6
Show file tree

Hide file tree

Showing 4 changed files with 354 additions and 258 deletions.
diff --git a/scripts/bundles/internal.ts b/scripts/bundles/internal.ts
@@ -1,7 +1,7 @@
 import fs from 'fs-extra';
 import { join } from 'path';
 
-import { cleanDts } from '../utils/bundle-dts';
+import { bundleDts, cleanDts } from '../utils/bundle-dts';
 import type { BuildOptions } from '../utils/options';
 import { writePkgJson } from '../utils/write-pkg-json';
 import { internalAppData } from './internal-app-data';
@@ -73,6 +73,13 @@ async function copyStencilInternalDts(opts: BuildOptions, outputInternalDir: str
   const docsDts = cleanDts(await fs.readFile(docsDtsSrcPath, 'utf8'));
   await fs.writeFile(docsDtsDestPath, docsDts);
 
+  // @stencil/core/internal/stencil-public-docs-bundled.d.ts
+  // this is the same types as `stencil-public-docs.d.ts` but bundled with
+  // dts-bundle-generator so it's self-contained and therefore portable
+  const bundledDocsDtsDestPath = join(outputInternalDir, 'stencil-public-docs-bundled.d.ts');
+  const bundledDocsDts = await bundleDts(opts, docsDtsSrcPath);
+  await fs.writeFile(bundledDocsDtsDestPath, bundledDocsDts);
+
   // @stencil/core/internal/stencil-public-runtime.d.ts
   const runtimeDtsSrcPath = join(declarationsInputDir, 'stencil-public-runtime.d.ts');
   const runtimeDtsDestPath = join(outputInternalDir, 'stencil-public-runtime.d.ts');

diff --git a/scripts/utils/bundle-dts.ts b/scripts/utils/bundle-dts.ts
@@ -1,4 +1,4 @@
-import { generateDtsBundle } from 'dts-bundle-generator/dist/bundle-generator.js';
+import { generateDtsBundle, EntryPointConfig } from 'dts-bundle-generator/dist/bundle-generator.js';
 import fs from 'fs-extra';
 
 import { BuildOptions } from './options';
@@ -12,9 +12,13 @@ export async function bundleDts(opts: BuildOptions, inputFile: string) {
     } catch (e) {}
   }
 
-  const entries = [
+  const entries: EntryPointConfig[] = [
     {
       filePath: inputFile,
+      output: {
+        noBanner: true,
+        exportReferencedTypes: false,
+      },
     },
   ];
 

diff --git a/src/compiler/docs/json/index.ts b/src/compiler/docs/json/index.ts
@@ -1,6 +1,5 @@
 import { isOutputTargetDocsJson } from '@utils';
 import { join } from 'path';
-import { generateDtsBundle } from 'dts-bundle-generator/dist/bundle-generator.js';
 
 import type * as d from '../../../declarations';
 
@@ -14,16 +13,20 @@ export const generateJsonDocs = async (
   if (jsonOutputTargets.length === 0) {
     return;
   }
-  const docsDtsPath = join(config.sys.getCompilerExecutingPath(), '..', '..', 'internal', 'stencil-public-docs.d.ts');
-
-  const entries = [
-    {
-      filePath: docsDtsPath,
-    },
-  ];
-  console.log('ABOUT TO GENERATE DTS BUNDLE');
-  let docsDts = await generateDtsBundle(entries).join('\n');
-  console.log(docsDts);
+  const docsDtsPath = join(
+    config.sys.getCompilerExecutingPath(),
+    '..',
+    '..',
+    'internal',
+    'stencil-public-docs-bundled.d.ts',
+  );
+  let docsDts = await compilerCtx.fs.readFile(docsDtsPath);
+  // this file was written by dts-bundle-generator, which uses tabs for
+  // indentation
+  docsDts = docsDts
+    .split('\n')
+    .map((line) => line.replace(/^\t/, '    '))
+    .join('\n');
 
   const typesContent = `
 /**