Formatter Validator Minifier Escape / Unescape JSON ↔ String JSON ↔ YAML JSON → CSV NDJSON / JSON Lines JSON → Types JSON ↔ XML JSON Diff JSON Patch Canonicalize (RFC 8785) Schema Validator Schema Generator JSONPath Tester JWT Decoder JSON Errors Schemas More Tools
JSONTools / Schema registry / Madge configuration
Schema registry

Madge configuration

Madge module dependency analysis configuration file

.madgerc

Check your file against this schema

Opens the validator with this schema already loaded. Paste your .madgerc and it validates in your browser — nothing is uploaded.

Validate a .madgerc → View raw schema

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field Type Description
$schemastringURI of the JSON Schema used to validate this configuration. https://json-schema.org/understanding-json-schema/reference/schema.html
baseDironeOfBase directory to use when resolving paths. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: null
includeNpmbooleanWhether to include shallow npm dependencies in the graph. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: false
fileExtensionsarray<string>File extensions to analyze, without leading periods. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: ["js"]
excludeRegExponeOfRegular expression strings used to exclude modules, or false to disable exclusions. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: false
requireConfigoneOfPath to a RequireJS configuration used to resolve aliased modules. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: null
webpackConfigoneOfPath to a webpack configuration used to resolve aliased modules. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: null
tsConfigoneOfPath to a TypeScript configuration or an embedded TypeScript configuration object. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: null
layoutstringGraphviz layout engine used to render the graph. Common values are dot, neato, fdp, sfdp, twopi, and circo. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: "dot"
rankdirstringGraph layout direction. Common Graphviz values are TB, BT, LR, and RL. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: "LR"
fontNamestringFont name used in the graph. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: "Arial"
fontSizestringFont size used in the graph. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: "14px"
backgroundColorstringGraph background color in any syntax supported by Graphviz. https://github.com/pahen/madge/blob/v8.0.0/lib/api.js#L9-L30
default: "#111111"
nodeShapestringGraphviz shape used for nodes. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: "box"
nodeStylestringGraphviz style used for nodes. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: "rounded"
nodeColorstringDefault node color in any syntax supported by Graphviz. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: "#c6c5fe"
noDependencyColorstringColor used for nodes with no dependencies. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: "#cfffac"
cyclicNodeColorstringColor used for nodes involved in circular dependencies. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: "#ff6c60"
edgeColorstringColor used for graph edges. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: "#757575"
graphVizOptionsoneOfAdditional Graphviz graph, edge, and node attributes, or false to use only Madge defaults. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: false
graphVizPathoneOfDirectory containing the Graphviz executables, or false or null to use executables from PATH. https://github.com/pahen/madge/blob/v8.0.0/lib/graph.js#L21-L36
default: false
detectiveOptionsoneOfParser-specific detective options passed to dependency-tree, or false to use parser defaults. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: false
dependencyFilterconstDisables the programmatic dependency filter. Functions are supported by the JavaScript API but cannot be represented in JSON configuration. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration
default: false

What we found in this schema

Specification sections for the keywords in this schema

Keyword Document Section
$idJSON Schema Core, draft 2020-12§8.2.1 — The "$id" Keyword
$refJSON Schema Core, draft 2020-12§8.2.3.1 — Direct References with "$ref"
$schemaJSON Schema Core, draft 2020-12§8.1.1 — "$schema"
additionalPropertiesJSON Schema Core, draft 2020-12§10.3.2.3 — "additionalProperties"
constJSON Schema Validation, draft 2020-12§6.1.3 — "const"
defaultJSON Schema Validation, draft 2020-12§9.2 — "default"
descriptionJSON Schema Validation, draft 2020-12§9.1 — "title" and "description"
formatJSON Schema Validation, draft 2020-12§7 — Vocabularies for Semantic Content With "format"
itemsJSON Schema Core, draft 2020-12§10.3.1.2 — "items"
minLengthJSON Schema Validation, draft 2020-12§6.3.2 — "minLength"
oneOfJSON Schema Core, draft 2020-12§10.2.1.3 — "oneOf"
patternJSON Schema Validation, draft 2020-12§6.3.3 — "pattern"
propertiesJSON Schema Core, draft 2020-12§10.3.2.1 — "properties"
typeJSON Schema Validation, draft 2020-12§6.1.1 — "type"
format: "uri"RFC 3986 (STD 66)§3 — Syntax Components

Documents

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas