If the module is a single dts file, show it in the README

microsoft · May 20, 2021 · 53d2b24 · 53d2b24
1 parent dd16981
commit 53d2b24
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/packages/definitions-parser/src/packages.ts b/packages/definitions-parser/src/packages.ts
@@ -573,6 +573,9 @@ export class TypingsData extends PackageBase {
   get files(): readonly string[] {
     return this.data.files;
   }
+  get dtsFiles(): readonly string[] {
+    return this.data.files.filter(f => f.endsWith(".d.ts"));
+  }
   get license(): License {
     return this.data.license;
   }

diff --git a/packages/publisher/src/generate-packages.ts b/packages/publisher/src/generate-packages.ts
@@ -98,13 +98,13 @@ async function generateTypingPackage(
   await writeCommonOutputs(
     typing,
     createPackageJSON(typing, version, packages, Registry.NPM),
-    createReadme(typing),
+    createReadme(typing, packageFS),
     Registry.NPM
   );
   await writeCommonOutputs(
     typing,
     createPackageJSON(typing, version, packages, Registry.Github),
-    createReadme(typing),
+    createReadme(typing, packageFS),
     Registry.Github
   );
   await Promise.all(
@@ -258,7 +258,7 @@ export function createNotNeededPackageJSON(
   return JSON.stringify(out, undefined, 4);
 }
 
-export function createReadme(typing: TypingsData): string {
+export function createReadme(typing: TypingsData, packageJFS: FS): string {
   const lines: string[] = [];
   lines.push("# Installation");
   lines.push(`> \`npm install --save ${typing.fullNpmName}\``);
@@ -275,6 +275,14 @@ export function createReadme(typing: TypingsData): string {
   lines.push("# Details");
   lines.push(`Files were exported from ${definitelyTypedURL}/tree/${sourceBranch}/types/${typing.subDirectoryPath}.`);
 
+  if (typing.dtsFiles.length === 1) {
+    const dts = typing.dtsFiles[0]
+    lines.push("## " + path.basename(dts))
+    lines.push("```ts")
+    lines.push(packageJFS.readFile(dts))
+    lines.push("```")
+  }
+
   lines.push("");
   lines.push("### Additional Details");
   lines.push(` * Last updated: ${new Date().toUTCString()}`);