/vscode-adr-tools-extension

Visual Studio Code extension, for ADR documentation, based on Nat Pryce work.

Primary LanguageJavaScript

Build Status Known Vulnerabilities Maintainability Test Coverage

ADR tools for Visual Studio Code

This is an extension for Visual Studio Code, to apply Architecture Decision Records.

Features

Some palette commands to help applying ADR.

Requirements

Need git client installed.

Extension Settings

This extension contributes the following settings:

  • adr.project.directory: destination folder for ADR
  • adr.templates.directory: source folder where template are git cloned
  • adr.templates.repo: url from where templates are cloned.

Known Issues

This is a pre-release, for first users feedback.

Release Notes

0.0.4

Adding logs and parameters to activate it:

  • Logs will appear in Output windows of vscode.
  • Parameter: adr.log.enable, to set in .

0.0.3

New features:

  • new status: 'Proposal'
  • adding date on each status change event
  • adding command for generating doc (only flow chart for the moment)
    • generating docs will now parse ADRs, generating a json files of relation between ADR, and generate flow chart.
    • json file could be use for generating other documentation type.

Bug fixes:

  • Remove git hard reset when .adrtemplate exists (very dangerous...)
  • fix flow chart layout generator

Technical:

  • Adding full integration tests

0.0.2

Bugs fixes:

  • Fix bugs on creating linked ADR. Technical:
  • Finalize travis CI/CD (build on linux, publish to marketplace)

0.0.1

Initial release. Commands availables:

  • ADR Init: create structures and clone templates
  • ADR New: create a new ADR
  • ADR Link: link 2 ADR
  • ADR Config: change configuration