Refcode

Refcode is a VSCode extension allowing copy selected code and render it using a customizable template to your clipboard.

It supports various template variables and filters to customize the output providing a status bar icon for quick copying of code using the specified template. It also supports post-actions, enabling you to call custom commands to process the rendered text, such as uploading it to a code bin.

Get started

1. Install the extension.
2. Select lines of code in the editor.
3. Click the status bar icon
4. Select a template from the list, now the rendered text is in your clipboard.

Features

• Copy selected code rendered using a template.
• Supports the following template variables to handle the selected code
• Allows template filters, including stripIndent and strip.
• Here is a template example: "{relpath}:\n{lang}\n{#stripIndent}{content}{/stripIndent}\n".
• Displays a status bar icon for quick copying using the given template.
• Supports post-actions, allowing you to call custom commands to process the rendered text.

NOTE:

• If you want to customize a post-action command, your program should print the result to stdout.
  • If the command exits with a non-zero status or has stderr output, the copy operation will be aborted. An error message will be raised, and nothing will be copied.

Template variables

Here is a list of template variables for the selected code:

• path: The file path.
• relpath: The relative file path (relative to your workspace root).
• outline: The outline path of it. Like Foo » useEffect() callback
• lineno: The starting line number of it.
• colno: The starting column number of it.
• linenoEnd: The ending line number of it.
• colnoEnd: The ending column number of it.
• lang: The language of the code.
• content: The content of it.

Post-actions

Custom post-actions

Configure the postActions option to enable post-actions.

Example:

{
    "refcode.templates": [
        {
            "name": "markdown classic",
            "template": "`{relpath}`:\n```{lang}\n{#stripIndent}{content}{/stripIndent}\n```",
            "postActions": [
                "base64"
            ]
        }
    ],
}

This will call the base64 command after rendering the template. So you'll get the base64 encoded text in your clipboard.

You can even turn it into a base64 decoder, by using the base64 -d command as post action.

You can use any command, even your own, as a post-action. For example, you can use the following command to upload the rendered text to a code bin:

{
    "refcode.templates": [
        {
            "name": "markdown classic",
            "template": "`{relpath}`:\n```{lang}\n{#stripIndent}{content}{/stripIndent}\n```",
            "postActions": [
                "curl -F 'f:1=<-' https://paste.example.com"
            ]
        }
    ],
}

Builtin post-actions

• strip: strip the leading and trailing whitespace
• replace: replace the selected text with the rendered text
• eval: eval the function defined after the command (like: eval function foo(input) { return input + 'bar'; })
• no-copy: do not copy the rendered text to the clipboard

You can even use it as a replace engine:

{
    "name": "i18n replace",
    "template": "{content}",
    "postActions": [
        "eval function replaceText(input) {  if (input.startsWith('=\"') && input.endsWith('\"')) {    return '={' + 't(\"' + input.substring(2, input.length - 1) + '\")' + '}';  } else {    return 't(\"' + input + '\")';  }}",
        "writeback"
    ]
}

This will replace the selected text with the i18n key.

Commands

• refcode.refer-use-default-template: Copy selected code using the default template.
• refcode.refer-use-custom-template: Copy selected code using a custom template.
• refcode.set-default-template: Set the default template.

Shortcut

This extension doesn't provide any shortcut by default. You can add a shortcut by yourself.

To set up a shortcut follow these steps:

1. Go to the "File" menu and select "Preferences", then choose "Keyboard Shortcuts" (or use the shortcut Ctrl+K Ctrl+S). This will open the Keyboard Shortcuts editor.
2. On the right-hand side, you will see a search box. Type the name of the command you want to set a shortcut for. For example, if you want to set a shortcut for refcode.refer-use-default-template, type "refcode.refer-use-default-template" in the search box. The matching command will appear in the list below the search box.
3. Click on the "+" icon next to the command name to add a new keybinding. A text input field will appear. Enter your desired shortcut key combination. For example, you can use Ctrl+Shift+C for the refcode.refer-use-default-template command.
4. Once you've entered the shortcut, press Enter to save it.

License

This extension is released under the MIT License. See the LICENSE file for more information.