Madge configuration
Madge module dependency analysis configuration file
.madgerc
Validate
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.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
$schema | string | URI of the JSON Schema used to validate this configuration. https://json-schema.org/understanding-json-schema/reference/schema.html |
baseDir | oneOf | Base directory to use when resolving paths. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: null |
includeNpm | boolean | Whether to include shallow npm dependencies in the graph. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: false |
fileExtensions | array<string> | File extensions to analyze, without leading periods. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: ["js"] |
excludeRegExp | oneOf | Regular 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 |
requireConfig | oneOf | Path to a RequireJS configuration used to resolve aliased modules. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: null |
webpackConfig | oneOf | Path to a webpack configuration used to resolve aliased modules. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: null |
tsConfig | oneOf | Path to a TypeScript configuration or an embedded TypeScript configuration object. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: null |
layout | string | Graphviz 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" |
rankdir | string | Graph 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" |
fontName | string | Font name used in the graph. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: "Arial" |
fontSize | string | Font size used in the graph. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: "14px" |
backgroundColor | string | Graph background color in any syntax supported by Graphviz. https://github.com/pahen/madge/blob/v8.0.0/lib/api.js#L9-L30 default: "#111111" |
nodeShape | string | Graphviz shape used for nodes. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: "box" |
nodeStyle | string | Graphviz style used for nodes. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: "rounded" |
nodeColor | string | Default node color in any syntax supported by Graphviz. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: "#c6c5fe" |
noDependencyColor | string | Color used for nodes with no dependencies. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: "#cfffac" |
cyclicNodeColor | string | Color used for nodes involved in circular dependencies. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: "#ff6c60" |
edgeColor | string | Color used for graph edges. https://github.com/pahen/madge/blob/v8.0.0/README.md#configuration default: "#757575" |
graphVizOptions | oneOf | Additional 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 |
graphVizPath | oneOf | Directory 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 |
detectiveOptions | oneOf | Parser-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 |
dependencyFilter | const | Disables 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 |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 32 properties, 91% carrying a description, max nesting depth 6.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
const | JSON Schema Validation, draft 2020-12 | §6.1.3 — "const" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
format | JSON Schema Validation, draft 2020-12 | §7 — Vocabularies for Semantic Content With "format" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
minLength | JSON Schema Validation, draft 2020-12 | §6.3.2 — "minLength" |
oneOf | JSON Schema Core, draft 2020-12 | §10.2.1.3 — "oneOf" |
pattern | JSON Schema Validation, draft 2020-12 | §6.3.3 — "pattern" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
format: "uri" | RFC 3986 (STD 66) | §3 — Syntax Components |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
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.