forked from jeyllani/pinescript
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Grammars for built-in method fixed - Grammars for type casing fixed
- Loading branch information
Showing
6 changed files
with
2,413 additions
and
2,633 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,108 @@ | ||
| <p align="center"> <img src="https://github.com/jeyllani/pinescript/blob/main/images/pineicon.png?raw=true"> </p> | ||
| <h2 align="center"> Pine Script V5 </h2> </center> | ||
| <h3 align="center">⭐ Syntax Highlighting | Snippets | Hovers ⭐ </h3> </center> | ||
|  | ||
|
|
||
| --- | ||
|
|
||
| #### **Syntax** | ||
| # PineScript V5 Helper | ||
| ## Language support for Pine Script V5 with Syntax Highlighting & Snippets | ||
| **Note: This is a forked project from JeylaniB's [Pine Script](https://marketplace.visualstudio.com/items?itemName=JeylaniB.pinescript) extension.** | ||
|
|
||
| <img src="https://github.com/jeyllani/pinescript/blob/main/images/syntax.gif?raw=true" width="39%" height="39%"> | ||
| PineScript Helper provides language support for PineScript, the scripting language used in TradingView. This extension enhances the coding experience by offering syntax highlighting, snippets, and hovers to provide reference manual information for PineScript scripts. | ||
|
|
||
| --- | ||
| ### What is PineScript? | ||
| PineScript is a domain-specific scripting language developed by TradingView. It is primarily used to create custom technical indicators, strategies, and alerts within the TradingView platform. PineScript is specifically designed for financial market analysis and allows traders to create their own indicators and strategies to automate trading decisions. | ||
|
|
||
| #### **Hovers** | ||
| ## Features | ||
| - **Syntax Highlighting** : The extension provides syntax highlighting for PineScript V5, making your code more readable and easier to navigate. | ||
|
|
||
| <img src="https://github.com/jeyllani/pinescript/blob/main/images/hovers.gif?raw=true" width="100%" height="100%"> | ||
|  | ||
|
|
||
| --- | ||
|
|
||
| #### **Snippets** | ||
| - **Snippets** : Easily insert commonly used PineScript code blocks using snippets. Save time and increase productivity by leveraging the provided snippets. | ||
|
|
||
| <img src="https://github.com/jeyllani/pinescript/blob/main/images/ext1.gif?raw=true" width="100%" height="100%"> | ||
|  | ||
|
|
||
| --- | ||
|
|
||
| <img src="https://github.com/jeyllani/pinescript/blob/main/images/ext2.gif?raw=true" width="100%" height="100%"> | ||
| - **Hovers** : Hover over variables, functions, or keywords to view relevant reference manual information directly in the editor. Get quick access to documentation without leaving your code. | ||
|
|
||
| <img src="https://github.com/jeyllani/pinescript/blob/main/images/ext4.gif?raw=true" width="100%" height="100%"> | ||
|  | ||
|
|
||
| --- | ||
|
|
||
| ### PineScript Color Themes | ||
| PineScript Helper extension is best suited for use with [**PineScript Color Themes**](https://github.com/salbert11/pinethemes). | ||
| **PineScript Color Themes** provides a collection of editor themes tailored for PineScript development, offering a visually pleasing environment for writing PineScript code. | ||
|
|
||
| *Note: If you prefer a different theme, you are free to use any other themes of your choice. PineScript Helper is compatible with most themes.* | ||
|
|
||
| ## Installation | ||
| ### Method 1: Install from VSIX | ||
| 1. Download the latest release of the extension from the [GitHub releases page](https://github.com/salbert11/pinescript/releases). | ||
| 2. Launch Visual Studio Code. | ||
| 3. Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window. | ||
| 4. Click on the "..." (More Actions) icon in the top-right corner of the Extensions view and select "Install from VSIX..." | ||
| 5. In the file dialog, select the downloaded VSIX file (`pinescript-helper.vsix`) and click "Open." | ||
| 6. Once installed, the PineScript Helper extension will be enabled automatically. | ||
|
|
||
| ### Method 2: Clone and Compile in Visual Studio Code | ||
| 1. Clone the PineScript Helper repository to your local machine using the following command: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/salbert11/pinescript.git | ||
| ``` | ||
| 2. Open Visual Studio Code and navigate to the extension's directory by selecting **File > Open Folder** and choosing the cloned "pinescript-helper" folder. | ||
| 3. Install the required dependencies by running the following command in the integrated terminal of Visual Studio Code: | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
| 4. Once the dependencies are installed, build the extension by running the following command in the integrated terminal: | ||
|
|
||
| ```bash | ||
| vsce package | ||
| ``` | ||
| 5. After a successful build, the compiled extension file (`pinescript-helper.vsix`) will be created in the root directory of the extension. | ||
| 6. To install the extension, run the following command in the integrated terminal: | ||
| ```bash | ||
| code --install-extension pinescript-helper.vsix | ||
| ``` | ||
| 7. Once installed, the PineScript Helper extension will be enabled automatically. | ||
|
|
||
| ## Supported File Extensions | ||
|
|
||
| The PineScript Helper extension supports the following file extensions: | ||
|
|
||
| | Supported File Extension | | ||
| | :----------------------- | | ||
| | `.ps` | | ||
| | `.pine` | | ||
| | `.pine` | | ||
| | `.pinecode` | | ||
| | `.script` | | ||
| | `.tdps` | | ||
| | `.trading` | | ||
| | `.tradingview` | | ||
|
|
||
| --- | ||
|
|
||
| ### Roadmap | ||
| ## Usage | ||
| 1. Open a `.pine` or `.pinescript` file in Visual Studio Code. | ||
| 2. The PineScript Helper extension will automatically detect the file type and apply syntax highlighting accordingly. | ||
| 3. Use the available snippets to quickly insert commonly used PineScript code blocks. | ||
| 4. Hover over variables, functions, or keywords to view relevant reference manual information. | ||
|
|
||
| 1. Updating `f` and `script` domains | ||
| 2. Implementing hover informations ✅ | ||
| 3. Implementing intellisense autocompletion | ||
| ## Release Notes | ||
| #### **3.1.0** | ||
|
|
||
| --- | ||
| *08.09.2023 **Update*** | ||
| - Grammars for built-in method fixed | ||
| - Grammars for type casing fixed | ||
|
|
||
| ### **Hover Issue** | ||
| ## Contribution | ||
| Contributions are welcome! Please feel free to submit a [pull request](https://github.com/salbert11/pinescript/pulls) in the GitHub repository. | ||
|
|
||
| * After udating if the hovers don't work | ||
| ## Feedback and Support | ||
| If you encounter any issues, have suggestions, or need support, please feel free to [open an issue](https://github.com/salbert11/pinescript/issues) in the GitHub repository. | ||
|
|
||
| * 1. Unistall the extension | ||
| * 2. Open .vscode file from explorer or finder, or execute `open .vscode` in the terminal | ||
| * 3. Delete `jeylaniB.pinescript` folder | ||
| * 4. Reinstall the extension | ||
| ## License | ||
| This extension is released under the [MIT License](./LICENSE.md) . | ||
|
|
||
| --- | ||
|
|
||
| ### Contributions | ||
|
|
||
| - Contributions are welcome, please check out the contribution checklist | ||
|
|
||
| --- | ||
|
|
||
| ### Issue | ||
| - If you want to report an error, snippet suggestion, script to add or anything else [fill an issue](https://github.com/jeyllani/pinescript/pulls) | ||
|
|
||
| --- | ||
|
|
||
| ##### Version | ||
|
|
||
| *4.0.0* | ||
| *Version 3.1.0* |
Oops, something went wrong.