From f983c8ceaa456525610da68b03fc91999105951f Mon Sep 17 00:00:00 2001 From: PauliusKu Date: Thu, 12 Sep 2024 13:44:43 +0300 Subject: [PATCH 1/3] initial version --- README.md | 93 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 67 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 2fa8d1a..cfb9709 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,69 @@ # AblFormatter -VSCode extension for Progress OpenEdge code formatting - -## Feature Summary - -Already implemented: -- Block -- Assign -- Define - -| | Feature | Default value | Values | Code example | -|--|---------|---------------|-----------------|--------------| -| | tabSize | 4 | Number | | -| | assignFormatting | true | Boolean | | -| | assignFormattingAssignLocation | New | New, Same | | -| | assignFormattingAlignRightExpression | Yes | Yes, No | | -| | assignFormattingEndDotLocation | New aligned | New, New aligned, Same | | -| | defineFormatting | true | Boolean | | -| | findFormatting | true | Boolean | | -| | forFormatting | true | Boolean | | -| | caseFormatting | true | Boolean | | -| | blockFormatting | true | Boolean | | -| | ifFormatting | true | Boolean | | -| | ifFormattingThenLocation | Same | New, Same | `if true then return a.`
⬇️
`if true`
`then return a.` | -| | ifFormattingDoLocation | Same | New, Same | `if true then do:`
` return a.`
`end.`
⬇️
`if true then`
`do:`
` return a.`
`end.` | -| | ifFormattingStatementLocation | Same | New, Same | `if true then return a.`
⬇️
`if true then`
` return a.` | -| | temptableFormatting | true | Boolean | | +VSCode extension for Progress OpenEdge code formatting. + +This extension uses tree-sitter-abl implementation by Kamil Jakubus. TODO: add links + +## Current status + +Early preview blah blah blah + +TODO: Add gif here + +## Features + +At the moment we implemented formatting logic for these language features: + +- Code blocks +- ASSIGN +- CASE +- DEFINE +- FOR +- IF statement +- IF function +- USING + +## Configuration + +TODO: blah blah about reasoning for settings + +TODO: link a separate file with settings + +## Installation + +TODO: generic stuff + +## Usage + +Alowed file extensions: + +- **.p** +- **.cls** +- **.i** +- **.w** + +Commands: + +- **Format Document**: Formats the entire ABL document. +- **Format Selection**: Formats only the selected lines of code. + +## Debuging + +- TODO: describe how to deal with debug mode + +## Contributing + +### Registering formatter issues + +- TODO: create issue template + +### Fixing yourself + +1. Fork the repository. +2. Create a new branch for your feature or bug fix. +3. Commit your changes and push to your branch. +4. Submit a pull request to the main repository. + +## License + +This project is licensed under the APACHE 2.0 License - see the LICENSE file for details. From 9df50947e5a9f3372c2dc4071a469041032ee223 Mon Sep 17 00:00:00 2001 From: Paulius <36190136+PauliusKu@users.noreply.github.com> Date: Tue, 17 Sep 2024 08:07:41 +0300 Subject: [PATCH 2/3] Update README.md --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cfb9709..d5d3f44 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This extension uses tree-sitter-abl implementation by Kamil Jakubus. TODO: add l ## Current status -Early preview blah blah blah +This is an early preview. Currently, the formatter is not ready for the public release. You can only download it here as an early preview. In a few months we should be able to release it on the marketplace. TODO: Add gif here @@ -25,13 +25,15 @@ At the moment we implemented formatting logic for these language features: ## Configuration -TODO: blah blah about reasoning for settings +We implemented extensive settings configuration to allow users to easly tailor the experience to their needs. This might not be the case in the future. TODO: link a separate file with settings ## Installation -TODO: generic stuff +Download the extension .vsix file from GitHub repository and install it on your machine. + +Installing from .vsix https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix ## Usage From f24820436d5cb55f48257e245b6ba21b75baef0d Mon Sep 17 00:00:00 2001 From: PauliusKu Date: Tue, 17 Sep 2024 10:59:18 +0300 Subject: [PATCH 3/3] updated readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d5d3f44..01abd55 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This extension uses tree-sitter-abl implementation by Kamil Jakubus. TODO: add l ## Current status -This is an early preview. Currently, the formatter is not ready for the public release. You can only download it here as an early preview. In a few months we should be able to release it on the marketplace. +This is an early preview. Currently, the formatter is not ready for the public release. You can only download it here and install from **vsix** file. In a few months we should be able to release it to the marketplaces. TODO: Add gif here @@ -31,9 +31,9 @@ TODO: link a separate file with settings ## Installation -Download the extension .vsix file from GitHub repository and install it on your machine. +Download the extension **vsix** file from GitHub repository and install it on your machine. -Installing from .vsix https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix +[How to install from **vsix**?](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) ## Usage