class Analyzer::Crystal::Cli

Overview

Surfaces the command-line attack surface of Crystal programs as cli:// endpoints: stdlib OptionParser / ARGV / ENV plus the clim, admiral and commander shards. One endpoint per (sub)command, params flag/argument/env, merged by URL. Line-scan; subclasses Analyzer directly.

Included Modules

Defined in:

analyzer/analyzers/crystal/cli.cr

Constant Summary

ADM_ARG = /^\s*define_argument\s+([A-Za-z_]\w*)/
ADM_FLAG = /^\s*define_flag\s+([A-Za-z_]\w*)/
ADM_SUB = /\bregister_sub_command\s+([A-Za-z0-9_]+)/
ARGV_INDEX = /\bARGV\s*\[\s*(\d+)\s*\]/
CLIM_ARGUMENT = /^\s*argument\s+["']([A-Za-z0-9][\w-]*)/
CLIM_OPTION = /^\s*option\s+["'](-{1,2}[A-Za-z0-9][\w-]*)/
CLIM_SUB = /^\s*sub\s+["']([A-Za-z0-9][\w-]*)["']/
ENV_FETCH = /\bENV\.fetch\s*\(\s*["']([^"']+)["']/
ENV_INDEX = /\bENV\s*\[\s*["']([^"']+)["']\s*\]/
MARKERS = /\bOptionParser\.(?:parse|new)\b|\bARGV\s*\[\s*\d+\s*\]|<\s*Clim\b|<\s*Admiral::Command\b|\bCommander::Command\b|\brequire\s+"(?:clim|admiral|commander)"/
OPT_LONG = /\.on\s*\(?[^)]*?["'](-{2}[A-Za-z0-9][\w-]*)/
OPT_SHORT = /\.on\s*\(\s*["'](-[A-Za-z0-9])(?:["' =]|\))/
OPTION_PARSER = /\bOptionParser\.(?:parse|new)\b/
WEB_RE = /\brequire\s+"(?:kemal|amber|lucky|grip|marten)"|HTTP::Server\.new|\bKemal\b|Amber::Server/

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]