comments, etc

Author: alicewriteswrongs

scripts/bundles/internal.ts

@@ -73,7 +73,11 @@ async function copyStencilInternalDts(opts: BuildOptions, outputInternalDir: str
   // We bundle with `dts-bundle-generator` here to ensure that when the `docs-json`
   // OT writes a `docs.d.ts` file based on this file it is fully portable.
   const docsDts = await bundleDts(opts, docsDtsSrcPath, {
+    // we want to suppress the `dts-bundle-generator` banner here because we do
+    // our own later on
     noBanner: true,
+    // we also don't want the types which are inlined into our bundled file to
+    // be re-exported, which will change the 'surface' of the module
     exportReferencedTypes: false,
   });
   await fs.writeFile(docsDtsDestPath, docsDts);

scripts/utils/bundle-dts.ts

@@ -12,10 +12,10 @@ import { BuildOptions } from './options';
  *
  * @param opts an object holding information about the current build of Stencil
  * @param inputFile the path to the file which should be bundled
- * @param ouputOptions options for bundling the file
+ * @param outputOptions options for bundling the file
  * @returns a string containing the bundled typedef
  */
-export async function bundleDts(opts: BuildOptions, inputFile: string, ouputOptions?: OutputOptions): Promise<string> {
+export async function bundleDts(opts: BuildOptions, inputFile: string, outputOptions?: OutputOptions): Promise<string> {
   const cachedDtsOutput = inputFile + '-bundled.d.ts';
 
   if (!opts.isProd) {
@@ -28,8 +28,8 @@ export async function bundleDts(opts: BuildOptions, inputFile: string, ouputOpti
     filePath: inputFile,
   };
 
-  if (ouputOptions) {
-    config.output = ouputOptions;
+  if (outputOptions) {
+    config.output = outputOptions;
   }
 
   const outputCode = cleanDts(generateDtsBundle([config]).join('\n'));