improve icon, docs and CI; require VS Code >= 1.82 (#110)

Author: serkonda7

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 16.x
+          node-version: 18.x
       - uses: pnpm/action-setup@v2
         with:
           version: 8
@@ -33,7 +33,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 16.x
+          node-version: 18.x
       - uses: pnpm/action-setup@v2
         with:
           version: 8
@@ -47,11 +47,12 @@ jobs:
       - name: Package
         run: pnpm run package
 
-      - name: Create Release
+      - name: Upload artifact
         if: startsWith(github.ref, 'refs/tags/')
-        uses: softprops/action-gh-release@v1
+        uses: actions/upload-artifact@v4
         with:
-          files: vscode-vba-0.*.*.vsix
+          name: vba.vsix
+          path: vscode-vba-0.*.*.vsix
 
 
   publish:
@@ -61,26 +62,26 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/')
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 16.x
-      - uses: pnpm/action-setup@v2
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
         with:
-          version: 8
-      - uses: bait-lang/setup-bait@main
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
+          files: vba.vsix
 
-      - name: Publish to VS Code Marketplace
+      - id: publish_to_marketplace
+        name: Publish to VS Code Marketplace
         if: always()
         uses: HaaLeo/publish-vscode-extension@v1
         with:
           pat: ${{ secrets.VSCE_PAT }}
           registryUrl: https://marketplace.visualstudio.com
+          extensionFile: vba.vsix
 
       - name: Publish to Open VSX Registry
         if: always()
         uses: HaaLeo/publish-vscode-extension@v1
         with:
           pat: ${{ secrets.OPEN_VSX_PAT }}
+          extensionFile: vba.vsix

.github/workflows/image-actions.yml

@@ -8,7 +8,7 @@
 !out/*.js
 !out/*.json
 
-!images/icon_256x256.png
+!images/icon.png
 
 !README.md
 !LICENSE.txt

.vscodeignore

@@ -1,4 +1,13 @@
 # Changelog
+## 0.9.7
+_unreleased_
+
+- Add snippets related to `If-Else`, `Sub` and `Function`
+- Change icon to match GitHub Explore
+- Improve documentation
+- Code refactorings
+
+
 ## 0.9.6
 _2024-02-02_
 

CHANGELOG.md

@@ -1,59 +1,84 @@
 # Contributing Guide
-Thanks for your interest in improving vscode-vba!
+Thank you for your interest in contributing to vscode-vba!
 
 
 ## Creating Issues
 Report bugs or suggest new features.
 
-Before opening a issue, please first search in [open issues][issues] to check it is not already reported.
+Before opening an issue, please check that your issue or a similar one has not already been reported in the [open issues][issues].
 
-In case your issue already exists, add a reaction and if possible, comment with further information.
+In case it already is, add a reaction and any additional information.
 
 
-## Creating Pull Requests
-> Before making bigger changes, please discuss them in an issue.
+## Pull Request Best Practices
+- **Discuss bigger changes:** For significant changes, please discuss them first , so no effort is wasted.
+- **Small and focused PRs:**  Aim for one feature or bug fix per pull request. This simplifies reviews and accelerates merging
 
-In general PRs should be kept as small as possible (e.g. one feature/fix per PR).
-It allows merging them faster with less conflicts and will reduce review time.
 
+## Syntax Highlighting Grammar (Regexes and Scopes)
+VS Code uses TextMate Grammars and Oniguruma regexes.
 
-### Repository Setup
-- Install the Bait programming language: https://github.com/bait-lang/bait#building-from-source
-- Create and clone a fork of https://github.com/serkonda7/vscode-vba
-- Run `pnpm install` inside the cloned directory
-- Create a new working branch for your changes
+Oniguruma is mostly compatible with PCRE _([Comparison][oniguruma-overview])_,
+so [regexr][regexr] in PCRE mode is a good choice for development.
 
+For a list of predefined grammar scopes see the [TextMate Manual][textmate-manual].
 
-## Regexes and TextMate Scopes (Syntax Highlighting)
-TextMate uses Oniguruma regexes which are mostly compatible with PCRE ([Compariosn][oniguruma-overview]).
-A good tool to test these regexes is https://regexr.com/ in PCRE mode.
-
-For a list of predefined scopes see https://macromates.com/manual/en/language_grammars#naming_conventions.
+To manually inspect the scopes in the editor,
+execute `Developer: Inspect Tokens and Scopes` from the command palette (<kbd>F1</kbd>).
 
 
 ### Unit Tests
-Every PR should contain a test case that covers the added feature or bug fix.
+Ensure your PR contains tests to cover the feature or bug fix.
 This prevents regressions and makes reviewing the changes easier by providing a proof of correct functionality.
 
-Tests for the language grammar (syntax highlighting) are in [`syntaxes/tests`](syntaxes/tests/).
-They can be run with the following command:
+Tests for the language grammar are in [`syntaxes/tests/`](syntaxes/tests/).
+Run them using:
 ```
 pnpm run test
 ```
 
 
-### Install a dev version
-If you'd like to install a development version of the extension, follow these steps:
+## Snippets
+Adding snippets is as simple as editing [`snippets/vba_snippets.yml`](snippets/vba_snippets.yml).
+
+Refer to the [official documentation][docs-snippets] for guidance.
+
+
+## Install a development version
+To install a development version of the extension, follow these steps:
 1. ```sh
    pnpm run install-dev-ext
    ```
 2. Reload the VS Code window:
-   - Open command palette (<kbd>F1</kbd>)
-   - Run `>reload window`
+   - Execute `Reload Window` from the command palette (<kbd>F1</kbd>)
+
+> Note: Uninstalling previous versions is not necessary.
 
-> Note: It is not required to uninstall any previous versions.
+
+## Development Environment Setup
+Follow these steps to set up your development environment:
+
+1. Install development tools
+   - [Node.js](https://nodejs.org/) >= 18
+      - The latest version should work fine
+      - Otherwise use [NVM][nvm] for management: `nvm install 18 && nvm use 18`
+   - [pnpm](https://pnpm.io/): `pnpm -v || npm install -g pnpm`
+   - Bait programming language: [Installation guide][bait]
+2. Fork and clone the repository https://github.com/serkonda7/vscode-vba
+3. Install dependencies
+   ```sh
+   cd vscode-vba
+   pnpm install
+   ```
+4. Create a new branch and make your changes
 
 
 <!-- links -->
 [issues]: https://github.com/serkonda7/vscode-vba/issues
 [oniguruma-overview]: https://rbuckton.github.io/regexp-features/engines/oniguruma.html
+[regexr]: https://regexr.com/
+[textmate-manual]: https://macromates.com/manual/en/language_grammars#naming_conventions
+[docs-snippets]: https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets
+
+[nvm]: https://github.com/nvm-sh/nvm
+[bait]: https://github.com/bait-lang/bait#installation

CONTRIBUTING.md

@@ -1,41 +1,56 @@
-<img align="left" width=110 src="images/icon_256x256.png">
+<div align="center">
+
+<img width="120" src="images/icon.png">
+<h1>VBA Support for VS Code</h1>
 
-# VBA Support for VS Code
 [![CI][ci-badge]][ci-status]
 [![Marketplace Installs][badge-installs-market]][vs-marketplace]
 [![Open VSX Installs][badge-installs-vsx]][open-vsx]
----
+[![Sponsor on GitHub][sponsors-badge]][sponsors-profile]
 
-> Also used by [GitHub Linguist][gh-linguist]!
+</div>
 
 ## Key Features
-- Syntax highlighting:
-   - Visual Basic for Applications (VBA)
-   - WinWrap Basic (WWB)
+> Used for [GitHub syntax highlighting][gh-linguist]
+
+- VBA syntax highlighting
 - 🚧 Export and Import of Macros for Office Documents
-- 🚧 Comprehensive snippets
+- Comprehensive snippets
+- Syntax highlighting for some dialects _(community maintained)_
+   - WinWrap Basic (WWB)
 
 
 ## Installation
-Launch the command palette (<kbd>Ctrl</kbd>+<kbd>P</kbd>) and run
-`ext install serkonda7.vscode-vba`.
+Launch Quick Open (<kbd>Ctrl</kbd>+<kbd>P</kbd>) and execute this command:
+```
+ext install serkonda7.vscode-vba
+```
 
-The extension is also available on [Open VSX][open-vsx].
+Or download from [Open VSX][open-vsx].
 
 
 ## Contributing
-Thank you in advance, any contributions are highly appreciated!
+Your contributions are always welcome and highly appreciated!
 
-- Questions can be asked in [Discussions][discussions]
-- For creating issues or pull requests, please see [CONTRIBUTING.md](CONTRIBUTING.md)
-- Or make a donation to support the development of new features:
+- **Discuss and Ask Questions:** [GitHub Discussions][discussions] with community support
+- **Report Issues or Submit Changes:** Please check the [Contribution guidelines](CONTRIBUTING.md)
+- **Support the Development** Consider making a donation to help us develop new features:
    [![Sponsor on GitHub][sponsors-badge]][sponsors-profile]
 
 
+## Snippets
+The following snippets are available:
+- `If`
+- `ElseIf`
+- `Else`
+- `Sub`
+- `Function`
+
+
 ## License
-Source code and grammars are licensed under the [Mozilla Public License (MPL-2.0)](LICENSE.txt).
+Source code, grammars and snippets are provided under the [Mozilla Public License (MPL-2.0)](LICENSE.txt).
 
-The icon is licensed under the [Creative Commons ShareAlike](images/LICENSE) license.
+The icon is provided under [CC-BY-4.0](images/LICENSE.txt), courtesy of the GitHub Explore authors.
 
 
 <!-- links -->

README.md

@@ -0,0 +1,9 @@
+Creative Commons Attribution 4.0 International
+
+Copyright (c) GitHub Explore content authors
+
+For details and to obtain the full license text, please visit
+https://creativecommons.org/licenses/by/4.0/deed.en
+
+
+icon.png is based on https://github.com/github/explore