vue-docgen-cli - npm Package Compare versions

Comparing version 4.0.0-beta.7 to 4.0.0-beta.8

CHANGELOG.md

@@ -6,2 +6,14 @@ # Change Log
 
+# [4.0.0-beta.8](https://github.com/vue-styleguidist/vue-styleguidist/compare/v4.0.0-beta.7...v4.0.0-beta.8) (2019-10-28)
+
+
+### Features
+
+* **cli:** use writeStream for better performance ([25da08c](https://github.com/vue-styleguidist/vue-styleguidist/commit/25da08c))
+* emit types for vue-styleguidist ([f0af958](https://github.com/vue-styleguidist/vue-styleguidist/commit/f0af958))
+
+
+
+
+
 # [4.0.0-beta.7](https://github.com/vue-styleguidist/vue-styleguidist/compare/v4.0.0-beta.6...v4.0.0-beta.7) (2019-10-25)
@@ -8,0 +20,0 @@

lib/singleMd.js

@@ -114,3 +114,3 @@ "use strict";
                     // and finally save all concatenated values to the markdown file
-                    utils_1.writeDownMdFile(Object.values(cachedContent).join(''), config.outFile);
+                    utils_1.writeDownMdFile(Object.values(cachedContent), config.outFile);
                     return [2 /*return*/];
@@ -117,0 +117,0 @@ }

lib/utils.d.ts

@@ -9,3 +9,3 @@ import { FSWatcher } from 'chokidar';
  */
-export declare function writeDownMdFile(content: string, destFilePath: string): Promise<void>;
+export declare function writeDownMdFile(content: string | string[], destFilePath: string): Promise<void>;
 /**
@@ -12,0 +12,0 @@ * From one component, get a markdown documentation and return it as string

lib/utils.js

@@ -57,3 +57,2 @@ "use strict";
 var readFile = util_1.promisify(fs.readFile);
-var writeFile = util_1.promisify(fs.writeFile);
 var mkdirp = util_1.promisify(mkdirp_1.default);
@@ -68,7 +67,7 @@ /**
     return __awaiter(this, void 0, void 0, function () {
-        var prettyMd, destFolder;
+        var prettyMd, destFolder, writeStream;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    prettyMd = prettier_1.default.format(content, { parser: 'markdown' });
+                    prettyMd = function (cont) { return prettier_1.default.format(cont, { parser: 'markdown' }); };
                     destFolder = path.dirname(destFilePath);
@@ -78,5 +77,13 @@ return [4 /*yield*/, mkdirp(destFolder)];
                     _a.sent();
-                    return [4 /*yield*/, writeFile(destFilePath, prettyMd)];
-                case 2:
-                    _a.sent();
+                    writeStream = fs.createWriteStream(destFilePath);
+                    if (Array.isArray(content)) {
+                        content.forEach(function (cont) {
+                            writeStream.write(prettyMd(cont));
+                        });
+                    }
+                    else {
+                        writeStream.write(prettyMd(content));
+                    }
+                    // close the stream
+                    writeStream.close();
                     return [2 /*return*/];
@@ -83,0 +90,0 @@ }

package.json

 {
     "name": "vue-docgen-cli",
-    "version": "4.0.0-beta.7",
+    "version": "4.0.0-beta.8",
     "scripts": {
@@ -18,3 +18,3 @@ "compile": "tsc -p ./tsconfig.build.json",
         "prettier": "^1.18.2",
-        "vue-docgen-api": "^4.0.0-beta.7"
+        "vue-docgen-api": "^4.0.0-beta.8"
     },
@@ -26,3 +26,3 @@ "devDependencies": {
     },
-    "gitHead": "38fa1471c0dc0d9835579d853961b033938e6e51"
+    "gitHead": "a101d4fcb896159d259f9b79319338c1ad5f161e"
 }

src/__tests__/singleMd.ts

@@ -40,3 +40,3 @@ import { FSWatcher } from 'chokidar'
 			await singleMd.compile(conf, [FAKE_COMPONENT_PATH], {}, {})
-			expect(writeDownMdFile).toHaveBeenCalledWith(FAKE_MD_CONTENT, MD_FILE_PATH)
+			expect(writeDownMdFile).toHaveBeenCalledWith([FAKE_MD_CONTENT], MD_FILE_PATH)
 			done()
@@ -43,0 +43,0 @@ })

src/__tests__/utils.ts

@@ -13,7 +13,24 @@ import * as path from 'path'
 	existsSync: jest.Mock
+	createWriteStream: (
+		a: string
+	) => {
+		write: jest.Mock
+		close: jest.Mock
+	}
 }
+
+let cws: {
+	write: jest.Mock
+	close: jest.Mock
+}
+
 jest.mock('fs', () => {
+	cws = {
+		write: jest.fn(),
+		close: jest.fn()
+	}
 	mockFs = {
 		readFile: jest.fn((a, b, c) => c()),
 		writeFile: jest.fn((a, b, c) => c()),
+		createWriteStream: a => cws,
 		existsSync: jest.fn(() => false)
@@ -53,3 +70,3 @@ }
 		await writeDownMdFile(UGLY_MD, MD_FILE_PATH)
-		expect(mockFs.writeFile).toHaveBeenCalledWith(MD_FILE_PATH, PRETTY_MD, expect.any(Function))
+		expect(cws.write).toHaveBeenCalledWith(PRETTY_MD)
 		done()
@@ -56,0 +73,0 @@ })

src/singleMd.ts

@@ -74,3 +74,3 @@ import { FSWatcher } from 'chokidar'
 	// and finally save all concatenated values to the markdown file
-	writeDownMdFile(Object.values(cachedContent).join(''), config.outFile)
+	writeDownMdFile(Object.values(cachedContent), config.outFile)
 }

src/utils.ts

@@ -10,3 +10,2 @@ import * as path from 'path'
 const readFile = promisify(fs.readFile)
-const writeFile = promisify(fs.writeFile)
 const mkdirp = promisify(mkdirpNative)
@@ -20,7 +19,17 @@
  */
-export async function writeDownMdFile(content: string, destFilePath: string) {
-	const prettyMd = prettier.format(content, { parser: 'markdown' })
+export async function writeDownMdFile(content: string | string[], destFilePath: string) {
+	const prettyMd = (cont: string) => prettier.format(cont, { parser: 'markdown' })
 	const destFolder = path.dirname(destFilePath)
 	await mkdirp(destFolder)
-	await writeFile(destFilePath, prettyMd)
+	let writeStream = fs.createWriteStream(destFilePath)
+	if (Array.isArray(content)) {
+		content.forEach(cont => {
+			writeStream.write(prettyMd(cont))
+		})
+	} else {
+		writeStream.write(prettyMd(content))
+	}
+
+	// close the stream
+	writeStream.close()
 }
@@ -27,0 +36,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

99055

increased by1.11%

Lines of code

2064

increased by1.47%

Dependency changes

• Updatedvue-docgen-api@^4.0.0-beta.8