Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mborik/z80-macroasm-vscode

Support for Z80 macro-assemblers in Visual Studio Code
https://github.com/mborik/z80-macroasm-vscode

formatter intellisense problem-matcher syntax-highlighting visual-studio-code vscode vscode-extension z80 z80-assembly z80asm

Last synced: about 2 months ago
JSON representation

Support for Z80 macro-assemblers in Visual Studio Code

Host: GitHub
URL: https://github.com/mborik/z80-macroasm-vscode
Owner: mborik
License: mit
Created: 2018-03-25T10:59:07.000Z (almost 7 years ago)
Default Branch: main
Last Pushed: 2023-05-09T07:05:02.000Z (over 1 year ago)
Last Synced: 2023-08-19T15:23:29.655Z (over 1 year ago)
Topics: formatter, intellisense, problem-matcher, syntax-highlighting, visual-studio-code, vscode, vscode-extension, z80, z80-assembly, z80asm
Language: TypeScript
Homepage: https://marketplace.visualstudio.com/items?itemName=mborik.z80-macroasm
Size: 711 KB
Stars: 42
Watchers: 5
Forks: 10
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Support for Z80 macro-assemblers in Visual Studio Code

The **Z80 Macro-Assembler** extension for Visual Studio Code provides the following features inside VS Code:

