summaryrefslogtreecommitdiff
path: root/vscode/README.md
blob: e80f3d90679a30757c4d96acfa2f752a6a0fc5a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# AtLang VSCode Extension

A Visual Studio Code extension providing syntax highlighting and basic language support for **AtLang (@)**.

---

## Features

- **Syntax Highlighting**  
  Colors and styles for AtLang keywords, variables, strings, etc.

- **Basic Snippets (Coming Soon)**  
  Quick insertion of common AtLang constructs, like environment variable assignments and print statements.

- **Inline Diagnostics (Coming Soon)**  
  Planned support for catching simple syntax errors (e.g., missing braces or quotes).

- **IntelliSense (Coming Soon)**  
  Possible future expansion for auto-completions and symbol suggestions.

---

## Requirements

- **Visual Studio Code** (latest recommended).  

> **Note:** This extension is only for editing/authoring AtLang code, not for running it directly in VSCode.

---

## Extension Settings

No user-configurable settings yet. Future versions might include:

- Toggle advanced highlighting features.  
- Enable or disable code diagnostics.  

---

## Known Issues

- **Limited Grammar Coverage**  
  AtLang's full grammar is not yet implemented. This means some valid constructs might not be highlighted properly.  
- **No Real-Time Error Reporting**  
  While simple syntax checks will come, we currently don't have an integrated parser or language server.  

---

## Installation

1. **Install from VSIX**  
   - Download the `.vsix` file for the AtLang extension.  
   - In VSCode, open the Extensions view (Ctrl+Shift+X or Cmd+Shift+X), click the "⋮" menu, then "Install from VSIX..." and select the `.vsix`.

2. **Reload**  
   - After installation, reload or restart VSCode to activate the extension.

3. **Open an AtLang File**  
   - Create or open a file with the `.at` extension.  
   - Syntax highlighting should be automatically applied.

---

## Contributing

If you have suggestions for additional AtLang features or want to help extend grammar coverage:

1. Clone the repository.  
2. Add or modify grammar rules in the `syntaxes/syntax.json` file (or equivalent).  
3. Submit pull requests or issues on the repo.  

---

## Release Notes

### 0.0.1
- Initial release
  - Syntax highlighting for keywords: `@if`, `@else`, `@print`, `getEnv`.
  - Basic highlighting for variables (`@VAR`).
  - String literal and punctuation (`{}`, `()`, etc.) coloring.

---

**Enjoy coding with `@` symbols all over the place!**