Skip to content

Commit

Permalink
README and CHANGELOG files modified. Version changed.
Browse files Browse the repository at this point in the history
  • Loading branch information
igochkov committed Jun 19, 2023
1 parent f03d7d3 commit 980dad7
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 43 deletions.
61 changes: 36 additions & 25 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,46 @@
# Roadmap
Of course! Here's how I would revise your CHANGELOG.md to look more professional, while keeping the same information:

- [x] Syntax highlighting (colorization)
- [x] Commenting blocks of code
- [x] [Bracket matching (Ctrl+Shift+\)](https://code.visualstudio.com/docs/editor/editingevolved#_bracket-matching)
- [ ] [Folding (Ctrl+Shift+\[)](https://code.visualstudio.com/docs/editor/codebasics#_folding)
- [ ] [Go to Definition (F12)](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-definition)
- [ ] [Find All References (Shift+F12) / Peek Definition (Alt+F12)](https://code.visualstudio.com/docs/editor/editingevolved#_peek)
- [x] [Rename symbol (F2)](https://code.visualstudio.com/docs/editor/editingevolved#_rename-symbol)
- [ ] [Formating (Shift+Alt+F)](https://code.visualstudio.com/docs/editor/codebasics#_formatting)
- [ ] [Commands (Compile to tmLanguage)](https://code.visualstudio.com/docs/editor/tasks)
- [ ] [IntelliSense - List Members](https://code.visualstudio.com/docs/editor/intellisense)
- [ ] [IntelliSense - Complete Word](https://code.visualstudio.com/docs/editor/intellisense)
---

Features that have a check mark are complete.
# EBNF Tools Changelog and Roadmap

# Change log
This document outlines the changes made in each released version of the EBNF Tools extension for Visual Studio Code, as well as our roadmap for future features.

These are the changes to each version that has been released
on the official Visual Studio Code extension gallery.
## Roadmap

## 1.1
Our development roadmap outlines the planned features for EBNF Tools. Features marked with a check mark have already been implemented.

**2023-06-17**
- [x] **Syntax highlighting (colorization)**: Adds color to your EBNF syntax.
- [x] **Syntax highlighting in Markdown fenced code blocks**: Allows you to include EBNF code in your Markdown files with the same colorization as in your .ebnf files.
- [x] **Commenting blocks of code**: Allows you to quickly comment out blocks of EBNF code.
- [x] **Bracket matching**: Aids in matching brackets in your EBNF code.
- [x] **Rename symbol**: Allows renaming of symbols throughout your EBNF code.
- [ ] **Code folding**: Hide sections of your EBNF code for easier reading and navigation.
- [ ] **Go to Definition**: Quickly navigate to the definition of a symbol in your EBNF code.
- [ ] **Find All References / Peek Definition**: Find every reference to a specific symbol in your EBNF code.
- [ ] **Formatting**: Automatically format your EBNF code to adhere to a specific style or standard.
- [ ] **Commands (Compile to tmLanguage)**: A planned command for compiling EBNF code to tmLanguage.
- [ ] **IntelliSense - List Members**: Get a list of members for a given symbol.
- [ ] **IntelliSense - Complete Word**: Automatically complete words as you type them.
- [ ] **Railroad diagram generation**: Generate railroad diagrams from your EBNF code for visualization and documentation purposes.

- [x] Rename symbol
- [x] Fix broken links to images

## 1.0
## Change Log

**2016-09-02**
The change log lists the updates for each version that has been released on the official Visual Studio Code extension gallery.

- [x] Syntax highlighting (colorization)
- [x] Commenting blocks of code
- [x] Bracket matching
### Version 1.2
**Released on 2023-06-19**

- Added support for syntax highlighting in Markdown fenced code blocks.

### Version 1.1
**Released on 2023-06-17**

- Introduced the Rename symbol feature.
- Fixed broken links to images.

### Version 1.0
**Released on 2016-09-02**

- Released initial version of the EBNF Tools extension, featuring syntax highlighting, code commenting, and bracket matching.
37 changes: 20 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,37 @@
# EBNF Tools for Visual Studio Code

The EBNF Tools adds language support for the [EBNF](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_Form) syntax notation to Visual Studio Code.
EBNF Tools is a Visual Studio Code extension that adds robust language support for the Extended Backus-Naur Form (EBNF) syntax notation. This tool is designed to enhance your EBNF development workflow, offering features such as syntax highlighting, bracket matching, symbol renaming, and more.

See the [changelog](CHANGELOG.md) for changes and roadmap.
For updates and future improvements, see the [changelog](https://github.com/igochkov/vscode-ebnf/blob/master/CHANGELOG.md).

## Features

- Syntax highlighting (colorization)
- Syntax highlighting in Markdown fenced code blocks
- Commenting blocks of code
- Bracket matching
- Rename symbol
The EBNF Tools extension currently offers the following features:

- **Syntax highlighting (colorization)**: Adds color to your EBNF syntax, making it easier to read and understand your code.

### Syntax highlighting (colorization)
![Syntax highlighting](https://raw.githubusercontent.com/igochkov/vscode-ebnf/master/docs/syntax-highlighting.png)

### Syntax highlighting in Markdown fenced code blocks
- **Syntax highlighting in Markdown fenced code blocks**: Allows you to include EBNF code in your Markdown files with the same colorization as in your .ebnf files.

![Syntax highlighting in Markdown fenced code blocks](https://raw.githubusercontent.com/igochkov/vscode-ebnf/master/docs/fenced-code-blocks.gif)

### Commenting blocks of code
- **Commenting blocks of code**: Quickly comment out blocks of EBNF code.

![Commenting blocks of code](https://raw.githubusercontent.com/igochkov/vscode-ebnf/master/docs/commenting-block.gif)

### Bracket matching
![Brace matching](https://raw.githubusercontent.com/igochkov/vscode-ebnf/master/docs/brace-matching.gif)
- **Bracket matching**: Easily match brackets and braces in your EBNF code.

![Bracket matching](https://raw.githubusercontent.com/igochkov/vscode-ebnf/master/docs/brace-matching.gif)

### Rename symbol
![Rename symbol](https://raw.githubusercontent.com/igochkov/vscode-ebnf/master/docs/rename-symbol.gif)
- **Rename symbol**: Rename symbols throughout your EBNF code.

## Contribute
Check out the [contribution guidelines](https://raw.githubusercontent.com/igochkov/vscode-ebnf/master/CONTRIBUTING.md) if you want to contribute to this project.
![Rename symbol](https://raw.githubusercontent.com/igochkov/vscode-ebnf/master/docs/rename-symbol.gif)

## Contributing

We welcome contributions to the EBNF Tools project. If you want to contribute, please first read our [contribution guidelines](https://github.com/igochkov/vscode-ebnf/blob/master/CONTRIBUTING.md).

## License
[MIT](LICENSE)

This project is licensed under the terms of the [MIT](LICENSE) license.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "vscode-ebnf",
"displayName": "EBNF Tools",
"description": "EBNF Tools for Visual Studio Code",
"version": "1.1.0",
"version": "1.2.0",
"publisher": "igochkov",
"author": {
"name": "Ivaylo Gochkov",
Expand Down

0 comments on commit 980dad7

Please sign in to comment.