feat(core): add tty progress and compilation feature #OSP-163 (#232)

docgeni · Sep 17, 2021 · f635042 · f635042
1 parent 8dcb876
commit f635042
Show file tree

Hide file tree

Showing 39 changed files with 1,024 additions and 521 deletions.
diff --git a/packages/cli/src/build.ts b/packages/cli/src/build.ts
@@ -6,6 +6,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import { yargsOptionsGenerate } from './util/yargs-options-generate';
 import { Option } from '@angular/cli/models/interface';
+import { VERSION } from './version';
 const ngBuildOptions: Option[] = JSON.parse(fs.readFileSync(path.resolve(__dirname, './ng-build-options.json')).toString());
 export const buildCommand: CommandModule = {
     command: ['build'],
@@ -36,7 +37,8 @@ export const buildCommand: CommandModule = {
         const docgeni = new Docgeni({
             watch: argv.watch,
             config,
-            cmdArgs: normalizeCommandArgsForAngular(config, ngBuildOptions)
+            cmdArgs: normalizeCommandArgsForAngular(config, ngBuildOptions),
+            version: VERSION
         });
         await docgeni.run();
     }

diff --git a/packages/cli/src/serve.ts b/packages/cli/src/serve.ts
@@ -6,6 +6,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import { yargsOptionsGenerate } from './util/yargs-options-generate';
 import { Option } from '@angular/cli/models/interface';
+import { VERSION } from './version';
 
 const ngServeOptions: Option[] = JSON.parse(fs.readFileSync(path.resolve(__dirname, './ng-serve-options.json')).toString());
 
@@ -33,7 +34,8 @@ export const serveCommand: CommandModule = {
         const docgeni = new Docgeni({
             watch: true,
             config,
-            cmdArgs: normalizeCommandArgsForAngular(config, ngServeOptions)
+            cmdArgs: normalizeCommandArgsForAngular(config, ngServeOptions),
+            version: VERSION
         });
         await docgeni.run();
     }

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -31,6 +31,7 @@
     "@angular-devkit/core": "~11.2.14",
     "@angular-devkit/schematics": "~11.2.14",
     "@docgeni/toolkit": "^1.1.0-next.4",
+    "@types/text-table": "^0.2.2",
     "chokidar": "^3.3.1",
     "cosmiconfig": "^6.0.0",
     "fancy-log": "^1.3.3",
@@ -42,6 +43,7 @@
     "prismjs": "^1.20.0",
     "semver": "7.3.2",
     "tapable": "^1.1.3",
+    "text-table": "^0.2.0",
     "through2": "^3.0.1",
     "ts-morph": "^7.0.2",
     "vinyl": "^2.2.0",

diff --git a/packages/core/src/builders/components-builder.ts b/packages/core/src/builders/components-builder.ts
@@ -2,6 +2,7 @@ import { DocgeniContext } from '../docgeni.interface';
 import { DocgeniHost } from '../docgeni-host';
 import { toolkit } from '@docgeni/toolkit';
 import { normalize, relative, resolve, HostWatchEventType } from '../fs';
+import { getSummaryStr } from '../utils';
 
 export interface ComponentDef {
     name: string;
@@ -69,11 +70,11 @@ export class ComponentsBuilder {
         if (!this.docgeni.watch) {
             return;
         }
-        toolkit.print.info(`Components: start watching ${this.componentsSourcePath}`);
+        // toolkit.print.info(`Components: start watching ${this.componentsSourcePath}`);
         return this.docgeni.host.watch(this.componentsSourcePath, { ignoreInitial: true, recursive: true }).subscribe(async item => {
             try {
                 const type: HostWatchEventType = item.type as any;
-                toolkit.print.info(`Components: ${item.path}, type: ${HostWatchEventType[item.type]}`);
+                toolkit.print.info(`Components: ${getSummaryStr(item.path)}, type: ${HostWatchEventType[item.type]}`);
                 const { name, componentPath } = this.getComponentOfFile(item.path);
                 if (!name) {
                     return;

diff --git a/packages/core/src/builders/doc-file.spec.ts b/packages/core/src/builders/doc-file.spec.ts
@@ -27,8 +27,7 @@ describe('DocSourceFile', () => {
                     base: root,
                     locale: 'zh-cn'
                 },
-                docgeniHost,
-                undefined
+                docgeniHost
             );
         });
 
@@ -44,8 +43,7 @@ describe('DocSourceFile', () => {
                     base: root,
                     locale: 'zh-cn'
                 },
-                docgeniHost,
-                undefined
+                docgeniHost
             );
             expect(() => {
                 const name = docSourceFile.name;
@@ -84,8 +82,7 @@ describe('DocSourceFile', () => {
                     base: root,
                     locale: 'zh-cn'
                 },
-                docgeniHost,
-                undefined
+                docgeniHost
             );
         });
 
@@ -130,8 +127,7 @@ describe('DocSourceFile', () => {
                 base: root,
                 locale: 'zh-cn'
             },
-            docgeniHost,
-            undefined
+            docgeniHost
         );
         await docSourceFile.build();
         expect(docSourceFile.output).toContain(`<p>getting-started content</p>`);
@@ -152,8 +148,7 @@ describe('DocSourceFile', () => {
                 base: root,
                 locale: 'zh-cn'
             },
-            docgeniHost,
-            undefined
+            docgeniHost
         );
         await docSourceFile.build();
         await docSourceFile.emit('/dest/root');
@@ -175,8 +170,7 @@ describe('DocSourceFile', () => {
                 base: root,
                 locale: 'zh-cn'
             },
-            docgeniHost,
-            undefined
+            docgeniHost
         );
         await docSourceFile.build();
         await docSourceFile.emit('/dest/root');
@@ -198,8 +192,7 @@ describe('DocSourceFile', () => {
                 base: root,
                 locale: 'zh-cn'
             },
-            docgeniHost,
-            undefined
+            docgeniHost
         );
         await docSourceFile.build();
         await docSourceFile.emit('/dest/root');
@@ -221,8 +214,7 @@ describe('DocSourceFile', () => {
                 base: root,
                 locale: 'zh-cn'
             },
-            docgeniHost,
-            undefined
+            docgeniHost
         );
         expect(docSourceFile.isEmpty()).toEqual(true);
         await docSourceFile.build();

diff --git a/packages/core/src/builders/doc-file.ts b/packages/core/src/builders/doc-file.ts
@@ -5,7 +5,6 @@ import { DocType } from '../enums';
 import { Markdown } from '../markdown';
 import { normalize, relative } from '@angular-devkit/core';
 import { DocgeniHost } from '../docgeni-host';
-import { DocgeniConfig } from '../interfaces';
 
 export interface DocSourceFileOptions {
     cwd: string;
@@ -26,7 +25,7 @@ export class DocSourceFile<TMeta extends DocMeta = DocMeta> {
     public type: DocType;
     public content: string;
     public meta?: TMeta;
-    public output: string;
+    public output: string = '';
     /**
      * @example "docs/guide/getting-started.md" when base is cwd and path=/../docs/guide/getting-started.md
      */
@@ -68,7 +67,7 @@ export class DocSourceFile<TMeta extends DocMeta = DocMeta> {
         return path.basename(this.path, this.extname);
     }
 
-    constructor(options: DocSourceFileOptions, host: DocgeniHost, private docConfig: DocgeniConfig) {
+    constructor(options: DocSourceFileOptions, host: DocgeniHost) {
         this.cwd = options.cwd;
         this.base = options.base;
         this.path = options.path;
@@ -94,7 +93,7 @@ export class DocSourceFile<TMeta extends DocMeta = DocMeta> {
 
     public async emit(destRootPath: string) {
         if (this.emitted) {
-            return;
+            return {};
         }
         const outputPath = this.getOutputPath(destRootPath);
         await this.host.writeFile(outputPath, this.output);
@@ -103,6 +102,7 @@ export class DocSourceFile<TMeta extends DocMeta = DocMeta> {
         }
         this.outputPath = outputPath;
         this.emitted = true;
+        return { outputPath: outputPath, content: this.output };
     }
 
     public async clear() {