* syntax highlighting for Z80 assembly sources of well known Z80 macro-assemblers, for example:

  - [SjASM](http://www.xl2s.tk/) or [SjASMPlus](https://github.com/z00m128/sjasmplus)

  - [Macroassembler AS](http://john.ccac.rwth-aachen.de:8000/as/)

  - [Pasmo](http://pasmo.speccy.org/)

  - [rasm](http://www.roudoudou.com/rasm/)

  - [tniASM](http://www.tni.nl/products/tniasm.html) (v0.x series)

* [problem matchers](#problem-matchers) for **SjASMPlus**, **Macroassembler AS**, **Pasmo**, **rasm** and **tniASM** compilation output

* label or symbol [defintion documentation](#definitions), suggestions on hover or typing

* macro documentation and argument definition suggestions

* semi-automatic [completition](#completion) with formatting

* [renaming](#renaming) of labels or symbols

* [formatting](#formatter) of block or whole document (experimental feature)

* snippets for macros and source control keywords

## ⚙️ Settings

These few options allows you to configure extension's behavior but primarily your code-formatting preferences and code completion:

- `z80-macroasm.files.exclude` - Choose files or directories to exclude _(e.g `'**/*.{lst}'`)_.

- `z80-macroasm.files.include` - Files to include and work with. If you, or your macro-assembler using a different conventions of source file extensions then change it here.

  > default: `"**/*.{a80,asm,inc,s}"`

- `z80-macroasm.seekSymbolsThroughWorkspace` - If true, extension will crawl through all your workspace files to document all symbols. Otherwise, only includes are taken into account.

  > default: `false`

### Formatter:

- `z80-macroasm.format.enabled` - Turn on the experimental feature of format on-type or on-save.

  > default: `false`

- `z80-macroasm.format.baseIndent` - How many tabstops you prefer before the instructions or keywords.

  > default: `2`

- `z80-macroasm.format.controlIndent` - How many tabstops you prefer before the control structure keywords, selections, modules, or blocks.

  > default: `1`

- `z80-macroasm.format.whitespaceAfterInstruction` - Which type of whitespace you want to put after the instruction - `"tab"`, `"single-space"` or `"auto"` which autodetect file's tabstop type and width.

  > default: `"auto"`

- `z80-macroasm.format.spaceAfterArgument` - If you want to put a single space character after comma (instruction's argument).

  > default: `false`

- `z80-macroasm.format.spaceAfterInstruction` - If you want to put a single space character after instruction (before colon separator).

  > default: `true`

- `z80-macroasm.format.spacesAroundOperators` - If you want to wrap an operators with spaces.

  > default: `false`

- `z80-macroasm.format.uppercaseKeywords` - If true, uppercase all keywords, instructions and registers. False means all lowercased and `"auto"` tries to auto-detect your code-style while typing.

  > default: `"auto"`

- `z80-macroasm.format.bracketType` - Define which type of brackets around the instruction's arguments (pointers) you prefer: `(round)` or `[square]`.

  > default: `"no-change"`

- `z80-macroasm.format.colonAfterLabels` - Put colon after each label or symbol (true or false, `"no-change"` keeps it untouched).

- `z80-macroasm.format.hexaNumberStyle` - Define which hexadecimal number format you prefer to reformat:

  >+ **"no-change"** - no reformat happen (default)

  >+ **"hash"**: `#1fff` | `#B45D`

  >+ **"motorola"**: `$1fff` | `$B45D`

  >+ **"intel"**: `1fffh` | `0B45Dh`

  >+ **"intel-uppercase"**: `1fffH` | `0B45DH`

  >+ **"c-style"**: `0x1fff` | `0xB45D`

- `z80-macroasm.format.hexaNumberCase` - When reformatting of hexadecimal numbers was enabled, whether it's to be additional case processing applied when `true` means uppercased, `false` lowercased.

  > default: `"no-change"`

- `z80-macroasm.format.suggestOnInstructions` - Extension will suggest also basic instruction mnemonics for the auto-completion, not only instruction arguments.

  > default: `false`

- `z80-macroasm.format.splitInstructionsByColon` - Split colon separated instructions to lines.

  > default: `true`

These keys/values can be used in your workspace or global `settings.json`.

[See example »»](https://github.com/mborik/z80-macroasm-vscode/wiki/settings.json)

## 🚨 Problem matchers

There are some predefined problem matchers to handle reported errors from compilation output:

- `errmatcher-as` for **Macroassembler AS**

- `errmatcher-sjasmplus` for **SjASMPlus**

- `errmatcher-sjasm` for **SjASM**

- `errmatcher-pasmo` for **Pasmo**

- `errmatcher-rasm` for **rasm**

- `errmatcher-tniasm` and `errmatcher-tniasm-preprocessor` for **tniASM**

These values can be used in `.vscode/tasks.json` of your project's build task.

[See example »»](https://github.com/mborik/z80-macroasm-vscode/wiki/tasks.json)

## 💡 IntelliSense showcase

### Symbol suggestions:

- provide symbols or labels

  - in current file in "Go to Symbol in File..." [`Ctrl+Shift+O`, `Cmd+Shift+O`]

  - in all includes in "Go to Symbol in Workspace..." [`Ctrl+T`, `Cmd+T`]

  - in Outline side-bar

### Definitions:

> ![Definitions](images/z80-macroasm-definition.png)

- Generated map of every symbol defined considers also modules or temporal labels:

> ![Peek Definition demo](images/z80-macroasm-definition-peek.gif)

- Show symbol's value or specific definiton on hover:

> ![Hover over symbol demo](images/z80-macroasm-hover.gif)

### Completion:

> ![Completion](images/z80-macroasm-completion.png)

- Inteligent completion of directives, pseudo-instructions, Z80 instructions, registers, labels or symbols:

> ![Completion demo](images/z80-macroasm-completion-demo.gif)

### Renaming:

- Allow to rename labels, local labels, module names or macro indetifiers in InteliSense meaning.

> ![Renaming demo](images/z80-macroasm-rename.gif)

## ⌨️ Credits

**Martin Bórik** is leading the development of this extension with some inspirations from these VS Code extensions:

- [`z80asm-vscode`](https://github.com/Imanolea/z80asm-vscode) by **Imanol Barriuso**

- [`vscode-pasmo`](https://github.com/BouKiCHi/vscode-pasmo) by **BouKiCHi**

- [`rgbds-vscode`](https://github.com/DonaldHays/rgbds-vscode) by **Donald Hays**

#### Contributors:

- [Romain Giot](https://github.com/rgiot)

- [Néstor Sancho](https://github.com/theNestruo)

- [Tomaz Kragelj](https://github.com/tomaz)

- [Alexander Kovalenko](https://github.com/alexanderk23)

- [Alexander Kolnogorov](https://github.com/kolnogorov)

## 📋 License

The Z80 Assembly extension is subject to [these license terms](LICENSE).

The source code to this extension is available on [github](https://github.com/mborik/z80-macroasm-vscode) and licensed under the [MIT license](LICENSE).