refactoring (#1376)

anthony-redFox · web-flow · commit 806defa19155 · 2021-05-04T16:25:36.000+03:00
* refactor: replace leftPad on native implementation padStart

* refactor: migrate on new Buffer API
diff --git a/__tests__/fixture/custom_theme/index.js b/__tests__/fixture/custom_theme/index.js
@@ -9,7 +9,7 @@ module.exports = function(comments, options, callback) {
     new File({
       base: '/',
       path: '/index.html',
-      contents: new Buffer('Hello world')
+      contents: Buffer.from('Hello world')
     })
   ]);
 };
diff --git a/__tests__/lib/server.js b/__tests__/lib/server.js
@@ -7,33 +7,33 @@ const jsFile = new File({
   cwd: '/',
   base: '/test/',
   path: '/test/file.js',
-  contents: new Buffer('var test = 123;')
+  contents: Buffer.from('var test = 123;')
 });
 
 const coffeeFile = new File({
   cwd: '/',
   base: '/test/',
   path: '/test/file.coffee',
-  contents: new Buffer('test = 123')
+  contents: Buffer.from('test = 123')
 });
 
 const indexFile = new File({
   cwd: '/',
   base: '/test/',
   path: '/test/index.html',
-  contents: new Buffer('<html>')
+  contents: Buffer.from('<html>')
 });
 
-test('server - throws on bad port', function() {
-  expect(function() {
+test('server - throws on bad port', function () {
+  expect(function () {
     const server = new Server('${port}');
   }).toThrow();
-  expect(function() {
+  expect(function () {
     const server = new Server();
   }).toThrow();
 });
 
-test('server', async function() {
+test('server', async function () {
   const port = await getPort();
   const server = new Server(port, true);
   expect(server).toBeTruthy();
diff --git a/src/default_theme/index.js b/src/default_theme/index.js
@@ -115,7 +115,7 @@ module.exports = function (comments, config) {
           files.concat(
             new File({
               path: 'index.html',
-              contents: new Buffer(
+              contents: Buffer.from(
                 pageTemplate({
                   docs: comments,
                   config
diff --git a/src/parsers/javascript.js b/src/parsers/javascript.js
@@ -8,22 +8,6 @@ const debuglog = util.debuglog('documentation');
 const findTarget = require('../infer/finders').findTarget;
 const { parseToAst } = require('./parse_to_ast');
 
-/**
- * Left-pad a string so that it can be sorted lexicographically. We sort
- * comments to keep them in order.
- * @param {string} str the string
- * @param {number} width the width to pad to
- * @returns {string} a padded string with the correct width
- * @private
- */
-function leftPad(str, width) {
-  str = str.toString();
-  while (str.length < width) {
-    str = '0' + str;
-  }
-  return str;
-}
-
 /**
  * Receives a module-dep item,
  * reads the file, parses the JavaScript, and parses the JSDoc.
@@ -77,7 +61,8 @@ function _addComment(
     }*/ = {
       loc: nodeLoc,
       file: data.file,
-      sortKey: data.sortKey + ' ' + leftPad(nodeLoc.start.line, 8)
+      sortKey:
+        data.sortKey + ' ' + nodeLoc.start.line.toString().padStart(8, '0')
     };
 
     if (includeContext) {
diff --git a/src/serve/error_page.js b/src/serve/error_page.js
@@ -33,7 +33,7 @@ function errorPage(error) {
   }
   return new File({
     path: 'index.html',
-    contents: new Buffer(template + errorText)
+    contents: Buffer.from(template + errorText)
   });
 }
 

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ function errorPage(error) {`
`33`	`33`	`}`
`34`	`34`	`return new File({`
`35`	`35`	`path: 'index.html',`
`36`		`- contents: new Buffer(template + errorText)`
	`36`	`+ contents: Buffer.from(template + errorText)`
`37`	`37`	`});`
`38`	`38`	`}`
`39`	`39`