Add marketplace icon

This commit is contained in:
Dag Evensberget 2019-12-02 14:05:47 +10:00
parent 47e5da4da7
commit 94935c7632
4 changed files with 35 additions and 17 deletions

View File

@ -15,3 +15,5 @@ Fixed image in README to reflect new features.
Tidy README and clean up `devDependencies`. Tidy README and clean up `devDependencies`.
### 0.2.4 ### 0.2.4
Mention support for [Breadcrumbs](https://code.visualstudio.com/updates/v1_26#_breadcrumbs). Mention support for [Breadcrumbs](https://code.visualstudio.com/updates/v1_26#_breadcrumbs).
### 0.2.5
Add icon to marketplace.

View File

@ -1,8 +1,8 @@
# SWMF configuration file syntax # SWMF Configuration
> This is a Visual Studio Code extension and should be installed from the [VS Code extensions marketplace](https://marketplace.visualstudio.com/items?itemName=svaberg.swmf-grammar) > This is a Visual Studio Code extension and should be installed from the [VS Code extensions marketplace](https://marketplace.visualstudio.com/items?itemName=svaberg.swmf-grammar)
This extension provides syntax highlighting, outline view, and some code completion for [Space Weather Modelling Framework (SWMF)](http://csem.engin.umich.edu/tools/swmf/) configuration files, such as the BATSRUS `PARAM.in` file. The rules are based on the [SWMF manual](http://csem.engin.umich.edu/tools/swmf/documentation/SWMF.pdf) section 3.2.2. This extension provides syntax highlighting, outline view, breadcrumbs, and some code completion for [Space Weather Modelling Framework (SWMF)](http://csem.engin.umich.edu/tools/swmf/) configuration files, such as the BATSRUS `PARAM.in` file. The rules are based on the [SWMF manual](http://csem.engin.umich.edu/tools/swmf/documentation/SWMF.pdf) section 3.2.2.
Automatically highlights files ending in `.in` and `.IN`. Automatically highlights files ending in `.in` and `.IN`.
@ -10,42 +10,53 @@ Automatically highlights files ending in `.in` and `.IN`.
## Features ## Features
* Syntax highlighting * Syntax highlighting;
* Hierarchical document tree in outline view. * Hierarchical document tree in the [outline view](https://code.visualstudio.com/docs/getstarted/userinterface#_outline-view);
* [Breadcrumbs](https://code.visualstudio.com/updates/v1_26#_breadcrumbs) support * [Breadcrumbs](https://code.visualstudio.com/updates/v1_26#_breadcrumbs) support;
* Toggle comment using `!` as comment character. * Toggle comment using `!` as comment character;
* Code folding between `#BEGIN_COMP` and `#END_COMP` markers. * Code folding between `#BEGIN_COMP` and `#END_COMP` markers;
* Autoclosing of `#BEGIN_COMP`. * Autoclosing of `#BEGIN_COMP`.
## Installation ## Installation
This is a [Visual Studio Code](https://code.visualstudio.com/download) extension. It is best installed from the [on-line extensions marketplace](https://marketplace.visualstudio.com/items?itemName=svaberg.swmf-grammar), or from inside VS Code `Preferences/Extensions` and search for `swmf-grammar`. This is a [Visual Studio Code](https://code.visualstudio.com/download) extension. It is best installed from the [on-line extensions marketplace](https://marketplace.visualstudio.com/items?itemName=svaberg.swmf-grammar), or from inside VS Code `Preferences/Extensions` and search for `swmf-grammar`.
### Alternative installation from source code Alternatively, the extension can be built and installed manually as in the next section.
This should only be required for developers. ### Manual installation from source code
> This should only be required for developers.
1. Clone the repository and enter into the folder 1. Clone the repository and enter into the folder
```bash ```bash
git clone git@github.com:svaberg/SWMF-grammar.git git clone git@github.com:svaberg/SWMF-grammar.git
cd SWMF-grammar cd SWMF-grammar
``` ```
2. Install the required packages
2. Install the required packages with `npm`
```bash ```bash
npm install npm install
``` ```
3. Create a package
3. Create a package using `vsce`
```bash ```bash
vsce package vsce package
``` ```
This should generate a `.vsix` file in the current directory.
This should generate a `swmf-grammar-?.?.?.vsix` file in the current directory.
4. Manually install the extension in VS Code (you may want to replace the wildcards in the version number) 4. Manually install the extension in VS Code (you may want to replace the wildcards in the version number)
```bash ```bash
code --install-extension swmf-grammar-?.?.?.vsix code --install-extension swmf-grammar-?.?.?.vsix
``` ```
To test the installation, open the current folder in VS Code To test the installation, open the current folder in VS Code
```bash ```bash
code . code .
``` ```
and view the file `demo.in`. and view the file `demo.in`.

BIN
images/icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

View File

@ -1,6 +1,6 @@
{ {
"name": "swmf-grammar", "name": "swmf-grammar",
"displayName": "SWMF Configuration language support", "displayName": "SWMF Configuration",
"description": "Syntax highlights and outline view for SWMF configuration files", "description": "Syntax highlights and outline view for SWMF configuration files",
"version": "0.2.4", "version": "0.2.4",
"publisher": "svaberg", "publisher": "svaberg",
@ -16,6 +16,11 @@
"Programming Languages", "Programming Languages",
"Formatters" "Formatters"
], ],
"icon": "images/icon.png",
"galleryBanner": {
"color": "#C80000",
"theme": "dark"
},
"main": "./out/extension.js", "main": "./out/extension.js",
"activationEvents": [ "activationEvents": [
"onLanguage:swmf-config" "onLanguage:swmf-config"