apigeelint/lib/package/plugins/PO013-jsHint.js

Node module and tool to lint a bundle for an Apigee API Proxy or sharedflow.

/*
  Copyright © 2019-2022,2026 Google LLC

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      https://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/
/* global process */

const ruleId = require("../lintUtil.js").getRuleId(),
  path = require("path"),
  fs = require("fs"),
  minimatch = require("minimatch"),
  debug = require("debug")("apigeelint:" + ruleId);

const plugin = {
  ruleId,
  name: "jsHint",
  message: "jsHint applied to all javascript resource callouts.",
  fatal: false,
  severity: 1,
  nodeType: "Resource",
  enabled: true,
};

const jshint = require("jshint"),
  jsHintCli = require("jshint/src/cli.js");

const getMessageClass = function (s) {
  if (/E\d{3}/.test(s)) return "error";
  if (/W\d{3}/.test(s)) return "warning";
  if (/I\d{3}/.test(s)) return "info";
  return "message";
};

const cat = (file) => fs.readFileSync(file).toString("utf-8");

function findFile(name, cwd) {
  cwd = cwd || process.cwd();
  const filename = path.normalize(path.join(cwd, name));
  if (fs.existsSync(filename)) {
    return filename;
  }
  const parent = path.resolve(cwd, "../");
  if (cwd === parent) {
    return null;
  }
  return findFile(name, parent);
}

const ignoresCache = [];

function loadIgnores(cwd) {
  const file = findFile(".jshintignore", cwd) || "";

  if (!file) {
    return [];
  }
  if (ignoresCache[file]) {
    return ignoresCache[file];
  }
  const lines = (file ? cat(file) : "").split("\n");
  debug("loadIgnores(): " + lines.join(", "));

  ignoresCache[file] = lines
    .filter((line) => !!line.trim())
    .map((line) => {
      if (line[0] === "!")
        return "!" + path.resolve(path.dirname(file), line.substr(1).trim());
      return path.join(path.dirname(file), line.trim());
    });
  return ignoresCache[file];
}

const shouldIgnore = (filepath, patterns) => {
  const result = patterns.some((pattern) => {
    const resolved = path.resolve(filepath);

    return (
      filepath === pattern ||
      minimatch(resolved, pattern, { nocase: true, dot: true }) ||
      (fs.statSync(resolved).isDirectory() &&
        pattern.match(/^[^\/\\]*[\/\\]?$/) &&
        filepath.match(new RegExp("^" + pattern + ".*")))
    );
  });

  debug(`shouldIgnore(${filepath}) result:` + result);
  return result;
};

const onResource = function (resource, cb) {
  let flagged = false;
  try {
    const fname = resource.getFileName();
    debug("onResource(): " + resource.path);
    if (
      fname.endsWith(".jsc") ||
      fname.endsWith(".js") ||
      fname.endsWith(".json")
    ) {
      const ignores = loadIgnores(path.dirname(resource.path));
      if (!shouldIgnore(resource.path, ignores)) {
        let jsHintOptions = jsHintCli.getConfig(resource.path);
        delete jsHintOptions.dirname;
        if (Object.keys(jsHintOptions).length == 0) {
          // default apigeelint options
          debug("applying default options");
          jsHintOptions = { maxerr: 50 };
        }

        debug("jshint options:" + JSON.stringify(jsHintOptions));
        if (!jshint.JSHINT(resource.getContents(), jsHintOptions)) {
          jshint.JSHINT.errors.forEach(function (error) {
            if (error.code !== "W087") {
              const result = {
                plugin,
                severity: /E\d{3}/.test(error.code) ? 2 : 1,
                source: error.evidence,
                line: error.line,
                column: error.character,
                message:
                  getMessageClass(error.code) +
                  ` ${error.code}: ${error.reason}`,
              };
              resource.addMessage(result);
              flagged = true;
            }
          });
        }
      }
    }
  } catch (e) {
    debug("jshint error: " + e);
    console.error("jshint error: " + e);
  }
  if (typeof cb == "function") {
    cb(null, flagged);
  }
};

module.exports = {
  plugin,
  onResource,
};