ADR Utilities is a toolset for create and manage your Architecture Decision Records.
Why another extension ? Because it manages multiple ADR directories (which is essential in huge projects / mono-repository projects / multiple libraries projects) and follows its own rules for naming and managing content.
This extension manipulates ADR files by a naming conventions, which follows this pattern :
So by default :
Create an ADR
Right-click on the explorer (Create an ADR) or launch it with the command palette (ADR Create).
In the explorer, a new file is created into the current directory if its name matches the ADR directory name. If not, the command searches for an ADR directory in the first child directories. Otherwise, an ADR directory is created.
With the Palette, a directory choosing box is displayed to select an ADR location.
In all cases, you must complete the ADR file name by an input box.
Finally, the ADR file is filled with a template.
Navigate with CodeLens
Each mention of ADR in a text editor (which matches the naming pattern) enables a codelens link to navigate to this ADR.
If the name doesn't match a real ADR, the CodeLens annotation marks it as not navigable.
vscode : 1.74.0 or more
To change the name of ADR folders used by this extension.
Default : 'adr'.
Prefix use in ADR filename, to differenciate ADR files from other MD files.
Default : 'adr'.
Enable CodeLens navigation to ADRs.
Default : true.
Template used to fill the created ADR.
Possible values :
Default : defaultTemplateFrench.
An english version of the ADR template is available, with a config entry to choose the used template.
Corrections in file path management.
Initial release of ADR Utilities