cli.js

#!/usr/bin/env node

/*
  Copyright 2019-2024 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.
*/

const program = require("commander"),
  fs = require("fs"),
  path = require("path"),
  bl = require("./lib/package/bundleLinter.js"),
  rc = require("./lib/package/apigeelintrc.js"),
  pkj = require("./package.json"),
  bundleType = require("./lib/package/BundleTypes.js");

const findBundle = (p) => {
  if (p.endsWith("/")) {
    p = p.slice(0, -1);
  }
  const subdirnames = [
    bundleType.BundleType.SHAREDFLOW,
    bundleType.BundleType.APIPROXY
  ];
  if (subdirnames.find((n) => p.endsWith(n)) && fs.statSync(p).isDirectory()) {
    return p;
  }
  const subdirs = subdirnames.map((d) => path.join(p, d));

  for (let i = 0; i < subdirs.length; i++) {
    if (fs.existsSync(subdirs[i]) && fs.statSync(subdirs[i]).isDirectory()) {
      if (
        !fs.existsSync(subdirs[1 - i]) ||
        !fs.statSync(subdirs[1 - i]).isDirectory()
      ) {
        return subdirs[i];
      }
      throw new Error(
        "that path appears to contain both an apiproxy and a sharedflowbundle"
      );
    }
  }
  throw new Error(
    "that path does not appear to contain an apiproxy or sharedflowbundle"
  );
};

program
  .version(pkj.version)
  .option(
    "-s, --path <path>",
    "Path of the exploded apiproxy or sharedflowbundle directory"
  )
  .option("-f, --formatter [value]", "Specify formatters (default: json.js)")
  .option("-w, --write [value]", "file path to write results")
  .option(
    "-e, --excluded [value]",
    "The comma separated list of tests to exclude (default: none)"
  )
  // .option("-M, --mgmtserver [value]", "Apigee management server")
  // .option("-u, --user [value]", "Apigee user account")
  // .option("-p, --password [value]", "Apigee password")
  // .option("-o, --organization [value]", "Apigee organization")
  .option(
    "-x, --externalPluginsDirectory [value]",
    "Relative or full path to an external plugins directory"
  )
  .option(
    "-q, --quiet",
    "do not emit the report to stdout. (can use --write option to write to file)"
  )
  .option(
    "--list",
    "do not execute, instead list the available plugins and formatters"
  )
  .option(
    "--maxWarnings [value]",
    "Number of warnings to trigger nonzero exit code (default: -1)"
  )
  .option("--profile [value]", "Either apigee or apigeex (default: apigee)")
  .option(
    "--norc",
    "do not search for and use the .apigeelintrc file for settings"
  );

program.on("--help", function () {
  console.log("\nExample: apigeelint -f table.js -s sampleProxy/apiproxy");
  console.log("");
});

program.parse(process.argv);

if (program.list) {
  console.log("available plugins: " + bl.listRuleIds().join(", ") + "\n");
  console.log("available formatters: " + bl.listFormatters().join(", "));
  if (fs.existsSync(program.externalPluginsDirectory)) {
    console.log(
      "\n" +
        "available external plugins: " +
        bl.listExternalRuleIds(program.externalPluginsDirectory).join(", ") +
        "\n"
    );
  }
  process.exit(0);
}

if (!program.path) {
  console.log(
    "you must specify the -s option, or the long form of that: --path "
  );
  process.exit(1);
}

program.path = findBundle(program.path);

// apply RC file
if (!program.norc) {
  const rcSettings = rc.readRc([".apigeelintrc"], program.path);
  if (rcSettings) {
    Object.keys(rcSettings)
      .filter((key) => key != "path" && key != "list" && !program[key])
      .forEach((key) => (program[key] = rcSettings[key]));
  }
}

const configuration = {
  debug: true,
  source: {
    type: "filesystem",
    path: program.path,
    bundleType: program.path.includes(bundleType.BundleType.SHAREDFLOW)
      ? bundleType.BundleType.SHAREDFLOW
      : bundleType.BundleType.APIPROXY
  },
  externalPluginsDirectory: program.externalPluginsDirectory,
  excluded: {},
  maxWarnings: -1,
  profile: "apigee"
};

if (!isNaN(program.maxWarnings)) {
  configuration.maxWarnings = Number.parseInt(program.maxWarnings);
}

if (program.formatter) {
  configuration.formatter = program.formatter || "json.js";
}

if (program.quiet) {
  configuration.output = "none";
}

if (program.excluded && typeof program.excluded === "string") {
  configuration.excluded = program.excluded
    .split(",")
    .map((s) => s.trim())
    .reduce((acc, item) => ((acc[item] = true), acc), {});
}

if (program.write) {
  configuration.writePath = program.write;
}

if (program.profile) {
  configuration.profile = program.profile;
}

bl.lint(configuration);