class Analyzer::Clojure::Cli

Overview

Surfaces the command-line attack surface of Clojure programs as cli:// endpoints: clojure.tools.cli option specs, cli-matic config, babashka.cli spec/dispatch tables, environ.core env lookups, and command-line-args / (System/getenv). Line-scan, merged by URL.

Included Modules

Defined in:

analyzer/analyzers/clojure/cli.cr

Constant Summary

BB_CMDS = /:cmds\s+\[([^\]]*)\]/

Whole :cmds [...] vector (may hold several segments, e.g. ["docker" "start"]).

ENVIRON_ENV = /\(\s*env\s+:([A-Za-z][\w-]*)/
ENVIRON_REFER_ENV = /environ\.core\s*:refer\s*\[[^\]]*\benv\b/

env bound bare from environ.core: (:require [environ.core :refer [env]]). Never trust an alias (:as environ) or an unrelated local/param named env.

GET_ENV = /\(\s*System\/getenv\s+"([^"]+)"/
MARKERS = /clojure\.tools\.cli\b|\(\s*(?:[\w.-]+\/)?parse-opts\b|\bcli-matic\b|\*command-line-args\*|\bbabashka\.cli\b/

NOTE environ.core is intentionally absent here. It's a generic 12-factor config-reading library used by web apps/workers/services just as much as CLIs (same category as bare System/getenv, below) — it must never gate CLI detection on its own. It only annotates params on a cli:// endpoint some OTHER marker below already established.

MATIC_COMMAND = /:command\s+"([^"]+)"/
MATIC_OPTION = /:option\s+"([A-Za-z0-9][\w-]*)"/
NTH_ARGS = /\(\s*nth\s+(?:\*command-line-args\*|args)\s+(\d+)/
TOOLS_CLI_LONG = /"--([A-Za-z0-9][\w-]*)/
TOOLS_CLI_SPEC = /\[\s*(?:(?:"-[A-Za-z0-9]"|nil)\s+)?"--/
WEB_RE = /\b(?:compojure|ring\.adapter|reitit|io\.pedestal|httpkit|aleph)\b/

Class Method Summary

Instance Method Summary

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, tech : String tech, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]