Deprecate Command

How to deprecate an existing command

Details

we always want to give at least 1w notice before deprecating commands

Steps

If a command is going to be deprecated, show a warning message when the command is run with a button that shows what has changed

window
  .showWarningMessage(
    "Heads up that $OLDCOMMAND is being deprecated and will be replaced with the '$NEW_COMMAND' command",
    "See whats changed"
  )
  .then((resp) => {
    if (resp === "See whats changed") {
      VSCodeUtils.openLink(
        "https://wiki.dendron.so/notes/ftohqknticu6bw4cfmzskq6"
      );
    }
  });

Add telemetry when this command is shown. Sepcifically, use ExtensionEvents.DeprecationNoticeShow and ExtensionEvents.DeprecationNoticeAccept where the source is the name of the command

    AnalyticsUtils.track(ExtensionEvents.DeprecationNoticeShow, {
    source: DENDRON_COMMANDS.INSERT_NOTE.key,
    });
    window
    .showWarningMessage(
        "Heads up that InsertNote is being deprecated and will be replaced with the 'Apply Template' command",
        "See whats changed"
    )
    .then((resp) => {
        if (resp === "See whats changed") {
        AnalyticsUtils.track(ExtensionEvents.DeprecationNoticeAccept, {
            source: DENDRON_COMMANDS.INSERT_NOTE.key,
        });
        VSCodeUtils.openLink(
            "https://wiki.dendron.so/notes/ftohqknticu6bw4cfmzskq6"
        );
        }
    });

After the deprecation notice has been deployed, remove the command in a subsequent release
- Be sure to update area.product.sop.ready-to-ship (Private) with a depreaction notice above the ### Features section
```
BREAKING: remove $COMMAND 

### Features
...
``
```

Backlinks

Cook
Cook

Details

Steps