Skip to content

Latest commit

 

History

History
97 lines (53 loc) · 2.7 KB

contributing.md

File metadata and controls

97 lines (53 loc) · 2.7 KB
Raw

Guide for Contributors

Building the Source Code

You must have NPM installed to build the extension. You may obtain it here: https://nodejs.org/en/

Steps

  1. Clone the project repository.
  2. Run npm install in the project directory to have it download and install the necessary modules.

Running the Extension

Steps

  1. Open the project directory in VS Code.
  2. Run Extension via the debug menu.

Testing the Extension

Steps to run from an active VS Code instance:

  1. Open the project directory in VS Code.
  2. Run Extension Tests via the debug menu.

Alternatively the tests can be run from the command line by calling npm test.

Contributing to the Repository

Fork the repository on GitHub and make any changes on the fork. After that, make a pull request.

Input Grammar

  • Variables are bracketed by <>
  • Terminals can either be strings (when enclosed by ') or regexes(when enclosed by /)

// TODO: Fix this part

VARIABLES:

  • -> <GO_TO> | | <SELECT_FROM_CURSOR> | <QUICK_SELECT> | <QUICK_SELECT_FROM_CURSOR> <GO_TO> -> -> <SELECT_SEPARATOR>

  • <SELECT_FROM_CURSOR> -> <SELECT_SEPARATOR>
  • <QUICK_SELECT> -> <QUICK_SELECT_SEPARATOR>
  • <QUICK_SELECT_FROM_CURSOR> -> <QUICK_SELECT_SEPARATOR>

  • -> <LINE_ONLY_COORDINATE> | <CHARACTER_ONLY_COORDINATE> | <FULL_COORDINATE>

    • <LINE_ONLY_COORDINATE> ->
    • <CHARACTER_ONLY_COORDINATE> -> <COORDINATE_SEPERATOR>
    • <FULL_COORDINATE> -> <COORDINATE_SEPERATOR>

  • -> <ABSOLUTE_NUMBER> | <RELATIVE_NUMBER>

  • -> <ABSOLUTE_NUMBER> | <RELATIVE_NUMBER> |

  • <ABSOLUTE_NUMBER> ->

  • <RELATIVE_NUMBER> -> <SIGN_PREFIX>

  • <SIGN_PREFIX> -> <POSITIVE_SIGN_PREFIX> | <NEGATIVE_SIGN_PREFIX>

  • -> <START_OF_LINE_SHORTCUT> | <START_OF_TRIMMED_LINE_SHORTCUT> | <END_OF_LINE_SHORTCUT> | <END_OF_TRIMMED_LINE_SHORTCUT>

    • TERMINALS:

    • <SELECT_SEPARATOR> -> :

    • <QUICK_SELECT_SEPARATOR> -> ;

    • <COORDINATE_SEPERATOR> -> ,

    • -> /\d+/

    • <POSITIVE_SIGN_PREFIX> -> +

    • <NEGATIVE_SIGN_PREFIX> -> -

    • <START_OF_LINE_SHORTCUT> -> H

    • <START_OF_TRIMMED_LINE_SHORTCUT> -> h

    • <END_OF_LINE_SHORTCUT> -> L

    • <END_OF_TRIMMED_LINE_SHORTCUT> -> l

    Input Grammar Gen 2

    • -> | : | ; | : | ;

    -> + | - |