EARS For Visual Studio Code

Using Alistair Mavin's EARS Syntax (Easy Approach to Requirements Syntax), this Visual Studio Code extension aids business and technical stakeholders write clear and unambiguous software requirements using everyday language. The documentation process is enhanced by features like syntax highlighting and automatic template generation (via snippets).

Features

Syntax Highlighting

• Automatically highlights EARS patterns and keywords to improve readability and focus.

Code Completion

• Use intelligent snippets to quickly insert EARS patterns, such as "When [trigger], the system shall [response]."

Markdown Compatible

• Use both EARS and Markdown syntax within the same document.

Installation

1. Open VS Code.
2. Go to the Extensions view by clicking the Extensions icon in the Activity Bar on the side of the window.
3. Search for EARS Syntax.
4. Click the Install button.

Usage

• Once installed, the syntax highlighting is automatically applied to .ears or .txt files where EARS requirements are written.

• To use code completion, start typing an EARS pattern and the snippet suggestions will appear. Simply select the desired snippet and it will auto-complete the sentence structure for you.

Configuration

No additional configuration is required to use this extension. However, you can modify your VS Code settings to better suit your needs.

Contributing

If you would like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcomed.

License

MIT License. See the LICENSE file for more details.

For any issues, suggestions, or updates, please create an issue or submit a pull request.