https://github.com/levenrok/zig-znippets

Zig Code Snippets for VSCode
https://github.com/levenrok/zig-znippets

snippets visual-studio-code vscode vscode-extension zig

Last synced: about 2 months ago
JSON representation

Zig Code Snippets for VSCode

• Host: GitHub
• URL: https://github.com/levenrok/zig-znippets
• Owner: levenrok
• License: mit
• Created: 2023-10-18T11:32:13.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-14T14:14:48.000Z (about 1 year ago)
• Last Synced: 2024-11-05T18:19:43.434Z (3 months ago)
• Topics: snippets, visual-studio-code, vscode, vscode-extension, zig
• Homepage: https://marketplace.visualstudio.com/items?itemName=levrotech.zig-znippets
• Size: 243 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![VSCode Extension](https://img.shields.io/badge/VSCode-Extension-blue)](https://marketplace.visualstudio.com/items?itemName=levrotech.zig-znippets)

[![Open-VSX Extension](https://img.shields.io/badge/Open--VSX-Extension-purple)](https://open-vsx.org/extension/levrotech/zig-znippets)

[![Create Release](https://github.com/levrotech/zig-znippets/actions/workflows/release.yaml/badge.svg)](https://github.com/levrotech/zig-znippets/actions/workflows/release.yaml)

# Znippets

This extension contains code snippets for Ziglang for [VSCode][code].

## Snippets

Below is a list of all available snippets and the triggers of each one. Snippets are categorized into the following 📑:

- Standard Library

- Variables

- Pointers

- Types

- Loops

These snippets also contain a helpful description that can further provide you with more information to help you code better 😎

Some snippets have not been added since ZLS provides an ergonomic and always updated version of them 💪

> **_NOTE:_**  The **⇥** means the `TAB` key.

### Standard Library

| Trigger  | Content | Preview |

| :-------: | ------- | -------- |

| `imstd⇥`   | import the standard library into the current scope | `const std = @import ("std");` |

| `writer⇥`   | add the writer to the standard output | `const stdout = std.io.getStdOut.writer();` |

### Variables

| Trigger  | Content | Preview |

| :-------: | ------- | -------- |

| `const⇥`   | declare a constant | `const name: type = ;` |

| `var⇥`   | declare a variable | `var name: type = ;` |

### Pointers

| Trigger  | Content | Preview |

| :-------: | ------- | -------- |

| `ptr⇥`   | declare a pointer | `const name_ptr: *type = &;` 
 `var name_ptr: *type = &;` |

| `ptrλ⇥`   | declare a pointer constants | `const name_ptr: *const type = &;` |

### Types

| Trigger  | Content | Preview |

| :-------: | ------- | -------- |

| `fn⇥`   | declare a function | `fn name() void {}` |

| `fn!⇥`   | declare a function with an error union type | `fn name() !void {}` |

| `pfn⇥`   | declare a public function | `pub fn name() void {}` |

| `pfn!⇥`   | declare a public function with an error union type | `pub fn name() !void {}` |

| `arr⇥`   | declare an array | `const name = [_]type{};` 
 `var name = [_]type{};` |

| `matrix⇥`   | declare a multidimensional array | `const name = [_][_]type{[_]u8{}};` 
 `var name = [_][_]type{[_]u8{}};` |

| `err⇥`   | declare an error set | `const Error = error {};` |

| `opt⇥`   | declare a optional | `const name: ?type = ;` 
 `var name: ?type = ;` |

| `enum⇥`   | declare an enum | `const Enum = enum {};` |

| `union⇥`   | declare an union | `const Union = union {};` |

| `struct⇥`   | declare a struct | `const Struct = struct {};` |

### Loops

| Trigger  | Content | Preview |

| :-------: | ------- | -------- |

| `while⇥`   | add a while loop | `while() : () {}` |

| `switch⇥`   | add a switch statement | `switch () {}` |

[code]: https://code.visualstudio.com/