class Detector::Javascript::Cli

Overview

Detects JavaScript/TypeScript command-line applications: programs using a CLI framework (commander, yargs, cac, meow, minimist, clipanion, oclif, sade, arg, command-line-args, getopts, citty, …), the Node util.parseArgs builtin, the Deno/Bun argv runtimes, or the canonical process.argv.slice(2) parse. Gates the JS CLI analyzer. Bare process.argv / process.env are too common to qualify.

Defined in:

detector/detectors/javascript/cli.cr

Constant Summary

ARGV_SLICE = /\bprocess\.argv\.slice\s*\(\s*2\s*\)/
BUN_ARGV = /\bBun\.argv\b/
CLI_LIB_IMPORT = /(?:require\s*\(\s*|from\s+)['"](?:commander|yargs(?:\/(?:yargs|helpers))?|cac|meow|minimist|mri|arg|clipanion|@oclif\/(?:core|command)|sade|gluegun|command-line-args|getopts|citty)['"]/
DENO_ARGS = /\bDeno\.args\b/
PARSE_ARGS = /\bparseArgs\s*\(\s*\{/
SOURCE_EXTS = [".js", ".mjs", ".cjs", ".jsx", ".ts", ".mts", ".cts", ".tsx"]

Instance Method Summary

Instance methods inherited from class Detector

applicable?(filename : String) : Bool applicable?, detect(filename : String, file_contents : String) : Bool detect, gemfile_dependency?(file_contents : String, gem_name : String) : Bool gemfile_dependency?, gemspec_dependency?(file_contents : String, gem_name : String) : Bool gemspec_dependency?, idempotent? : Bool idempotent?, logger : NoirLogger logger, name : String name, path_sensitive? : Bool path_sensitive?

Constructor methods inherited from class Detector

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

Instance Method Detail

def applicable?(filename : String) : Bool #
Description copied from class Detector

Cheap filename-only filter the detector pass uses to skip #detect on files the detector cannot possibly match. The default true preserves prior behavior (every detector runs on every file). Override with the same predicate the body of #detect starts with — e.g., filename.ends_with?(".py") for a Python framework detector — so the detector loop avoids the #detect dispatch on files outside the detector's language.

On large codebases (saleor's 4255 .py files) this lifts ~100 virtual #detect calls per file out of the hot loop because most detectors' inner first-line is exactly this kind of cheap filename check.


[View source]
def detect(filename : String, file_contents : String) : Bool #

[View source]
def set_name #

[View source]