Change report methods

hcodes · Mar 30, 2020 · 8f2eb55 · 8f2eb55
1 parent a70331b
commit 8f2eb55
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 24 deletions.
diff --git a/lib/cli/index.js b/lib/cli/index.js
@@ -68,14 +68,14 @@ if (!isStdin && !program.args.length) {
     program.help();
 }
 
-reports.onstart();
+reports.onStart();
 
 async.series(
     isStdin ?
         tasks.forStdin(settings, program.stdinFilename) :
         tasks.forResources(program.args, settings),
     function() {
-        reports.onend(jsonConfig.relativePath);
+        reports.onComplete(jsonConfig.relativePath);
         process.exit();
     }
 );
diff --git a/lib/reports/console.js b/lib/reports/console.js
@@ -60,10 +60,10 @@ function getTyposByCode(code, data) {
 }
 
 module.exports = {
-    onstart() {
+    onStart() {
         consoleLog('Spelling check:');
     },
-    oneach(err, data) {
+    onResourceComplete(err, data) {
         const errors = [];
         if (err) {
             consoleError(data);
@@ -98,7 +98,7 @@ module.exports = {
             }
         }
     },
-    onend(data, stats, configPath) {
+    onComplete(data, stats, configPath) {
         if (!program.onlyErrors && stats.total) {
             if (stats.hasTypos) {
                 let path = configPath + ' (';

diff --git a/lib/reports/error_dictionary.js b/lib/reports/error_dictionary.js
@@ -9,7 +9,7 @@ const { consoleError, consoleInfo } = require('../helpers/console');
 const filename = 'yaspeller_error_dictionary.json';
 
 module.exports = {
-    onend(data) {
+    onComplete(data) {
         let buffer = [];
 
         data.forEach(function(el) {

diff --git a/lib/reports/example.js b/lib/reports/example.js
@@ -1,13 +1,13 @@
 'use strict';
 
 module.exports = {
-    onstart() {
-        console.log('onstart');
+    onStart() {
+        console.log('oSstart');
     },
-    oneach(err, data) {
-        console.log('oneach: ', err, data);
+    onResourceComplete(err, data) {
+        console.log('onResourceComplete: ', err, data);
     },
-    onend(data, stats) {
-        console.log('onend: ', data, stats);
+    onComplete(data, stats) {
+        console.log('on: ', data, stats);
     }
 };
diff --git a/lib/reports/html.js b/lib/reports/html.js
@@ -66,7 +66,7 @@ function loadFile(filename) {
 const filename = 'yaspeller_report.html';
 
 module.exports = {
-    oneach(err, data) {
+    onResourceComplete(err, data) {
         const html = [];
         if (err) {
             html.push('<div class="syserr">' + data + '</div>');
@@ -122,7 +122,7 @@ module.exports = {
 
         buffer.push(html.join('\n'));
     },
-    onend(data, stats) {
+    onComplete(data, stats) {
         const content = '<div class="total">Processed resources: ' + stats.total +
                 ' (<span class="sym-err">χ</span>– ' + stats.errors +
                 '</span>, <span class="sym-ok-group"><span class="sym-ok">✓</span>– ' + stats.ok + '</span>) ' +

diff --git a/lib/reports/index.js b/lib/reports/index.js
@@ -33,12 +33,12 @@ module.exports = {
             }
         });
     },
-    onstart() {
+    onStart() {
         reports.forEach(function(name) {
-            name.onstart && name.onstart();
+            name.onStart && name.onStart();
         });
     },
-    oneach(hasError, data, dictionary) {
+    onResourceComplete(hasError, data, dictionary) {
         stats.total++;
 
         const hasTypos = Boolean(data && data.data && data.data.length);
@@ -61,13 +61,13 @@ module.exports = {
 
         if (!program.onlyErrors || hasError || hasTypos) {
             reports.forEach(function(name) {
-                name.oneach && name.oneach(hasError, data, dictionary);
+                name.onResourceComplete && name.onResourceComplete(hasError, data, dictionary);
             });
         }
     },
-    onend(configPath) {
+    onComplete(configPath) {
         reports.forEach(function(name) {
-            name.onend && name.onend(buffer, stats, configPath);
+            name.onComplete && name.onComplete(buffer, stats, configPath);
         });
     }
 };
diff --git a/lib/reports/json.js b/lib/reports/json.js
@@ -8,7 +8,7 @@ const { consoleError, consoleInfo } = require('../helpers/console');
 const filename = 'yaspeller_report.json';
 
 module.exports = {
-    onend(data) {
+    onComplete(data) {
         try {
             fs.writeFileSync(filename, jsonStringify(data));
             consoleInfo(`JSON report: ./${filename}`);

diff --git a/lib/reports/markdown.js b/lib/reports/markdown.js
@@ -32,7 +32,7 @@ function prepareResource(resource) {
 const filename = 'yaspeller_report.md';
 
 module.exports = {
-    oneach(err, data) {
+    onResourceComplete(err, data) {
         const text = [];
         if (err) {
             text.push('**' + data + '**<br/><br/>\n');
@@ -77,7 +77,7 @@ module.exports = {
 
         buffer.push(text.join('\n'));
     },
-    onend(data, stats) {
+    onComplete(data, stats) {
         const text = '<br/><br/>Processed resources: ' + stats.total +
                 ' (χ – ' + stats.errors + ', ✓ – ' + stats.ok + ')<br/>' +
                 'Checking finished: ' + uptime() + '<br/><br/>\n' +

diff --git a/lib/tasks.js b/lib/tasks.js
@@ -34,7 +34,7 @@ function onResource(err, data, originalText) {
         process.exitCode = exitCodes.ERROR_LOADING;
     }
 
-    reports.oneach(err, data);
+    reports.onResouceComplete(err, data);
 }
 
 module.exports = {