README.md

regreplace README

Reg Replace is a plugin for Visual Studio Code that allows the creating of commands consisting of sequences of find and replace instructions.

It is heavily inspired from Reg Replace for Sublime Text

Often linters and code formatters cannot do this easily.

Features

• Create find and replace rules that can then be used to create VSCode Commands to call at any time.
• Chain multiple regex find and replace rules together.
• Create rules that can filter regex results by filename.
• Create rules that run on save.

Extension Settings

This extension contributes the following settings:

• on-save - defaults to true, run commands on save.
• suppress-warnings - (optional) Suppress warnings when regreplace fails.
• commands - array of commands that will be run whenever a file is saved.
  • name - command name for debugging.
  • match - regex for matching files to run commands on. e.g. "\\.(ts|js|tsx)$" or ["\\.(ts|js|tsx)$"]
  • exclude - regex for matching files not to run commands on. e.g. "^\\.$" exclude dot files
  • language - used instead of match, exclude will still work e.g. "typescript"
  • priority - command priority determines order.
  • find - use simple find command. e.g. "** what"
  • regexp - use regexp find command. Needs to be escaped. e.g. "(\\n)*"
  • replace - replace text. Supports groups. e.g. "$2\n$1"
  • global - run command asynchronously.

Sample Config

This sample configuration will replace single quotes with double quotes.

"regreplace.commands": [
  {
      "name": "single to double quote",
      "match": "\\.html?$",    // html
      "regexp": "(')(.*?)(')", // single quotes
      "global": true,          // global
      "replace": "\"$2\""      // replace with double quotes
  }

This is another helper of mine

  {
      "name": "classname helper",        // name
      "language": "typescriptreact",     // use vscode language names
      "regexp": "className=\"(.+)\"",  // escaped regex
      "global": true,                    // global
      "replace": "className={styles.$1}" // replaced value
  },
]

Known Issues

Release Notes

1.3.0

• Breaking Change: Renaming command RegReplace: Run all to RegReplace: Run all
• Use diff patching, so we can keep the cursor position
• Fix typos in readme, thanks @atnbueno
• Add language config, thanks @atnbueno
• Adding RegReplace: Run single rule, thanks @iammoen

1.2.0

• Fix readme

1.1.0

• Breaking Change: Renaming command Run RegReplace to RegReplace: Run
• Adding RegReplace: Save without replacing

1.0.0

• Initial release of regreplace.

---

Licence

MIT License