zuke.tools.deno
@zuke/deno 1.5.0: @zuke/deno — typed DenoTasks wrappers for the deno CLI, for use in Zuke build targets.
zuke on PyPI ↗ 49 symbols
Symbols
class DenoAddSettings(DenoLockSettings) Settings for deno add.
-
packages(*specs: str) -> SelfThe packages to add, e.g.
jsr:@std/assertornpm:express(required). -
dev() -> SelfAdd as a dev dependency (
--dev). Deno only distinguishes the two in apackage.json; against adeno.jsonthe flag has nothing to record. -
jsr() -> SelfRead unprefixed package names as JSR packages (
--jsr). -
npm() -> SelfRead unprefixed package names as npm packages (
--npm), deno's default. -
save_exact() -> SelfRecord the exact version, without a caret range (
--save-exact). -
lockfile_only() -> SelfUpdate the lockfile without installing (
--lockfile-only). -
package_json() -> SelfRecord the dependency in
package.jsonrather thandeno.json(--package-json).
class DenoApproveScriptsSettings(DenoSettings) Settings for deno approve-scripts.
-
packages(*specs: str) -> SelfThe npm specifiers whose lifecycle scripts to approve (required).
-
lockfile_only() -> SelfRecord the approval in the lockfile without installing (
--lockfile-only).
class DenoBenchSettings(DenoPermissionSettings) Settings for deno bench.
-
paths(*paths: str) -> SelfRestrict the run to specific benchmark files or directories.
-
filter(pattern: str) -> SelfOnly run benchmarks whose name matches (
--filter). -
json() -> SelfReport results as JSON (
--json) rather than the table. Deno marks the flag unstable, so treat the shape as subject to change between releases. -
no_run() -> SelfCache the benchmark modules without running them (
--no-run) — a cheap way to prove the benchmarks still compile without paying to run them. -
permit_no_files() -> SelfSucceed when no benchmark files matched (
--permit-no-files) instead of failing the target. -
ignore(*patterns: str) -> SelfSkip files matching these patterns (
--ignore). -
config(path: str) -> SelfUse an explicit config file (
--config).
class DenoBumpVersionSettings(DenoSettings) Settings for deno bump-version.
The subcommand is experimental — deno itself prints a notice saying so on every run — so treat its output as subject to change between releases.
-
increment(kind: Literal['major', 'minor', 'patch', 'premajor', 'preminor', 'prepatch', 'prerelease']) -> SelfThe increment to apply. Omit it to derive the increment from the conventional commits since start.
-
dry_run() -> SelfPrint the planned changes without writing any files (
--dry-run). -
workspace() -> SelfBump every package in the workspace (
--workspace). -
no_workspace() -> SelfBump only the manifest in the current directory (
--no-workspace). -
config(path: str) -> SelfThe manifest to bump (
--config). -
import_map(path: str) -> SelfThe import map whose
jsr:constraints to rewrite (--import-map). -
base(ref: str) -> SelfGit ref to compare against in conventional-commits mode (
--base). -
start(ref: str) -> SelfGit ref to start from in conventional-commits mode (
--start). -
release_notes(path: str) -> SelfRelease notes file to prepend to in conventional-commits mode (
--release-notes).
class DenoCacheSettings(DenoSettings) Settings for deno cache.
-
reload() -> SelfReload remote modules instead of using the cache (
--reload). -
frozen() -> SelfError out if the lockfile is out of date (
--frozen). See DenoPermissionSettings.frozen for why the name mirrors the real Deno flag rather thanPnpmSettings.frozenLockfile()'s naming. -
paths(*paths: str) -> SelfThe entry points to cache (at least one is required).
class DenoCheckSettings(DenoSettings) Settings for deno check.
-
paths(*paths: str) -> SelfThe files to type-check (at least one is required).
-
all() -> SelfType-check remote modules and npm packages too (
--all), not just the local code. Slower, and the only way to catch a dependency whose published types do not actually compile. -
doc() -> SelfType-check the code blocks in JSDoc and Markdown as well (
--doc). -
doc_only() -> SelfType-check *only* the code blocks in JSDoc and Markdown (
--doc-only). -
check_js() -> SelfType-check JavaScript files too (
--check-js). -
config(path: str) -> SelfType-check against a specific configuration file (
--config) instead of the one Deno would discover by walking up from the checked files. The discovered config decides how bare specifiers resolve, so pointing at another one type-checks the same sources against a different dependency set — for example checking a workspace member against the *published* version of a sibling it declares, rather than the local member that workspace resolution would substitute. -
no_config() -> SelfDiscover no configuration file at all (
--no-config). -
no_lock() -> SelfIgnore the lockfile entirely (
--no-lock), neither reading nor writing it. Use it for a check whose resolutions are deliberately not the project's: writing them into the committed lock would corrupt it, and reading it would pin the very versions the check is trying to vary. -
frozen() -> SelfError out if the lockfile is out of date (
--frozen). See DenoPermissionSettings.frozen for why the name mirrors the real Deno flag rather thanPnpmSettings.frozenLockfile()'s naming. -
lock(path: str) -> SelfUse an explicit lockfile (
--lock) instead of the discovereddeno.lock. -
import_map(path: str) -> SelfLoad an import map from a file or URL (
--import-map). -
no_npm() -> SelfDo not resolve npm modules (
--no-npm). -
no_remote() -> SelfDo not resolve remote modules (
--no-remote). -
reload(*specifiers: str) -> SelfReload the module cache (
--reload), optionally only these specifiers. -
node_modules_dir(mode: Literal['auto', 'manual', 'none']) -> SelfSet the node-modules management mode (
--node-modules-dir). -
node_modules_linker(mode: Literal['isolated', 'hoisted']) -> SelfSet the npm linker mode (
--node-modules-linker). -
vendor(enabled: bool | None=None) -> SelfToggle the local vendor folder (
--vendor). -
watch() -> SelfRe-check when a watched file changes (
--watch). -
watch_exclude(*paths: str) -> SelfExclude paths from the watcher (
--watch-exclude). -
no_clear_screen() -> SelfKeep previous output when re-running under
--watch(--no-clear-screen).
class DenoCiSettings(DenoSettings) Settings for deno ci.
-
prod() -> SelfInstall production dependencies only, excluding dev ones (
--prod). -
skip_types() -> SelfExclude
@types/*packages (--skip-types). Deno selects them by name, so a package that ships runtime code under a@types/name is skipped too. -
env_file(path: str) -> SelfLoad environment variables from a file (
--env-file).
class DenoCleanSettings(DenoSettings) Settings for deno clean.
-
dry_run() -> SelfReport what would be removed without removing it (
--dry-run). -
except_(*paths: str) -> SelfKeep the cache entries these files need (
--except), clearing everything else. Use it to drop stale dependencies without forcing the next build to re-download the ones it still uses.
class DenoCompileSettings(DenoPermissionSettings) Settings for deno compile.
-
script(path: str) -> SelfThe entrypoint to compile (required).
-
script_args(*args: str | float) -> SelfArguments baked into the executable, passed after the entrypoint.
-
output(path: str) -> SelfOutput file (
--output); defaults to a name inferred from the entrypoint. -
target(triple: Literal['x86_64-unknown-linux-gnu', 'aarch64-unknown-linux-gnu', 'x86_64-pc-windows-msvc', 'x86_64-apple-darwin', 'aarch64-apple-darwin']) -> SelfCross-compile for another platform (
--target). -
include(*paths: str) -> SelfEmbed an extra module, file or directory (
--include, repeatable). Needed for anything the module graph cannot see statically — a dynamically imported module, a worker entrypoint, or a data file the program reads at runtime. -
exclude(*paths: str) -> SelfExclude a file or directory from what include embedded (
--exclude). -
exclude_unused_npm() -> SelfEmbed only the npm packages the module graph actually reaches (
--exclude-unused-npm), instead of the whole lockfile snapshot. Packages reached only through a dynamic import are not statically traceable, so pass those to include explicitly. -
icon(path: str) -> SelfSet the executable's Windows icon from a
.icofile (--icon). -
no_terminal() -> SelfHide the console window on Windows (
--no-terminal). -
self_extracting() -> SelfProduce a self-extracting binary (
--self-extracting) that unpacks its embedded file system to disk on first run and executes from there. -
bundle() -> SelfBundle the entrypoint before embedding it (
--bundle), rather than shipping the wholenode_modulestree. Experimental: it produces a smaller, faster-starting binary but drops dynamicrequire/importpatterns that cannot be traced statically. -
minify() -> SelfMinify the bundled output (
--minify). Requires bundle — the CLI rejects--minifyon its own, and so does this wrapper, so the mistake surfaces while the argv is being built rather than after the compile starts. -
config(path: str) -> SelfUse an explicit config file (
--config). -
no_check() -> SelfSkip type-checking before compiling (
--no-check).
class DenoCoverageSettings(DenoSettings) Settings for deno coverage.
-
dir(path: str) -> SelfThe coverage profile directory to report on.
-
lcov() -> SelfEmit lcov instead of the table report (
--lcov). -
output(path: str) -> SelfWrite the report to a file (
--output=). -
exclude(pattern: str) -> SelfExclude files matching the pattern (
--exclude=). -
include(pattern: str) -> SelfReport only on files matching the pattern (
--include=). -
ignore(*patterns: str) -> SelfSkip files matching these patterns (
--ignore=). -
html() -> SelfWrite an HTML report into the profile directory (
--html). Mutually exclusive with lcov and with any threshold: given both, deno emits the lcov and silently produces no HTML, so asking for both is refused rather than quietly honoured in half. -
detailed() -> SelfReport per-line detail alongside the summary table (
--detailed). -
lines_threshold(percent: float) -> SelfFail the gate if line coverage is below
percent.deno coveragehas no fail-under flag, so DenoTasks.coverage enforces this after parsing the lcov report (and forces--lcovso a report exists to parse). -
branches_threshold(percent: float) -> SelfFail the gate if branch coverage is below
percent(see linesThreshold). -
threshold(percent: float) -> SelfFail the gate if either line or branch coverage is below
percent. -
per_file_threshold(percent: float) -> SelfFail the gate if any single instrumented file's line coverage is below
percent— a per-file floor, so an under-tested file can't hide inside a healthy aggregate (see CoverageThresholds.perFile, which notes thedeno coveragelimit for files no test loads).
class DenoDeployAppSettings(DenoDeployOrgSettings) Base for the deno deploy commands scoped to an application.
-
app(name: str) -> SelfThe application (
--app).
class DenoDeployAppsGetSettings(DenoDeployAppSettings) Settings for deno deploy apps get: an application, with its URLs.
class DenoDeployAppsListSettings(DenoDeployOrgSettings) Settings for deno deploy apps list.
-
limit(count: float) -> SelfAt most this many applications (
--limit).
class DenoDeployCommandSettings(DenoSettings) Base for all deno deploy settings. Each subcommand names its command path and its own arguments; the shared flags go between them.
-
token(value: str) -> SelfThe Deno Deploy access token. It is passed in the
DENO_DEPLOY_TOKENenvironment variable rather than on the command line, so it never shows in a process listing or an error's command line, and it is registered with the run's redactor. Without it, the CLI readsDENO_DEPLOY_TOKENfrom the build's own environment. -
config(path: str) -> SelfThe config file to read and write the org and app from (
--config). -
json() -> SelfPrint one JSON object on stdout instead of human-readable output (
--json). -
non_interactive() -> SelfFail instead of prompting, taking every value from flags or the environment (
--non-interactive). Use it in CI, where nothing can answer a prompt. -
quiet_output() -> SelfSuppress non-essential output (
--quiet).
class DenoDeployCreateSettings(DenoDeployUploadSettings) Settings for deno deploy create: create an application.
-
dry_run() -> SelfValidate the flags without creating the application (
--dry-run). -
source(source: Literal['local', 'github']) -> SelfWhere the source comes from (
--source). -
repository(owner: str, repo: str) -> SelfA GitHub source repository:
--ownerand--repo. -
app_directory(path: str) -> SelfThe application's directory inside the source (
--app-directory). -
do_not_use_detected_build_config() -> SelfIgnore the detected build configuration (
--do-not-use-detected-build-config). -
framework_preset(preset: str) -> SelfThe framework preset, e.g.
freshorastro(--framework-preset). -
install_command(command: str) -> SelfThe install command (
--install-command). -
build_command(command: str) -> SelfThe build command (
--build-command). -
pre_deploy_command(command: str) -> SelfThe command run before each deployment (
--pre-deploy-command). -
runtime_mode(mode: Literal['dynamic', 'static']) -> SelfWhether the application is a server or static files (
--runtime-mode). -
entrypoint(path: str) -> SelfA dynamic application's entrypoint (
--entrypoint). -
argument(value: str) -> SelfAn argument for a dynamic application's entrypoint (
--arguments); repeatable. -
working_directory(path: str) -> SelfA dynamic application's working directory (
--working-directory). -
static_dir(path: str) -> SelfThe directory a static application is served from (
--static-dir). -
single_page_app() -> SelfServe
index.htmlfor every path without a file (--single-page-app). -
build_timeout(duration: str | float) -> SelfThe build timeout, e.g.
10mor600s(--build-timeout). -
build_memory_limit(megabytes: float) -> SelfThe build memory limit in megabytes (
--build-memory-limit). -
region(region: Literal['us', 'eu', 'global']) -> SelfThe region to deploy to (
--region).
class DenoDeployDeploymentsListSettings(DenoDeployAppSettings) Settings for deno deploy deployments list.
-
limit(count: float) -> SelfAt most this many deployments (
--limit). -
cursor(cursor: str) -> SelfContinue from a previous
--jsonpage's cursor (--cursor). -
status(status: Literal['skipped', 'queued', 'building', 'succeeded', 'failed']) -> SelfOnly deployments with this status (
--status).
class DenoDeployEnvDeleteSettings(DenoDeployAppSettings) Settings for deno deploy env delete.
-
variable(name: str) -> SelfThe variable to delete; required.
class DenoDeployEnvListSettings(DenoDeployAppSettings) Settings for deno deploy env list.
class DenoDeployEnvLoadSettings(DenoDeployAppSettings) Settings for deno deploy env load: load variables from a .env file.
-
file(path: str) -> SelfThe
.envfile to load; required. -
non_secret(key: str) -> SelfA key in the file to store as a plain value, not a secret (
--non-secrets); repeatable. -
replace() -> SelfReplace variables that already exist (
--replace). -
skip_existing() -> SelfKeep variables that already exist (
--skip-existing).
class DenoDeployEnvUpdateContextsSettings(DenoDeployAppSettings) Settings for deno deploy env update-contexts.
-
variable(name: str) -> SelfThe variable to update; required.
-
context(name: str) -> SelfA context the variable applies in, e.g.
production; repeatable.
class DenoDeployEnvValueSettings(DenoDeployAppSettings) Settings for deno deploy env add and deno deploy env update-value.
The value is a positional argument, so one that starts with - would be read as a flag and is refused; load such a value from a file with DenoDeployTasks.envLoad instead.
-
variable(name: str) -> SelfThe variable to set; required.
-
value(value: str) -> SelfThe variable's value; required, unless set by secretValue.
-
secret_value(value: str) -> SelfA secret value: masked in the build's logs and errors, and for
addstored as a secret (--secret).
class DenoDeployLogsSettings(DenoDeployAppSettings) Settings for deno deploy logs.
-
start(timestamp: str) -> SelfLogs from this timestamp on, e.g.
2026-01-01T00:00:00Z(--start). -
end(timestamp: str) -> SelfLogs up to this timestamp; needs start (
--end). -
once() -> SelfPrint the logs available now and exit, instead of following them (
--once). Without it the command streams until stopped, so a build almost always wants this.
class DenoDeployOrgSettings(DenoDeployCommandSettings) Base for the deno deploy commands scoped to an organization.
-
org(name: str) -> SelfThe organization (
--org).
class DenoDeployQuerySettings(DenoDeployCommandSettings) Settings for deno deploy orgs list and deno deploy whoami, which take neither an organization nor an application.
class DenoDeploySettings(DenoDeployUploadSettings) Settings for deno deploy: upload a directory to an application.
-
prod() -> SelfDeploy straight to production rather than as a preview (
--prod).
class DenoDeployTasks Typed task functions for deno deploy.
-
static async deploy(ctx: ServiceContext, configure: Callable[[DenoDeploySettings], DenoDeploySettings] | None=None) -> ExecResultDeploy a directory to an application:
deno deploy. -
static async create(ctx: ServiceContext, configure: Callable[[DenoDeployCreateSettings], DenoDeployCreateSettings] | None=None) -> ExecResultCreate an application:
deno deploy create. -
static async env_list(ctx: ServiceContext, configure: Callable[[DenoDeployEnvListSettings], DenoDeployEnvListSettings] | None=None) -> ExecResultList an application's variables:
deno deploy env list. -
static async env_add(ctx: ServiceContext, configure: Callable[[DenoDeployEnvValueSettings], DenoDeployEnvValueSettings]) -> ExecResultAdd a variable:
deno deploy env add. -
static async env_update_value(ctx: ServiceContext, configure: Callable[[DenoDeployEnvValueSettings], DenoDeployEnvValueSettings]) -> ExecResultChange a variable's value:
deno deploy env update-value. -
static async env_update_contexts(ctx: ServiceContext, configure: Callable[[DenoDeployEnvUpdateContextsSettings], DenoDeployEnvUpdateContextsSettings]) -> ExecResultChange the contexts a variable applies in:
deno deploy env update-contexts. -
static async env_delete(ctx: ServiceContext, configure: Callable[[DenoDeployEnvDeleteSettings], DenoDeployEnvDeleteSettings]) -> ExecResultDelete a variable:
deno deploy env delete. -
static async env_load(ctx: ServiceContext, configure: Callable[[DenoDeployEnvLoadSettings], DenoDeployEnvLoadSettings]) -> ExecResultLoad variables from a
.envfile:deno deploy env load. -
static async logs(ctx: ServiceContext, configure: Callable[[DenoDeployLogsSettings], DenoDeployLogsSettings] | None=None) -> ExecResultPrint an application's logs:
deno deploy logs. -
static async deployments_list(ctx: ServiceContext, configure: Callable[[DenoDeployDeploymentsListSettings], DenoDeployDeploymentsListSettings] | None=None) -> ExecResultList an application's deployments:
deno deploy deployments list. -
static async apps_list(ctx: ServiceContext, configure: Callable[[DenoDeployAppsListSettings], DenoDeployAppsListSettings] | None=None) -> ExecResultList an organization's applications:
deno deploy apps list. -
static async apps_get(ctx: ServiceContext, configure: Callable[[DenoDeployAppsGetSettings], DenoDeployAppsGetSettings] | None=None) -> ExecResultShow an application, with its production URL:
deno deploy apps get. -
static async orgs_list(ctx: ServiceContext, configure: Callable[[DenoDeployQuerySettings], DenoDeployQuerySettings] | None=None) -> ExecResultList the organizations the token reaches:
deno deploy orgs list. -
static async whoami(ctx: ServiceContext, configure: Callable[[DenoDeployQuerySettings], DenoDeployQuerySettings] | None=None) -> ExecResultCheck the token:
deno deploy whoami.
class DenoDeployUploadSettings(DenoDeployAppSettings) The flags shared by the commands that upload source from a local directory: deno deploy and deno deploy create.
-
root(path: str) -> SelfThe directory to upload (defaults to the working directory).
-
ignore(path: str) -> SelfLeave a path out of the upload (
--ignore); repeatable. -
allow_node_modules() -> SelfInclude the
node_modulesdirectory in the upload (--allow-node-modules). -
no_wait() -> SelfReturn once uploaded, without waiting for the build (
--no-wait).
class DenoDocSettings(DenoSettings) Settings for deno doc.
-
paths(*paths: str) -> SelfThe source files (entry points) to document.
-
json() -> SelfOutput the documentation as JSON (
--json). -
html() -> SelfGenerate static HTML documentation (
--html). -
lint() -> SelfReport documentation diagnostics rather than rendering docs (
--lint). -
private() -> SelfInclude private and internal symbols (
--private). -
strip_trailing_html() -> SelfDrop the trailing
.htmlfrom generated links (--strip-trailing-html). -
name(title: str) -> SelfTitle for the generated HTML documentation (
--name). -
output(dir: str) -> SelfOutput directory for HTML documentation (
--output). -
filter(symbol: str) -> SelfDocument only the symbol at this dot-separated path (
--filter). -
category_docs(path: str) -> SelfJSON file of per-category Markdown docs (
--category-docs). -
symbol_redirect_map(path: str) -> SelfJSON file redirecting symbols to external links (
--symbol-redirect-map). -
default_symbol_map(path: str) -> SelfMapping of default export names to the names usage blocks show (
--default-symbol-map). -
frozen() -> SelfError out if the lockfile is out of date (
--frozen). See DenoPermissionSettings.frozen for why the name mirrors the real Deno flag rather thanPnpmSettings.frozenLockfile()'s naming. -
no_lock() -> SelfIgnore the lockfile entirely (
--no-lock). -
lock(path: str) -> SelfUse an explicit lockfile (
--lock). -
import_map(path: str) -> SelfLoad an import map from a file or URL (
--import-map). -
no_npm() -> SelfDo not resolve npm modules (
--no-npm). -
no_remote() -> SelfDo not resolve remote modules (
--no-remote). -
reload(*specifiers: str) -> SelfReload the module cache (
--reload), optionally only these specifiers.
class DenoEvalSettings(DenoPermissionSettings) Settings for deno eval.
The code is passed as a single argv entry by the shell layer, never interpolated into a command string, so a value built from build parameters cannot break out of it.
-
code(source: str) -> SelfThe source to evaluate (required).
-
print() -> SelfPrint the expression's result to stdout (
--print). -
ext(value: Literal['ts', 'tsx', 'js', 'jsx', 'mts', 'mjs', 'cts', 'cjs']) -> SelfTreat the source as this content type (
--ext), rather than TypeScript. -
config(path: str) -> SelfUse an explicit config file (
--config).
class DenoFmtSettings(DenoSettings) Settings for deno fmt.
-
check() -> SelfVerify formatting without writing changes (
--check). -
fail_fast() -> SelfStop at the first badly formatted file (
--fail-fast). -
line_width(columns: float) -> SelfMaximum line width (
--line-width), 80 by default. -
indent_width(columns: float) -> SelfIndentation width (
--indent-width), 2 by default. -
use_tabs(enabled: bool | None=None) -> SelfIndent with tabs rather than spaces (
--use-tabs). -
single_quote(enabled: bool | None=None) -> SelfQuote strings with single quotes (
--single-quote). -
no_semicolons(enabled: bool | None=None) -> SelfOmit semicolons except where they are required (
--no-semicolons). -
prose_wrap(mode: Literal['always', 'never', 'preserve']) -> SelfHow to wrap prose in Markdown (
--prose-wrap). -
unstable_component() -> SelfFormat Svelte, Vue, Astro and Angular files (
--unstable-component). -
unstable_sql() -> SelfFormat SQL files (
--unstable-sql). -
ext(value: str) -> SelfTreat the inputs as this content type (
--ext).deno fmtaccepts far more than the script extensions — Markdown, JSON, CSS, HTML, YAML and the component formats among them — so this takes a string rather than the narrower script-only union the runtime subcommands use. -
ignore(*patterns: str) -> SelfSkip files matching these patterns (
--ignore). -
permit_no_files() -> SelfSucceed when no files matched (
--permit-no-files). -
config(path: str) -> SelfUse an explicit config file (
--config). -
no_config() -> SelfDiscover no configuration file at all (
--no-config). -
watch() -> SelfRe-format when a watched file changes (
--watch). -
watch_exclude(*paths: str) -> SelfExclude paths from the watcher (
--watch-exclude). -
no_clear_screen() -> SelfKeep previous output when re-running under
--watch(--no-clear-screen). -
paths(*paths: str) -> SelfRestrict formatting to specific files or directories.
class DenoInfoSettings(DenoSettings) Settings for deno info.
-
path(file: str) -> SelfThe module to report on — a path, or any specifier
deno infoaccepts, including afile://URL. Prefer the URL form when the specifier is built rather than typed: it is the same string on every OS, where a constructed path is not. Omit it to report on the caches themselves —deno infowith no module prints the cache directories rather than a module graph, which is why DenoTasks.cacheInfo and DenoTasks.moduleGraph are separate readers. -
json() -> SelfEmit the report as JSON (
--json). -
config(path: str) -> SelfUse an explicit config file (
--config). -
import_map(path: str) -> SelfLoad an import map from a file or URL (
--import-map). -
reload() -> SelfReload the module cache before reporting (
--reload). -
frozen() -> SelfError out if the lockfile is out of date (
--frozen). See DenoPermissionSettings.frozen for why the name mirrors the real Deno flag. -
no_lock() -> SelfIgnore the lockfile entirely (
--no-lock). -
no_npm() -> SelfDo not resolve npm modules (
--no-npm). -
no_remote() -> SelfDo not resolve remote modules (
--no-remote).
class DenoInitSettings(DenoSettings) Settings for deno init.
-
directory(name: str) -> SelfThe directory to create, or the package to scaffold from.
-
lib() -> SelfScaffold an example library project (
--lib). -
serve() -> SelfScaffold an example
deno serveproject (--serve). -
empty() -> SelfScaffold a minimal project — just
main.tsanddeno.json(--empty). -
jsr() -> SelfScaffold from a JSR package (
--jsr). -
npm() -> SelfScaffold from an npm
create-*package (--npm). -
yes() -> SelfAnswer the scaffolding prompts affirmatively and grant full permissions (
--yes). Required for an unattended run: without itdeno initcan stop on a prompt no build target is there to answer.
class DenoInstallSettings(DenoPermissionSettings) Settings for deno install.
-
global_() -> SelfInstall a global executable (
--global/-g) instead of project deps. -
force() -> SelfOverwrite an existing installation (
--force/-f). -
root(path: str) -> SelfInstall root; the binary lands in
<root>/bin(--root). -
name(value: str) -> SelfName the installed executable (
--name/-n). -
module(spec: str) -> SelfThe module to install, e.g.
npm:cspell@9(required for a global install). -
module_args(*args: str | float) -> SelfArguments baked into the generated launcher, emitted after the
--separator deno requires for them. -
dev() -> SelfInstall dev dependencies only alongside the rest (
--dev). -
prod() -> SelfInstall production dependencies only (
--prod). -
save_exact() -> SelfRecord exact versions, without a caret range (
--save-exact). -
lockfile_only() -> SelfUpdate the lockfile without installing (
--lockfile-only). -
skip_types() -> SelfExclude
@types/*packages (--skip-types). -
jsr() -> SelfRead unprefixed package names as JSR packages (
--jsr). -
npm() -> SelfRead unprefixed package names as npm packages (
--npm). -
package_json() -> SelfInstall into
package.jsonrather thandeno.json(--package-json). -
entrypoint(path: str) -> SelfName the entrypoint the launcher runs (
--entrypoint). -
compile() -> SelfBuild a compiled launcher (
--compile) rather than a script shim, and cross-compile it with os and arch. -
os(value: str) -> SelfTarget operating system for a compiled launcher (
--os). -
arch(value: str) -> SelfTarget architecture for a compiled launcher (
--arch). -
config(path: str) -> SelfUse an explicit config file (
--config). -
no_config() -> SelfDiscover no configuration file at all (
--no-config). -
lock(path: str) -> SelfUse an explicit lockfile (
--lock). -
no_lock() -> SelfIgnore the lockfile entirely (
--no-lock). -
import_map(path: str) -> SelfLoad an import map from a file or URL (
--import-map). -
cached_only() -> SelfResolve only from the cache (
--cached-only). -
no_npm() -> SelfDo not resolve npm modules (
--no-npm). -
no_remote() -> SelfDo not resolve remote modules (
--no-remote). -
reload(*specifiers: str) -> SelfReload the module cache (
--reload), optionally only these specifiers. -
node_modules_dir(mode: Literal['auto', 'manual', 'none']) -> SelfSet the node-modules management mode (
--node-modules-dir). -
node_modules_linker(mode: Literal['isolated', 'hoisted']) -> SelfSet the npm linker mode (
--node-modules-linker). -
vendor(enabled: bool | None=None) -> SelfToggle the local vendor folder (
--vendor). -
env_file(path: str) -> SelfLoad environment variables from a file (
--env-file). -
allow_scripts(*packages: str) -> SelfPermit npm lifecycle scripts, optionally only for these packages (
--allow-scripts). -
conditions(*values: str) -> SelfResolve npm package exports with these conditions (
--conditions). -
preload(*paths: str) -> SelfExecute these modules before the main one (
--preload). -
require(*paths: str) -> SelfExecute these CommonJS modules before the main one (
--require). -
type_check(scope: Literal['all', 'remote'] | None=None) -> SelfType-check before installing (
--check). -
no_check(scope: Literal['all', 'remote'] | None=None) -> SelfSkip type-checking (
--no-check). -
inspect(host_port: str | None=None) -> SelfActivate the inspector (
--inspect). -
inspect_brk(host_port: str | None=None) -> SelfActivate the inspector and break at the start (
--inspect-brk). -
inspect_wait(host_port: str | None=None) -> SelfActivate the inspector and wait for a debugger (
--inspect-wait).
class DenoLintSettings(DenoSettings) Settings for deno lint.
-
fix() -> SelfApply automatic fixes (
--fix). -
list_rules() -> SelfList the available rules and exit (
--rules) rather than linting. Pair it with json to get the catalogue in machine-readable form. -
json() -> SelfReport diagnostics as JSON (
--json). -
compact() -> SelfReport diagnostics one per line (
--compact). -
rules_tags(*tags: str) -> SelfEnable the rule sets carrying these tags (
--rules-tags). -
rules_include(*rules: str) -> SelfEnable these rules on top of the configured set (
--rules-include). -
rules_exclude(*rules: str) -> SelfDisable these rules (
--rules-exclude). -
ext(value: str) -> SelfTreat the inputs as this content type (
--ext). -
ignore(*patterns: str) -> SelfSkip files matching these patterns (
--ignore). -
permit_no_files() -> SelfSucceed when no files matched (
--permit-no-files). -
config(path: str) -> SelfUse an explicit config file (
--config). -
no_config() -> SelfDiscover no configuration file at all (
--no-config). -
watch() -> SelfRe-lint when a watched file changes (
--watch). -
watch_exclude(*paths: str) -> SelfExclude paths from the watcher (
--watch-exclude). -
no_clear_screen() -> SelfKeep previous output when re-running under
--watch(--no-clear-screen). -
paths(*paths: str) -> SelfRestrict linting to specific files or directories.
class DenoLockSettings(DenoSettings) Base for the deno subcommands that read and write the lockfile.
The lockfile flags are a section the CLI repeats across every one of them, so they live here once rather than being restated per subcommand.
-
frozen() -> SelfError out if the lockfile is out of date (
--frozen). See DenoPermissionSettings.frozen for why the name mirrors the real Deno flag. -
no_lock() -> SelfIgnore the lockfile entirely (
--no-lock), neither reading nor writing it. -
lock(path: str) -> SelfUse an explicit lockfile (
--lock) instead of the discovereddeno.lock.
class DenoOutdatedSettings(DenoLockSettings) Settings for deno outdated.
-
filters(*patterns: str) -> SelfRestrict the report to dependencies matching these filters, which may include
*wildcards. Filters match the alias a dependency is declared under, not the package it resolves to. -
compatible() -> SelfOnly consider versions satisfying the declared semver range (
--compatible). -
latest() -> SelfConsider the latest version regardless of the declared range (
--latest). -
recursive() -> SelfInclude every workspace member (
--recursive). -
update() -> SelfWrite the newer versions back into the manifest (
--update) instead of only reporting them. Without itdeno outdatedreports and changes nothing, which is what a freshness gate wants. -
lockfile_only() -> SelfUpdate the lockfile without installing (
--lockfile-only).
class DenoPackSettings(DenoSettings) Settings for deno pack.
-
files(*patterns: str) -> SelfFile patterns to include in the tarball; defaults to the package's own.
-
allow_dirty() -> SelfPack even with an uncommitted working tree (
--allow-dirty). -
allow_slow_types() -> SelfSkip fast-check type extraction (
--allow-slow-types). The tarball then ships without.d.tsfiles, so consumers get no types from it. -
dry_run() -> SelfReport what would be packed without writing the tarball (
--dry-run). -
no_source_maps() -> SelfOmit source maps from the tarball (
--no-source-maps). -
ignore(*patterns: str) -> SelfExclude files matching these patterns (
--ignore). -
output(path: str) -> SelfWrite the tarball here (
--output) instead of<name>-<version>.tgz. -
set_version(version: str) -> SelfOverride the version recorded in the tarball (
--set-version). -
config(path: str) -> SelfUse an explicit config file (
--config).
class DenoPermissionSettings(DenoSettings) Base for subcommands that accept --allow-* permission flags.
-
allow_all() -> SelfGrant all permissions (
--allow-all). -
allow(permission: Literal['read', 'write', 'net', 'env', 'run', 'sys', 'ffi', 'import'], *values: str) -> SelfGrant one permission, optionally scoped to values (
--allow-read=a,b). -
frozen() -> SelfError out if the lockfile is out of date instead of silently updating it (
--frozen). Use it whenever the module graph must match the committeddeno.lockexactly — running annpm:tool in CI, say, so its transitive tree stays pinned to the audited integrity hashes rather than being resolved afresh. Namedfrozen— notfrozenLockfile— to mirror the real Deno CLI flag exactly. This is a deliberate divergence fromPnpmSettings.frozenLockfile()in@zuke/pnpm, which follows pnpm's own flag name instead: guideline 7 (mirror the real CLI) takes priority over cross-package naming symmetry.
class DenoPublishSettings(DenoSettings) Settings for deno publish.
-
allow_dirty() -> SelfPublish even with an uncommitted working tree (
--allow-dirty). -
allow_slow_types() -> SelfPermit slow types in the published package (
--allow-slow-types). -
no_check() -> SelfSkip type-checking before publishing (
--no-check). -
dry_run() -> SelfValidate without publishing (
--dry-run). -
config(path: str) -> SelfUse an explicit config file (
--config). -
token(value: str) -> SelfAuthenticate with a token instead of interactive/OIDC auth (
--token). Registered with the run's redactor, so every *rendering* of the command masks it — a dry-run echo, a failure message. That is as far as it goes:deno publishaccepts the token only as a flag, so the value still reaches the child's argv, wherepsand/proc/<pid>/cmdlineexpose it to every other user on the host and to every process the build starts. There is no environment variable to move it to.DENO_AUTH_TOKENSis not one — it authenticates *module fetches*, not publishing. Prefer passing no token at all. On GitHub Actionsdeno publishuses OIDC, so the publish is authenticated by the workflow's identity and there is no credential to expose; this repository's own publish does exactly that. -
set_version(version: str) -> SelfPublish under an overridden version (
--set-version) instead of the one in the manifest — how a release job publishes a version it computed without first committing it. deno accepts it only when publishing a single package: it is rejected in a workspace, where the versions have to come from each member's own manifest. Whether the working directory is a workspace is not visible while the argv is being built, so this is a note rather than a refusal. -
no_provenance() -> SelfDisable provenance attestation (
--no-provenance). Provenance is what lets a consumer verify the published artifact came from this repository's CI, so turning it off is a deliberate weakening rather than a default worth reaching for. It stays on unless this is called. deno produces it by default only on GitHub Actions, so elsewhere there is nothing to disable. The case it exists for is the trade it makes: the attestation publicly links the package to the repository, workflow and commit it was built from, which a package published from a private repository may not want disclosed. Weigh that against consumers losing the ability to verify the artifact's origin, and prefer keeping it. -
type_check(scope: Literal['all', 'remote'] | None=None) -> SelfType-check before publishing (
--check), optionally including remote code. -
no_config() -> SelfDiscover no configuration file at all (
--no-config). -
env_file(path: str) -> SelfLoad environment variables from a file (
--env-file).
class DenoRemoveSettings(DenoLockSettings) Settings for deno remove.
-
packages(*names: str) -> SelfThe packages to remove, by the name they are recorded under (required).
-
lockfile_only() -> SelfUpdate the lockfile without touching
node_modules(--lockfile-only). -
package_json() -> SelfRemove from
package.jsonrather thandeno.json(--package-json).
class DenoRunSettings(DenoPermissionSettings) Settings for deno run.
-
script(path: str) -> SelfThe script to run (required).
-
script_args(*args: str | float) -> SelfArguments passed to the script (after the script path).
-
config(path: str) -> SelfUse an explicit config file (
--config). -
no_config() -> SelfDiscover no configuration file at all (
--no-config). -
reload(*specifiers: str) -> SelfReload the module cache (
--reload), optionally only these specifiers. -
lock(path: str) -> SelfUse an explicit lockfile (
--lock). -
no_lock() -> SelfIgnore the lockfile entirely (
--no-lock). -
import_map(path: str) -> SelfLoad an import map from a file or URL (
--import-map). -
cached_only() -> SelfResolve only from the cache (
--cached-only), fetching nothing. -
no_npm() -> SelfDo not resolve npm modules (
--no-npm). -
no_remote() -> SelfDo not resolve remote modules (
--no-remote). -
node_modules_dir(mode: Literal['auto', 'manual', 'none']) -> SelfSet the node-modules management mode (
--node-modules-dir). -
node_modules_linker(mode: Literal['isolated', 'hoisted']) -> SelfSet the npm linker mode (
--node-modules-linker). -
vendor(enabled: bool | None=None) -> SelfToggle the local vendor folder (
--vendor). -
env_file(path: str) -> SelfLoad environment variables from a file (
--env-file). -
cert(path: str) -> SelfLoad a certificate authority from a PEM file (
--cert). -
location(href: str) -> SelfSet
globalThis.location(--location). -
seed(value: float) -> SelfSeed the random number generator (
--seed). -
v8_flags(*flags: str) -> SelfPass flags through to V8 (
--v8-flags). -
conditions(*values: str) -> SelfResolve npm package exports with these conditions (
--conditions). -
preload(*paths: str) -> SelfExecute these modules before the main one (
--preload). -
require(*paths: str) -> SelfExecute these CommonJS modules before the main one (
--require). -
no_code_cache() -> SelfDisable the V8 code cache (
--no-code-cache). -
allow_scripts(*packages: str) -> SelfPermit npm lifecycle scripts, optionally only for these packages (
--allow-scripts). -
type_check(scope: Literal['all', 'remote'] | None=None) -> SelfType-check before running (
--check), optionally including remote code. -
no_check(scope: Literal['all', 'remote'] | None=None) -> SelfSkip type-checking (
--no-check), optionally only for remote code. -
inspect(host_port: str | None=None) -> SelfActivate the inspector (
--inspect). -
inspect_brk(host_port: str | None=None) -> SelfActivate the inspector and break at the start (
--inspect-brk). -
inspect_wait(host_port: str | None=None) -> SelfActivate the inspector and wait for a debugger (
--inspect-wait). -
watch() -> SelfRestart when a watched file changes (
--watch). -
watch_hmr() -> SelfWatch with hot-module replacement (
--watch-hmr), which onlydeno runoffers. It implies watching, so it replaces--watchrather than joining it. -
watch_exclude(*paths: str) -> SelfExclude paths from the watcher (
--watch-exclude). -
no_clear_screen() -> SelfKeep previous output when re-running under
--watch(--no-clear-screen).
class DenoServeSettings(DenoPermissionSettings) Settings for deno serve.
A server runs until it is stopped, so a build target that awaits this task blocks forever. Give it a bound with .killAfter(ms) — for a smoke test that the server starts — or run it from a target the build is not waiting on.
-
script(path: str) -> SelfThe module exporting the server's default handler (required).
-
script_args(*args: str | float) -> SelfArguments passed to the server module (after the module path).
-
port(value: float) -> SelfThe TCP port to serve on (
--port);0picks a free one. -
host(value: str) -> SelfThe TCP address to serve on (
--host), defaulting to all interfaces. -
parallel() -> SelfRun one server worker per available CPU (
--parallel), or as many asDENO_JOBSallows. -
open() -> SelfOpen a browser on the served address (
--open). -
watch() -> SelfRestart the server when a watched file changes (
--watch). -
config(path: str) -> SelfUse an explicit config file (
--config).
class DenoSettings(ToolSettings) Base for all deno subcommand settings: binary is the deno running here.
class DenoTasks Typed task functions for the deno CLI.
-
static async run(ctx: ServiceContext, configure: Callable[[DenoRunSettings], DenoRunSettings] | None=None) -> ExecResultRun a script:
deno run. -
static async test(ctx: ServiceContext, configure: Callable[[DenoTestSettings], DenoTestSettings] | None=None) -> ExecResultRun tests:
deno test. Reports the run's counts into the running target's row of the build summary (// Tests: 837 · Passed: 837 · Failed: 0), read from deno's own result line — see DenoTestSettings. -
static async check(ctx: ServiceContext, configure: Callable[[DenoCheckSettings], DenoCheckSettings] | None=None) -> ExecResultType-check files:
deno check. -
static async fmt(ctx: ServiceContext, configure: Callable[[DenoFmtSettings], DenoFmtSettings] | None=None) -> ExecResultFormat files:
deno fmt. -
static async lint(ctx: ServiceContext, configure: Callable[[DenoLintSettings], DenoLintSettings] | None=None) -> ExecResultLint files:
deno lint. -
static async doc(ctx: ServiceContext, configure: Callable[[DenoDocSettings], DenoDocSettings] | None=None) -> ExecResultGenerate documentation:
deno doc. -
static async cache(ctx: ServiceContext, configure: Callable[[DenoCacheSettings], DenoCacheSettings] | None=None) -> ExecResultWarm the module cache:
deno cache. -
static async coverage(ctx: ServiceContext, configure: Callable[[DenoCoverageSettings], DenoCoverageSettings] | None=None) -> ExecResultReport coverage:
deno coverage. -
static async install(ctx: ServiceContext, configure: Callable[[DenoInstallSettings], DenoInstallSettings] | None=None) -> ExecResultInstall a script or executable:
deno install. -
static async publish(ctx: ServiceContext, configure: Callable[[DenoPublishSettings], DenoPublishSettings] | None=None) -> ExecResultPublish a package to JSR:
deno publish. -
static async task(ctx: ServiceContext, configure: Callable[[DenoTaskSettings], DenoTaskSettings] | None=None) -> ExecResultRun a deno.json task:
deno task. -
static async serve(ctx: ServiceContext, configure: Callable[[DenoServeSettings], DenoServeSettings] | None=None) -> ExecResultRun a server:
deno serve. -
static async eval(ctx: ServiceContext, configure: Callable[[DenoEvalSettings], DenoEvalSettings] | None=None) -> ExecResultEvaluate a snippet:
deno eval. -
static async bench(ctx: ServiceContext, configure: Callable[[DenoBenchSettings], DenoBenchSettings] | None=None) -> ExecResultRun benchmarks:
deno bench. -
static async compile(ctx: ServiceContext, configure: Callable[[DenoCompileSettings], DenoCompileSettings] | None=None) -> ExecResultBuild a self-contained executable:
deno compile. -
static async clean(ctx: ServiceContext, configure: Callable[[DenoCleanSettings], DenoCleanSettings] | None=None) -> ExecResultRemove the cache directory:
deno clean. -
static async info(ctx: ServiceContext, configure: Callable[[DenoInfoSettings], DenoInfoSettings] | None=None) -> ExecResultReport on a module or the caches:
deno info. -
static async init(ctx: ServiceContext, configure: Callable[[DenoInitSettings], DenoInitSettings] | None=None) -> ExecResultScaffold a new project:
deno init. -
static async upgrade(ctx: ServiceContext, configure: Callable[[DenoUpgradeSettings], DenoUpgradeSettings] | None=None) -> ExecResultUpgrade the deno executable:
deno upgrade. -
static async add(ctx: ServiceContext, configure: Callable[[DenoAddSettings], DenoAddSettings] | None=None) -> ExecResultAdd dependencies:
deno add. -
static async remove(ctx: ServiceContext, configure: Callable[[DenoRemoveSettings], DenoRemoveSettings] | None=None) -> ExecResultRemove dependencies:
deno remove. -
static async uninstall(ctx: ServiceContext, configure: Callable[[DenoUninstallSettings], DenoUninstallSettings] | None=None) -> ExecResultUninstall a dependency or global executable:
deno uninstall. -
static async outdated(ctx: ServiceContext, configure: Callable[[DenoOutdatedSettings], DenoOutdatedSettings] | None=None) -> ExecResultReport outdated dependencies:
deno outdated. -
static async why(ctx: ServiceContext, configure: Callable[[DenoWhySettings], DenoWhySettings] | None=None) -> ExecResultExplain why a package is installed:
deno why. -
static async ci(ctx: ServiceContext, configure: Callable[[DenoCiSettings], DenoCiSettings] | None=None) -> ExecResultInstall strictly from the lockfile:
deno ci. -
static async approve_scripts(ctx: ServiceContext, configure: Callable[[DenoApproveScriptsSettings], DenoApproveScriptsSettings] | None=None) -> ExecResultApprove npm lifecycle scripts:
deno approve-scripts. -
static async bump_version(ctx: ServiceContext, configure: Callable[[DenoBumpVersionSettings], DenoBumpVersionSettings] | None=None) -> ExecResultBump the version in the manifest:
deno bump-version. -
static async pack(ctx: ServiceContext, configure: Callable[[DenoPackSettings], DenoPackSettings] | None=None) -> ExecResultBuild an npm-compatible tarball:
deno pack. -
static async module_graph(ctx: ServiceContext, configure: Callable[[DenoInfoSettings], DenoInfoSettings] | None=None) -> objectThe module graph rooted at a file, parsed from
deno info --json. A reader, not a gate: it returns the graph rather than printing it, so a build can assert on what its entry point actually pulls in. -
static async cache_info(ctx: ServiceContext, configure: Callable[[DenoInfoSettings], DenoInfoSettings] | None=None) -> objectThe toolchain's cache locations, parsed from
deno info --json.
class DenoTaskSettings(DenoSettings) Settings for deno task.
-
name(value: str) -> SelfThe task name from deno.json (required).
-
task_args(*args: str | float) -> SelfArguments forwarded to the task.
-
recursive() -> SelfRun the task in every workspace member (
--recursive). -
filter(pattern: str) -> SelfSelect the workspace members to run the task in (
--filter). It selects on its own — recursive is not a prerequisite. -
no_prefix() -> SelfDrop the per-member name prefix from output (
--no-prefix), which a recursive run adds. Useful when the output is being parsed rather than read. -
eval_shell() -> SelfTreat the task name as a shell command to evaluate (
--eval) instead of a task defined in the configuration file. -
task_cwd(path: str) -> SelfRun the task from this directory (
--cwd). Distinct from the inheritedcwd, which sets the directory thedenoprocess itself is spawned in: this one moves only the task, leaving configuration discovery anchored where deno started. -
config(path: str) -> SelfUse an explicit config file (
--config). -
frozen() -> SelfError out if the lockfile is out of date (
--frozen). See DenoPermissionSettings.frozen for why the name mirrors the real Deno flag rather thanPnpmSettings.frozenLockfile()'s naming. -
lock(path: str) -> SelfUse an explicit lockfile (
--lock). -
no_lock() -> SelfIgnore the lockfile entirely (
--no-lock). -
node_modules_dir(mode: Literal['auto', 'manual', 'none']) -> SelfSet the node-modules management mode (
--node-modules-dir). -
node_modules_linker(mode: Literal['isolated', 'hoisted']) -> SelfSet the npm linker mode (
--node-modules-linker). -
env_file(path: str) -> SelfLoad environment variables from a file (
--env-file).
class DenoTestSettings(DenoPermissionSettings) Settings for deno test.
A run reports its counts into the running target's row of the build summary — // Tests: 837 · Passed: 837 · Failed: 0 — read from the result line the pretty and dot reporters print (ignored tests count as Skipped); a failed run reports too, so a red row says how many failed. The JUnit and TAP reporters print no such line, so a run under .reporter("junit")/.reporter("tap") reports nothing.
-
paths(*paths: str) -> SelfRestrict the run to specific test files or directories.
-
coverage(dir: str) -> SelfCollect coverage into the given profile directory (
--coverage=). -
coverage_raw_data_only() -> SelfCollect raw coverage data without generating a report (
--coverage-raw-data-only). -
clean() -> SelfEmpty the coverage profile directory before running (
--clean), so a run reports on its own tests rather than on whatever a previous run left. The directory need not come from coverage:DENO_COVERAGE_DIRsets it too, which is why this is not tied to that setter. -
filter(pattern: str) -> SelfOnly run tests whose name matches (
--filter). -
parallel() -> SelfRun test files in parallel (
--parallel). -
fail_fast(count: float | None=None) -> SelfStop after
countfailures (--fail-fast), or after the first. -
doc() -> SelfEvaluate the code blocks in JSDoc and Markdown as tests (
--doc). -
no_run() -> SelfCache the test modules without running them (
--no-run). -
shuffle(seed: float | None=None) -> SelfRandomise test order (
--shuffle), optionally with a fixed seed so a failing order can be replayed. -
trace_leaks() -> SelfTrace the ops a test leaks (
--trace-leaks). It costs run time and is the only practical way to find which test leaked a pending op — the flakiest class of failure a suite has. -
sanitize_ops() -> SelfRequire every async op started in a test to finish in it (
--sanitize-ops). -
sanitize_resources() -> SelfRequire every resource opened in a test to be closed in it (
--sanitize-resources). -
hide_stacktraces() -> SelfOmit stack traces from failure output (
--hide-stacktraces). -
reporter(kind: Literal['pretty', 'dot', 'junit', 'tap']) -> SelfSelect the console reporter (
--reporter). -
junit_path(path: str) -> SelfAlso write a JUnit XML report to
path(--junit-path), whatever the console reporter is — this is the file a CI test-report UI ingests. -
ext(value: str) -> SelfTreat the inputs as this content type (
--ext). -
ignore(*patterns: str) -> SelfSkip files matching these patterns (
--ignore). -
permit_no_files() -> SelfSucceed when no test files matched (
--permit-no-files). -
config(path: str) -> SelfUse an explicit config file (
--config). -
no_config() -> SelfDiscover no configuration file at all (
--no-config). -
type_check(scope: Literal['all', 'remote'] | None=None) -> SelfType-check before running (
--check), optionally including remote code. -
no_check(scope: Literal['all', 'remote'] | None=None) -> SelfSkip type-checking (
--no-check), optionally only for remote code. -
inspect(host_port: str | None=None) -> SelfActivate the inspector (
--inspect). -
inspect_brk(host_port: str | None=None) -> SelfActivate the inspector and break at the start (
--inspect-brk). -
inspect_wait(host_port: str | None=None) -> SelfActivate the inspector and wait for a debugger (
--inspect-wait). -
env_file(path: str) -> SelfLoad environment variables from a file (
--env-file). -
cert(path: str) -> SelfLoad a certificate authority from a PEM file (
--cert). -
location(href: str) -> SelfSet
globalThis.location(--location). -
seed(value: float) -> SelfSeed the random number generator (
--seed), making a run reproducible. -
v8_flags(*flags: str) -> SelfPass flags through to V8 (
--v8-flags). -
conditions(*values: str) -> SelfResolve npm package exports with these conditions (
--conditions). -
preload(*paths: str) -> SelfExecute these modules before the main one (
--preload). -
require(*paths: str) -> SelfExecute these CommonJS modules before the main one (
--require). -
allow_scripts(*packages: str) -> SelfPermit npm lifecycle scripts, optionally only for these packages (
--allow-scripts). -
lock(path: str) -> SelfUse an explicit lockfile (
--lock). -
no_lock() -> SelfIgnore the lockfile entirely (
--no-lock). -
import_map(path: str) -> SelfLoad an import map from a file or URL (
--import-map). -
cached_only() -> SelfResolve only from the cache (
--cached-only). -
no_npm() -> SelfDo not resolve npm modules (
--no-npm). -
no_remote() -> SelfDo not resolve remote modules (
--no-remote). -
reload(*specifiers: str) -> SelfReload the module cache (
--reload), optionally only these specifiers. -
node_modules_dir(mode: Literal['auto', 'manual', 'none']) -> SelfSet the node-modules management mode (
--node-modules-dir). -
node_modules_linker(mode: Literal['isolated', 'hoisted']) -> SelfSet the npm linker mode (
--node-modules-linker). -
vendor(enabled: bool | None=None) -> SelfToggle the local vendor folder (
--vendor). -
watch() -> SelfRe-run when a watched file changes (
--watch). -
watch_exclude(*paths: str) -> SelfExclude paths from the watcher (
--watch-exclude). -
no_clear_screen() -> SelfKeep previous output when re-running under
--watch(--no-clear-screen).
class DenoUninstallSettings(DenoLockSettings) Settings for deno uninstall.
-
packages(*names: str) -> SelfThe dependency names, or the global executable name, to remove (required).
-
global_() -> SelfRemove a globally installed executable (
--global) rather than a project dependency. -
root(path: str) -> SelfThe installation root the executable lives under (
--root). -
lockfile_only() -> SelfUpdate the lockfile without touching
node_modules(--lockfile-only). -
package_json() -> SelfRemove from
package.jsonrather thandeno.json(--package-json).
class DenoUpgradeSettings(DenoSettings) Settings for deno upgrade.
-
version(value: str) -> SelfThe version, channel (
alpha,beta,rc,canary) or commit hash to install. Omit it to move to the latest stable release. -
dry_run() -> SelfRun every check without replacing the executable (
--dry-run). -
force() -> SelfReplace the executable even when it is already up to date (
--force). -
no_delta() -> SelfDownload the full archive instead of a delta update (
--no-delta). -
output(path: str) -> SelfWrite the upgraded executable somewhere else (
--output), leaving the running one in place. This is what makesupgradeusable from a build: a target can fetch a second Deno without replacing the one executing it. -
checksum(sha256: str) -> SelfVerify the downloaded archive against a SHA-256 checksum (
--checksum).
class DenoWhySettings(DenoLockSettings) Settings for deno why.
-
package_name(value: str) -> SelfThe package to explain, optionally with a version (
express@4.18.2) (required).