minor README and script updates (#91)

* readme: include logo

* contrib: update wording

* mention wip snippets

* minor updates for gen_json_grammar

- add --dry flag to skip push
- move copy and sanity check into function

* mention gh linguist

Author: serkonda7

CHANGELOG.md

@@ -2,6 +2,7 @@
 ## 0.10.0
 _unreleased_
 
+- Highlight custom types with underscores or numbers
 
 ## 0.9.1
 _30 July 2023_

CONTRIBUTING.md

@@ -2,11 +2,11 @@
 Thanks for your interest in improving vscode-vba!
 
 ## Creating Issues
-Before you create a new issue, please first search in [open issues][issues] to check it is not already reported.
+Report bugs or suggest new features.
 
-In case your issue already exists, add a reaction and possibly create relevant comments.
+Before opening a issue, please first search in [open issues][issues] to check it is not already reported.
 
-Otherwise proceed with opening a new one.
+In case your issue already exists, add a reaction and if possible, comment with further information.
 
 ## Creating Pull Requests
 > Before making bigger changes, please discuss them in an issue.
@@ -21,14 +21,14 @@ It allows merging them faster with less conflicts and will reduce review time.
 - Create a new working branch for your changes
 
 ## Regexes
-TextMate uses Oniguruma regexes it's mostly compatible with PCRE but not always.
+TextMate uses Oniguruma regexes which are mostly compatible with PCRE.
 A quite decent overview and comparison can be found here: https://rbuckton.github.io/regexp-features/engines/oniguruma.html
 
-As far as I know, the best tool to test regexes is https://regexr.com/ in PCRE mode.
+A good tool to test these regexes is https://regexr.com/ in PCRE mode.
 
 ### Unit Tests
 Every PR should contain a test case that covers the added feature or bug fix.
-This prevents regressions and makes reviewing the changes easier by proofing correct functionality.
+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:

README.md

@@ -1,11 +1,17 @@
-# VBA and WWB support for VS Code
+<img align="left" width=110 src="images/icon_256x256.png">
+
+# 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]
+---
 
-Adds syntax highlighting to Visual Studio Code for the following languages:
-- Visual Basic for Applications (VBA)
-- WinWrap Basic (WWB)
+## Key Features
+- Syntax highlighting for the following languages (also used by [GitHub Linguist][gh-linguist])
+  - Visual Basic for Applications (VBA)
+  - WinWrap Basic (WWB)
+- :construction: Export and Import of Macros for Office Documents
+- :construction: Comprehensive snippets
 
 ## Installation
 Launch the command palette (<kbd>Ctrl</kbd>+<kbd>P</kbd>) and run
@@ -14,12 +20,13 @@ Launch the command palette (<kbd>Ctrl</kbd>+<kbd>P</kbd>) and run
 The extension is also available on [Open VSX][open-vsx].
 
 ## Contributing
-Any contributions are highly appreciated!
-For details see [CONTRIBUTING.md](CONTRIBUTING.md).
+Thank you in advance, any contributions are highly appreciated!
+
+For details, please see [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License
 Source code and grammars are licensed under the [Mozilla Public License (MPL-2.0)](LICENSE.txt).<br>
-The icon is licensed under [Creative Commons ShareAlike](images/LICENSE).
+The icon is licensed under the [Creative Commons ShareAlike](images/LICENSE) License.
 
 <!-- links -->
 [ci-badge]: https://github.com/serkonda7/vscode-vba/actions/workflows/ci.yml/badge.svg
@@ -28,3 +35,4 @@ The icon is licensed under [Creative Commons ShareAlike](images/LICENSE).
 [badge-installs-vsx]: https://img.shields.io/open-vsx/dt/serkonda7/vscode-vba?label=VSX%20downloads
 [vs-marketplace]: https://marketplace.visualstudio.com/items?itemName=serkonda7.vscode-vba
 [open-vsx]: https://open-vsx.org/extension/serkonda7/vscode-vba
+[gh-linguist]: https://github.com/DecimalTurn/linguist/blob/master/vendor/licenses/git_submodule/vscode-vba-json.dep.yml

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "vscode-vba",
 	"displayName": "VBA",
-	"description": "Visual Basic for Applications and WinWrap Basic support for VS Code.",
+	"description": "VBA tooling, syntax highlighting and snippets for VS Code.",
 	"icon": "images/icon_256x256.png",
 	"version": "0.10.0-dev",
 	"license": "MIT",

scripts/gen_json_grammar.bt

@@ -1,5 +1,5 @@
 // This file is part of vscode-vba.
-// Copyright (c) 2023-present Lukas Neubert
+// Copyright (c) 2023-present Lukas Neubert.
 // This Source Code is subject to the terms of the Mozilla Public License 2.0.
 
 package main
@@ -9,7 +9,9 @@ import bait.util
 
 const GIT_USER := 'tiabeast-bot'
 const GIT_MAIL := '[email protected]'
+const REPO_DIR := '/tmp/vscode-vba-json'
 
+const DRY_RUN := os.user_args().contains('--dry')
 const IS_CI := os.getenv('CI') == 'true'
 
 fun main() {
@@ -22,55 +24,63 @@ fun main() {
 		errors += git_command('config --global user.email "${GIT_MAIL}"')
 	}
 
-	target_repo_dir := '/tmp/vscode-vba-json'
-	if os.exists(target_repo_dir) {
-		os.rmdir_all(target_repo_dir)
+	if os.exists(REPO_DIR) {
+		os.rmdir_all(REPO_DIR)
 	}
 
 	// Clone repo as bot user
 	access_token := os.getenv('BOT_TOKEN')
-	errors += git_command('clone --depth 1 https://${GIT_USER}:${access_token}@github.com/tiabeast/vscode-vba-json.git ${target_repo_dir}')
+	errors += git_command('clone --depth 1 https://${GIT_USER}:${access_token}@github.com/tiabeast/vscode-vba-json.git ${REPO_DIR}')
 
 	// Run conversion
 	errors += os.system('npm run convert-yaml')
 
-	// Copy syntax files
-	syntax_dir := '${target_repo_dir}/syntaxes'
-	os.cp('./out/vba.tmGrammar.json', '${syntax_dir}/vba.tmGrammar.json')
-	os.cp('./out/wwb.tmGrammar.json', '${syntax_dir}/wwb.tmGrammar.json')
-
-	// Sanity check for a reasonable file size
-	text := os.read_file(syntax_dir + '/vba.tmGrammar.json')
-	if text.length < 1000 {
-		eprintln('grammar is too small. Something went wrong.')
-		exit(1)
-	}
+	// Copy grammar files
+	println('Copying grammar files...')
+	copy_grammar('vba', 1500)
+	copy_grammar('wwb', 100)
 
 	// Stage changes
-	errors += git_command('-C ${target_repo_dir} add .')
+	errors += git_command('-C ${REPO_DIR} add .')
 
 	// Exit if there is nothing to commit
-	has_changes := git_command('-C ${target_repo_dir} diff-index --quiet HEAD')
+	has_changes := git_command('-C ${REPO_DIR} diff-index --quiet HEAD')
 	if has_changes == 0 {
 		println('No changes to commit.')
 		exit(0)
 	}
 
 	// Create commit
 	println('Creating commit...')
-	os.chdir(target_repo_dir)
+	os.chdir(REPO_DIR)
 	commit_msg := 'update grammars'
 	errors += git_command('commit -m "${commit_msg}"')
 
 	// Safety rebase and push changes
-	println('Pushing changes...')
-	errors += git_command('pull --rebase')
-	errors += git_command('push')
+	if not DRY_RUN {
+		println('Pushing changes...')
+		errors += git_command('pull --rebase')
+		errors += git_command('push')
+	}
 
 	// Exit with the number of errors
 	exit(errors)
 }
 
+fun copy_grammar(lang string, min_size i32) {
+	src := './out/${lang}.tmGrammar.json'
+
+	// Sanity check for a reasonable file size
+	text := os.read_file(src)
+	if text.length < min_size {
+		eprintln('error: Grammar for ${lang} is too small.')
+		exit(1)
+	}
+
+	// Copy
+	os.cp(src, '${REPO_DIR}/syntaxes/${lang}.tmGrammar.json')
+}
+
 fun git_command(cmd string) i32 {
 	esc_cmd := util.shell_escape(cmd)
 	return os.system('git ${esc_cmd}')

src/extension.js.bt

@@ -1,5 +1,5 @@
 // This file is part of vscode-vba.
-// Copyright (c) 2021-present Lukas Neubert
+// Copyright (c) 2021-present Lukas Neubert.
 // This Source Code is subject to the terms of the Mozilla Public License 2.0.
 package extension