gherkin-lint/dist/feature-finder.js

A Gherkin linter/validator written in javascript

"use strict";

const _ = require('lodash');

const glob = require('glob');

const fs = require('fs');

const path = require('path');

const logger = require('./logger.js');

const defaultIgnoreFileName = '.gherkin-lintignore';
const defaultIgnoredFiles = 'node_modules/**'; // Ignore node_modules by default

function getFeatureFiles(args, ignoreArg) {
  let files = [];
  const patterns = args.length ? args : ['.'];
  patterns.forEach(pattern => {
    // First we need to fix up the pattern so that it only matches .feature files
    // and it's in the format that glob expects it to be
    let fixedPattern;

    if (pattern == '.') {
      fixedPattern = '**/*.feature';
    } else if (pattern.match(/.*\/\*\*/)) {
      fixedPattern = pattern + '/**.feature';
    } else if (pattern.match(/.*\.feature/)) {
      fixedPattern = pattern;
    } else {
      try {
        if (fs.statSync(pattern).isDirectory()) {
          fixedPattern = path.join(pattern, '**/*.feature');
        }
      } catch (e) {// Don't show the fs callstack, we will print a custom error message bellow instead
      }
    }

    if (!fixedPattern) {
      logger.boldError(`Invalid format of the feature file path/pattern: "${pattern}".\n
        To run the linter please specify an existing feature file, directory or glob.`);
      process.exit(1);
      return; // This line will only be hit by tests that stub process.exit
    }

    const globOptions = {
      ignore: getIgnorePatterns(ignoreArg),
      nodir: true
    };
    files = files.concat(glob.sync(fixedPattern, globOptions));
  });
  return _.uniq(files);
}

function getIgnorePatterns(ignoreArg) {
  if (ignoreArg) {
    return ignoreArg;
  } else if (fs.existsSync(defaultIgnoreFileName)) {
    // return an array where each element of the array is a line of the ignore file
    return fs.readFileSync(defaultIgnoreFileName).toString().split(/[\n|\r]/).filter(i => {
      // remove empty strings
      if (i !== '') {
        return true;
      }

      return false;
    });
  } else {
    return defaultIgnoredFiles;
  }
}

module.exports = {
  getFeatureFiles: getFeatureFiles,
  defaultIgnoreFileName: defaultIgnoreFileName
};