signal-desktop/ts/util/lint/linter.ts

// tslint:disable no-console

import { readFileSync } from 'fs';
import { join, relative } from 'path';
import normalizePath from 'normalize-path';

import { sync as fgSync } from 'fast-glob';
import { forEach, some, values } from 'lodash';

import { ExceptionType, REASONS, RuleType } from './types';
import { ENCODING, loadJSON, sortExceptions } from './util';

const ALL_REASONS = REASONS.join('|');
const now = new Date();

function getExceptionKey(exception: any) {
  return `${exception.rule}-${exception.path}-${exception.lineNumber}`;
}

function createLookup(list: Array<any>) {
  const lookup = Object.create(null);

  forEach(list, exception => {
    const key = getExceptionKey(exception);

    if (lookup[key]) {
      throw new Error(`Duplicate exception found for key ${key}`);
    }

    lookup[key] = exception;
  });

  return lookup;
}

const rulesPath = join(__dirname, 'rules.json');
const exceptionsPath = join(__dirname, 'exceptions.json');
const basePath = join(__dirname, '../../..');

const searchPattern = normalizePath(join(basePath, '**/*.{js,ts,tsx}'));

const rules: Array<RuleType> = loadJSON(rulesPath);
const exceptions: Array<ExceptionType> = loadJSON(exceptionsPath);
const exceptionsLookup = createLookup(exceptions);
let scannedCount = 0;

const allSourceFiles = fgSync(searchPattern, { onlyFiles: true });

const results: Array<ExceptionType> = [];

