Welcome to punch-vscode-plugin

Provide punchlang code assistance to visual code editor.

Quick Start

1. Clone this repo
2. Build plugin

npm install -g @vscode/vsce
npm install
vsce package

3. Install plugin

code --install-extension punch-vscode-plugin-1.1.0.vsix
code --list-extension

2. Reopen your VSCode

3. Extension is activated when you first access a Punch file

Prerequisites

• NodeJS >= v16.14.0 & npm >= 8.5.0 (Properly install NodeJS & npm through nvm)

• Python >= 3.6.8 (Properly install Python using Pyenv)

• VSCode >= 1.74.0 (Properly install VsCode)

• Remove all settings already assign to punch files (File/Preferences/Settings)

Features

• Syntax Highlight

• Snippets for Punch operators

• Snippets for Java

• Punch file formatter

• Run Test annotation

• Create Untitled Punch file

• Create Untitled Punch class file

ShortCuts

• "F7" : @Test annotation

• "F2" : Create Untitled Punch file

• "F4" : Create Untitled Punch class file

• "ctrl + shift + I" : format document

• "ctrl + shift + P" + Format Document : format document

• "ctrl + shift + P" + Create New Punchlet : open new Untitled Punch file

• "ctlr + shift + /" : comment selected lines or current line (if no selected)

Remark :

   "ctrl + shift + P" command is equivalent to "F1"

List Snippets Punch Operators

• cef

• cidrmatch

• csv

• findByKey

• grok2

• kv

• print

• raise

• tuple

Extension Settings

This extension contributes the following settings :

• Punch-formatter: Indentwidth : number of spaces used for indentation (default = 1)

• Punch-formatter: Python Path : optional custom path to python executable (requires restarting vscode)

• Punch-formatter: Formatter Path : optional custom path to punch formatter (requires restarting vscode)

• Punch-puncher: Puncher Tag : Puncher docker image tag

License

All PunchPlatform software, documentation, resources are Copyright (c) Thales Services SAS, France 2015-2021. All rights reserved