class Analyzer::Scala::Cli

• Analyzer::Scala::Cli
• Analyzer
• Reference
• Object

Overview

Surfaces the command-line attack surface of Scala programs as cli:// endpoints: scopt/decline (options/args/subcommands), Scallop (ScallopConf options/args/subcommands), com.twitter.app (flags), and sys.env reads. Line-scan, merged by URL.

Each library is gated on its own distinct import/marker, and only that library's regex family runs against the file. This matters because Scallop's bare opt[T]("name") call is textually identical to scopt's opt[T]("name") -- without per-library gating, scopt's extractor would also fire on Scallop code and attach subcommand-only flags to the root endpoint even though Scallop's own subcommand scoping correctly bound them to the subcommand.

Defined in:

Constant Summary

CLI_TEST_PATH_RE = Regex.union("/test/", "/it/", "spec.scala", "test.scala")

One precompiled Regex.union scan (PCRE2 JIT) replaces four separate String#includes? scans of the same buffer -- Crystal's includes? is not Boyer-Moore accelerated, so a single regex pass over lower is cheaper than four. Equivalent to the OR-of-substrings it replaces (union escapes each literal).

DEC_ARG = /\bOpts\.argument(?:\[[^\]]*\])?\s*\(\s*"<?([A-Za-z0-9][\w-]*)>?"/

DEC_CMD = /\bCommand\s*\(\s*"([^"]+)"/

DEC_FLAG = /\bOpts\.flag\s*\(\s*"([^"]+)"/

DEC_OPT = /\bOpts\.option\[[^\]]*\]\s*\(\s*"([^"]+)"/

MARKERS = /\bscopt\b|\bOParser\b|\bcom\.monovore\.decline\b|\bOpts\.(?:option|flag|argument|arguments)\b|\bmainargs\b|\borg\.rogach\.scallop\b|\bScallopConf\b|\bcom\.twitter\.app\b/

SCALLOP_ARG_INFERRED = /\bval\s+(\w+)\s*=\s*trailArg\[[^\]]*\]\s*\(\s*(?!")/

SCALLOP_ARG_NAMED = /\btrailArg\[[^\]]*\]\s*\(\s*"([^"]+)"/

SCALLOP_MARKER = /\borg\.rogach\.scallop\b|\bScallopConf\b/

SCALLOP_OPT_INFERRED = /\bval\s+(\w+)\s*=\s*opt\[[^\]]*\]\s*\(\s*(?!")/

SCALLOP_OPT_NAMED = /\bopt\[[^\]]*\]\s*\(\s*"([^"]+)"/

SCALLOP_SUBCMD = /\b(?:val\s+\w+\s*=\s*(?:new\s+)?Subcommand\s*\(\s*"([^"]+)"|object\s+\w+\s+extends\s+Subcommand\s*\(\s*"([^"]+)")/

--- Scallop (org.rogach.scallop) ----------------------------------- opt[T]/trailArg[T] take an explicit name, or (via a Scallop macro) infer it from the enclosing val when the name is omitted -- this is a real, documented Scallop feature, unlike com.twitter.app's flag.

Subcommands are declared either as val x = (new )?Subcommand("name") { ... } or the idiomatic object x extends Subcommand("name") { ... } shown in Scallop's own docs; both open their scope with a { on the same line, closed via brace-depth tracking.

SCOPT_ARG = /\barg\[[^\]]*\]\s*\(\s*"<?([A-Za-z0-9][\w-]*)>?"/

SCOPT_CMD = /\bcmd\s*\(\s*"([^"]+)"/

SCOPT_DECLINE_MARKER = /\bscopt\b|\bOParser\b|\bcom\.monovore\.decline\b|\bOpts\.(?:option|flag|argument|arguments)\b|\bmainargs\b/

SCOPT_OPT = /\bopt\[[^\]]*\]\s*\(\s*(?:'[A-Za-z0-9]'\s*,\s*)?"([^"]+)"/

--- scopt / decline -----------------------------------------------

SYS_ENV = /\bsys\.env\s*(?:\(\s*"([^"]+)"|\.get\s*\(\s*"([^"]+)")/

TWITTER_FLAG = /\bflag\[[^\]]*\]\s*\(\s*"([^"]+)"/

--- com.twitter.app -------------------------------------------------- flag[T]("name", ...) always requires an explicit name -- there is no reflection/macro-based no-arg overload the way Scallop infers names from a val, so only the explicitly-named form is extracted.

TWITTER_MARKER = /\bcom\.twitter\.app\b/

WEB_RE = /\bimport\s+(?:akka\.http|play\.api|org\.http4s|cask|com\.twitter\.finatra|com\.linecorp\.armeria|zhttp|zio\.http)\b/

Instance Method Summary

• #analyze

Instance Method Detail