const excludedFiles = [
  // Non-distributed files
  '\\.d\\.ts$',

  // High-traffic files in our project
  '^js/models/messages.js',
  '^js/views/conversation_view.js',
  '^js/background.js',
  '^ts/Crypto.js',
  '^ts/Crypto.ts',
  '^ts/textsecure/MessageReceiver.js',
  '^ts/textsecure/MessageReceiver.ts',

  // Generated files
  '^js/components.js',
  '^js/curve/',
  '^js/libtextsecure.js',
  '^js/util_worker.js',
  '^libtextsecure/components.js',
  '^libtextsecure/test/test.js',
  '^sticker-creator/dist/bundle.js',
  '^test/test.js',

  // From libsignal-protocol-javascript project
  '^js/libsignal-protocol-worker.js',
  '^libtextsecure/libsignal-protocol.js',

  // Copied from dependency
  '^js/Mp3LameEncoder.min.js',

  // Test files
  '^libtextsecure/test/*',
  '^test/*',

  // Modules we trust
  '^node_modules/core-js-pure/.+',
  '^node_modules/core-js/.+',
  '^node_modules/fbjs/.+',
  '^node_modules/react/.+',
  '^node_modules/react-contextmenu/.+',
  '^node_modules/react-dom/.+',
  '^node_modules/react-dropzone/.+',
  '^node_modules/react-hot-loader/.+',
  '^node_modules/react-icon-base/.+',
  '^node_modules/react-input-autosize/.+',
  '^node_modules/react-measure/.+',
  '^node_modules/react-popper/.+',
  '^node_modules/react-redux/.+',
  '^node_modules/react-router/.+',
  '^node_modules/react-router-dom/.+',
  '^node_modules/react-select/.+',
  '^node_modules/react-sortable-hoc/.+',
  '^node_modules/react-transition-group/.+',
  '^node_modules/react-virtualized/.+',
  '^node_modules/reactcss/.+',

  // Submodules we trust
  '^node_modules/react-color/.+/(?:core-js|fbjs|lodash)/.+',

  // Modules used only in test/development scenarios
  '^node_modules/@babel/*',
  '^node_modules/@svgr/*',
  '^node_modules/@types/*',
  '^node_modules/@webassemblyjs/*',
  '^node_modules/ajv/*',
  '^node_modules/amdefine/*',
  '^node_modules/ansi-colors/*',
  '^node_modules/anymatch/*',
  '^node_modules/app-builder-lib/*',
  '^node_modules/archiver/.+', // Used by spectron
  '^node_modules/archiver-utils/.+', // Used by spectron
  '^node_modules/asn1\\.js/*',
  '^node_modules/autoprefixer/*',
  '^node_modules/babel*',
  '^node_modules/bluebird/*',
  '^node_modules/body-parser/*',
  '^node_modules/bower/*',
  '^node_modules/buble/*',
  '^node_modules/builder-util/*',
  '^node_modules/builder-util-runtime/*',
  '^node_modules/chai/*',
  '^node_modules/catharsis/*',
  '^node_modules/clean-css/*',
  '^node_modules/cli-table2/*',
  '^node_modules/codemirror/*',
  '^node_modules/coffee-script/*',
  '^node_modules/compression/*',
  '^node_modules/cross-env/*',
  '^node_modules/css-loader/*',
  '^node_modules/css-modules-loader-core/*',
  '^node_modules/css-selector-tokenizer/*',
  '^node_modules/css-tree/*',
  '^node_modules/csso/*',
  '^node_modules/degenerator/*',
  '^node_modules/detect-port-alt/*',
  '^node_modules/electron-builder/*',
  '^node_modules/electron-mocha/',
  '^node_modules/electron-icon-maker/*',
  '^node_modules/electron-osx-sign/*',
  '^node_modules/electron-publish/*',
  '^node_modules/emotion/*', // Currently only used in storybook
  '^node_modules/es-abstract/*',
  '^node_modules/es5-shim/*', // Currently only used in storybook
  '^node_modules/es6-shim/*', // Currently only used in storybook
  '^node_modules/escodegen/*',
  '^node_modules/eslint*',
  '^node_modules/esprima/*',
  '^node_modules/express/*',
  '^node_modules/file-loader/*',
  '^node_modules/file-system-cache/*', // Currently only used in storybook
  '^node_modules/finalhandler/*',
  '^node_modules/fsevents/*',
  '^node_modules/globule/*',
  '^node_modules/grunt/*',
  '^node_modules/handle-thing/*',
  '^node_modules/handlebars/*', // Used by nyc#istanbul-reports
  '^node_modules/har-validator/*',
  '^node_modules/highlight\\.js/*',
  '^node_modules/hpack\\.js/*',
  '^node_modules/http-proxy-middlewar/*',
  '^node_modules/icss-utils/*',
  '^node_modules/intl-tel-input/examples/*',
  '^node_modules/istanbul*',
  '^node_modules/jimp/*',
  '^node_modules/jquery/*',
  '^node_modules/jsdoc/*',
  '^node_modules/jss/*',
  '^node_modules/jss-global/*',
  '^node_modules/livereload-js/*',
  '^node_modules/lolex/*',
  '^node_modules/magic-string/*',
  '^node_modules/markdown-it/*',
  '^node_modules/mocha/*',
  '^node_modules/minimatch/*',
  '^node_modules/nise/*',
  '^node_modules/npm-run-all/*',
  '^node_modules/node-sass-import-once/*',
  '^node_modules/node-sass/*',
  '^node_modules/nsp/*',
  '^node_modules/nyc/*',
  '^node_modules/phantomjs-prebuilt/*',
  '^node_modules/postcss*',
  '^node_modules/preserve/*',
  '^node_modules/prettier/*',
  '^node_modules/protobufjs/cli/*',
  '^node_modules/prop-types/*',
  '^node_modules/ramda/*',
  '^node_modules/react-dev-utils/.+',
  '^node_modules/react-docgen/*',
  '^node_modules/react-error-overlay/*',
  '^node_modules/read-pkg/*', // Used by npm-run-all
  '^node_modules/recast/*',
  '^node_modules/reduce-css-calc/*',
  '^node_modules/requizzle/*',
  '^node_modules/resolve/*',
  '^node_modules/sass-graph/*',
  '^node_modules/sass-loader/*',
  '^node_modules/scss-tokenizer/*',
  '^node_modules/send/*',
  '^node_modules/serve-index/*',
  '^node_modules/sinon/*',
  '^node_modules/snapdragon-util/*',
  '^node_modules/snapdragon/*',
  '^node_modules/sockjs-client/*',
  '^node_modules/spectron/*',
  '^node_modules/style-loader/*',
  '^node_modules/svgo/*',
  '^node_modules/terser/*',
  '^node_modules/testcheck/*',
  '^node_modules/text-encoding/*',
  '^node_modules/tiny-lr/*', // Used by grunt-contrib-watch
  '^node_modules/tinycolor2/*',
  '^node_modules/to-ast/*',
  '^node_modules/trough/*',
  '^node_modules/ts-loader/*',
  '^node_modules/ts-node/*',
  '^node_modules/tslint*',
  '^node_modules/tweetnacl/*',
  '^node_modules/typescript/*',
  '^node_modules/typed-scss-modules/*',
  '^node_modules/uglify-es/*',
  '^node_modules/uglify-js/*',
  '^node_modules/url-loader/*',
  '^node_modules/use/*',
  '^node_modules/vary/*',
  '^node_modules/vm-browserify/*',
  '^node_modules/webdriverio/*',
  '^node_modules/webpack/*',
  '^node_modules/xmlbuilder/*',
  '^node_modules/xmldom/*',
  '^node_modules/xml-parse-from-string/*',
  '^node_modules/yargs-unparser/',
  '^node_modules/yargs/*',

  // Used by Storybook
  '^node_modules/@emotion/*',
  '^node_modules/@storybook/*',
  '^node_modules/cosmiconfig/*',
  '^node_modules/create-emotion/*',
  '^node_modules/markdown-to-jsx/*',
  '^node_modules/mini-css-extract-plugin/*',
  '^node_modules/polished*',
  '^node_modules/prismjs/*',
  '^node_modules/react-draggable/.+',
  '^node_modules/refractor/*',
  '^node_modules/regexpu-core/*',
  '^node_modules/shelljs/*',
  '^node_modules/simplebar/*',
  '^node_modules/store2/*',
  '^node_modules/telejson/*',

  // Used by Styleguidist
  '^node_modules/cssnano/.+',
  '^node_modules/gzip-size/.+',
  '^node_modules/portfinder/.+',
  '^node_modules/react-group/.+',
  '^node_modules/react-styleguidist/.+',

  // Used by Webpack
  '^node_modules/css-select/.+', // Used by html-webpack-plugin
  '^node_modules/dotenv-webpack/.+',
  '^node_modules/follow-redirects/.+', // Used by webpack-dev-server
  '^node_modules/html-webpack-plugin/.+',
  '^node_modules/node-forge/.+', // Used by webpack-dev-server
  '^node_modules/renderkid/.+', // Used by html-webpack-plugin
  '^node_modules/spdy-transport/.+', // Used by webpack-dev-server
  '^node_modules/spdy/.+', // Used by webpack-dev-server
  '^node_modules/uglifyjs-webpack-plugin/.+',
  '^node_modules/v8-compile-cache/.+', // Used by webpack-cli
  '^node_modules/watchpack/.+', // Used by webpack
  '^node_modules/webpack-cli/.+',
  '^node_modules/webpack-dev-middleware/.+',
  '^node_modules/webpack-dev-server/.+',
  '^node_modules/webpack-hot-middleware/.+',
  '^node_modules/webpack-merge/.+',
  '^node_modules/webpack/.+',
];

