feat: add support for custom success/fail message (#3)

.eslintrc.yml

@@ -8,6 +8,11 @@ plugins:
 
 rules:
   file-progress/activate: 1
+settings:
+  progress:
+    hide-progress: false
+    success-message: "Lint done..."
+    fail-message: "Lint done with errors."
 
 env:
   node: true

README.md

@@ -26,6 +26,11 @@ plugins:
 
 rules:
   file-progress/activate: 1
+settings:
+  progress:
+    hide-progress: false
+    success-message: "Lint done..."
+    fail-message: "Lint done with errors."
 ```
 
 ### Demo

rules/progress.js

@@ -7,26 +7,45 @@ const spinner = ora({
 });
 
 let bindExit = false;
+let initialReportDone = false;
 
-const exitCallback = (exitCode) => {
+const exitCallback = (exitCode, settings) => {
   if (exitCode === 0) {
-    spinner.succeed('Lint done...');
+    spinner.succeed(
+      settings && typeof settings['success-message'] === 'string'
+        ? settings['success-message']
+        : 'Lint done...',
+    );
+  } else {
+    spinner.fail(
+      settings && typeof settings['fail-message'] === 'string'
+        ? settings['fail-message']
+        : 'Lint done with errors.',
+    );
   }
 };
 
 const rootPath = process.cwd();
 
 const create = (context) => {
   if (!bindExit) {
-    process.on('exit', exitCallback);
+    process.on('exit', (code) => {
+      exitCallback(code, context.settings);
+    });
     bindExit = true;
   }
 
-  const filename = context.getFilename();
-  const relativeFilePath = path.relative(rootPath, filename);
+  if (!context.settings['hide-progress']) {
+    const filename = context.getFilename();
+    const relativeFilePath = path.relative(rootPath, filename);
 
-  spinner.text = `Processing: ${chalk.green(relativeFilePath)} \n`;
-  spinner.render();
+    spinner.text = `Processing: ${chalk.green(relativeFilePath)} \n`;
+    spinner.render();
+  } else if (!initialReportDone) {
+    spinner.text = 'Linting \n';
+    spinner.render();
+    initialReportDone = true;
+  }
 
   return {};
 };

test.js

@@ -8,6 +8,13 @@ const ruleName = 'file-progress/activate';
 ruleTester.run(ruleName, progress, {
   valid: [
     'var foo = \'bar\'',
+    {
+      code: 'var foo = \'bar\'',
+      settings: {
+        'hide-progress': true,
+        'success-message': 'API lint done...',
+      },
+    },
   ],
   invalid: [],
 });