Merge pull request #850 from volodya-lombrozo/838-make-lints-optional

feat(#838): disable linting with --blind flag to improve performance

Author: yegor256

README.md

@@ -147,6 +147,11 @@ There are also commands that help manipulate with XMIR and EO sources
 This command line toolkit simply integrates other tools available in
 the [@objectionary](https://github.com/objectionary) GitHub organization.
 
+## Linting
+
+There are two ways to work with linting. The `--easy` option enables linting
+but ignores warnings, while the `--blind` option completely disables linting.
+
 ## How to Test
 
 To execute the project tests, use the following command:

src/commands/lint.js

@@ -17,7 +17,6 @@ const semver = require('semver');
 module.exports = function(opts) {
   const extra = [
     `-Deo.failOnWarning=${opts.easy ? 'false' : 'true'}`,
-    `-Deo.skipLinting=${opts.blind ? 'true' : 'false'}`,
   ];
   return elapsed(async (tracked) => {
     if (opts.parser.endsWith('-SNAPSHOT') || semver.gte(opts.parser, '0.45.0')) {

src/eoc.js

@@ -94,7 +94,7 @@ program
   .option('-s, --sources <path>', 'Directory with .EO sources', '.')
   .option('-t, --target <path>', 'Directory with all generated files', '.eoc')
   .option('--easy', 'Ignore "warnings" and only fail if there are "errors" or "critical" errors')
-  .option('--blind', 'Ignore "warnings," "errors," and "critical" errors')
+  .option('--blind', 'Disable linting')
   .option('--home-tag <version>', 'Git tag in objectionary/home to compile against', tag)
   .option('--parser <version>', 'Set the version of EO parser to use', parser)
   .option('--latest', 'Use the latest parser version from Maven Central')

src/mvnw.js

@@ -56,6 +56,7 @@ module.exports.flags = function (opts) {
     `-Deo.generatedDir=${path.resolve(opts.target, 'generated-sources')}`,
     `-Deo.placed=${path.resolve(opts.target, 'eo-placed.csv')}`,
     `-Deo.placedFormat=csv`,
+    `-Deo.skipLinting=${opts.blind ? 'true' : 'false'}`,
     opts.trackTransformationSteps ? '-Deo.trackTransformationSteps' : '',
   ];
 };
@@ -69,6 +70,7 @@ module.exports.flags = function (opts) {
  */
 module.exports.mvnw = function (args, tgt, batch) {
   return new Promise((resolve, reject) => {
+    console.debug(`Running mvnw with arguments: ${args.join(' ')}`);
     target = tgt;
     phase = args[0];
     const home = path.resolve(__dirname, '../mvnw');

test/commands/test_compile.js

@@ -96,6 +96,25 @@ describe('compile', () => {
     ]);
     assert.ok(stdout.includes('skipped for JavaScript'));
   });
+  it('Skips linting if --blind specified', () => {
+    const home = path.resolve('temp/test-compile/simple');
+    fs.rmSync(home, {recursive: true, force: true});
+    fs.mkdirSync(path.resolve(home, 'src', 'foo', 'bar'), {recursive: true});
+    fs.writeFileSync(path.resolve(home, 'src/foo/bar/compile3.eo'), simple('compile3'));
+    const stdout = runSync([
+      'compile',
+      '--verbose',
+      '--blind',
+      `--parser=${parserVersion}`,
+      `--home-tag=${homeTag}`,
+      '-s', path.resolve(home, 'src'),
+      '-t', path.resolve(home, 'target'),
+    ]);
+    assert.ok(
+      stdout.includes('Linting is skipped because eo:skipLinting is TRUE'),
+      'Linting should be skipped with --blind option'
+    );
+  });
 });
 
 /**

test/commands/test_lint.js

@@ -35,4 +35,24 @@ describe('lint', () => {
     assert(!fs.existsSync(path.resolve('../../mvnw/target')));
     done();
   });
+  it('avoid linting if --blind option is provided', (done) => {
+    const home = path.resolve('temp/test-lint/simple');
+    fs.rmSync(home, {recursive: true, force: true});
+    fs.mkdirSync(path.resolve(home, 'src'), {recursive: true});
+    fs.writeFileSync(path.resolve(home, 'src/simple.eo'), '# sample\n[] > simple\n');
+    runSync([
+      'lint',
+      '--verbose',
+      '--blind',
+      '--track-transformation-steps',
+      `--parser=${parserVersion}`,
+      `--home-tag=${homeTag}`,
+      '-s', path.resolve(home, 'src'),
+      '-t', path.resolve(home, 'target'),
+    ]);
+    assert(
+      !fs.existsSync(path.resolve(home, 'target/3-lint/simple.xmir')),
+      'Linting should be skipped with --blind option');
+    done();
+  });
 });