function setupRules(allRules: Array<RuleType>) {
  forEach(allRules, (rule, index) => {
    if (!rule.name) {
      throw new Error(`Rule at index ${index} is missing a name`);
    }

    if (!rule.expression) {
      throw new Error(`Rule '${rule.name}' is missing an expression`);
    }

    rule.regex = new RegExp(rule.expression, 'g');
  });
}

setupRules(rules);

forEach(allSourceFiles, file => {
  const relativePath = relative(basePath, file).replace(/\\/g, '/');
  if (
    some(excludedFiles, excluded => {
      const regex = new RegExp(excluded);

      return regex.test(relativePath);
    })
  ) {
    return;
  }

  scannedCount += 1;

  const fileContents = readFileSync(file, ENCODING);
  const lines = fileContents.split('\n');

  forEach(rules, (rule: RuleType) => {
    const excludedModules = rule.excludedModules || [];
    if (some(excludedModules, module => relativePath.startsWith(module))) {
      return;
    }

    forEach(lines, (rawLine, lineIndex) => {
      const line = rawLine.replace(/\r/g, '');
      if (!rule.regex.test(line)) {
        return;
      }

      const path = relativePath;
      const lineNumber = lineIndex + 1;

      const exceptionKey = getExceptionKey({
        rule: rule.name,
        path: relativePath,
        lineNumber,
      });

      const exception = exceptionsLookup[exceptionKey];
      if (exception && (!exception.line || exception.line === line)) {
        // tslint:disable-next-line no-dynamic-delete
        delete exceptionsLookup[exceptionKey];

        return;
      }

      results.push({
        rule: rule.name,
        path,
        line: line.length < 300 ? line : undefined,
        lineNumber,
        reasonCategory: ALL_REASONS,
        updated: now.toJSON(),
        reasonDetail: '<optional>',
      });
    });
  });
});

const unusedExceptions = values(exceptionsLookup);

console.log(
  `${scannedCount} files scanned.`,
  `${results.length} questionable lines,`,
  `${unusedExceptions.length} unused exceptions,`,
  `${exceptions.length} total exceptions.`
);

if (results.length === 0 && unusedExceptions.length === 0) {
  process.exit();
}

console.log();
console.log('Questionable lines:');
console.log(JSON.stringify(sortExceptions(results), null, '  '));

if (unusedExceptions.length) {
  console.log();
  console.log('Unused exceptions!');
  console.log(JSON.stringify(sortExceptions(unusedExceptions), null, '  '));
}

process.exit(1);