feat: get-doc now uses prettier for writing files in ng-api-docs

valor-software · Nov 26, 2023 · e895d64 · e895d64
1 parent 867bb20
commit e895d64
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 11 deletions.
diff --git a/apps/ngx-bootstrap-docs/src/ng-api-doc.ts b/apps/ngx-bootstrap-docs/src/ng-api-doc.ts
@@ -2197,7 +2197,7 @@ export const ngdoc: any = {
       },
       {
         name: 'matches',
-        type: 'TypeaheadMatch[]',
+        type: 'TypeaheadMatch<any>[]',
         description: '<p>All matches</p>\n'
       },
       {
@@ -2226,7 +2226,7 @@ export const ngdoc: any = {
       },
       {
         name: 'match',
-        type: 'TypeaheadMatch',
+        type: 'TypeaheadMatch<any>',
         description: '<p>Typeahead match</p>\n'
       },
       {
@@ -2247,7 +2247,7 @@ export const ngdoc: any = {
         args: [
           {
             name: 'value',
-            type: 'TypeaheadMatch'
+            type: 'TypeaheadMatch<any>'
           },
           {
             name: 'e',
@@ -2262,7 +2262,7 @@ export const ngdoc: any = {
         args: [
           {
             name: 'value',
-            type: 'TypeaheadMatch'
+            type: 'TypeaheadMatch<any>'
           }
         ],
         returnType: 'void'
@@ -2273,7 +2273,7 @@ export const ngdoc: any = {
         args: [
           {
             name: 'value',
-            type: 'TypeaheadMatch'
+            type: 'TypeaheadMatch<any>'
           }
         ],
         returnType: 'boolean'

diff --git a/scripts/docs/get-doc.js b/scripts/docs/get-doc.js
@@ -1,8 +1,9 @@
 // All rights reserved by ng-bootstrap team, read licence file
 // todo: add ng-bootstrap copyrights
-const fs = require('fs');
+const {writeFileSync} = require('fs');
 const glob = require('glob');
 const doc = require('./api-doc');
+const {format, resolveConfig} = require('prettier');
 
 function getFileNames() {
   return glob.sync('src/**/*.ts', {
@@ -15,9 +16,20 @@ function getApiDocs() {
 }
 
 module.exports = getApiDocs;
-const json = JSON.stringify(getApiDocs(), null, 2);
-fs.writeFileSync('apps/ngx-bootstrap-docs/src/ng-api-doc.ts',
-`/* tslint:disable */
-export const ngdoc: any = ${json};
-`);
 
+async function run() {
+  const json = JSON.stringify(getApiDocs(), null, 2);
+  const outputFile = 'apps/ngx-bootstrap-docs/src/ng-api-doc.ts';
+  const prettierConfig = await resolveConfig(outputFile, { editorConfig: true });
+  writeFileSync(
+    outputFile,
+    await format(
+      `/* tslint:disable */
+       export const ngdoc: any = ${json};
+      `,
+      prettierConfig
+    )
+  );
+}
+
+run();