ZigBrains/CHANGELOG.md

<!--
Changelog structure reference:
<<
## [Version]

### Type

#### Category
>>
"Type" is one of [Added, Changed, Deprecated, Removed, Fixed, Security]
"Category" should be something that can be quickly recognized by readers ("Highlighting", "Code Completion", "Folding", etc.)

"Type" ALWAYS follows the order in the list above
-->

# ZigBrains

## [Unreleased]

## [20.2.1]

### Fixed

- Zig
  - Lexer error when a zig file has a comment or multiline string at the end of file without trailing newline

## [20.2.0]

### Added

- Zig
  - Live template support

## [20.1.3]

### Added

- Project
  - `.zig-cache` directory added to autogenerated gitignore in the project generator

### Fixed

- Project
  - Zig Build tool window crashes when opening remote projects

## [20.1.2]

### Fixed

- Zig
  - Source file path highlighter made the terminal lag with some files
  - Non-terminating rule in lexer could make the editor hang

## [20.1.1]

### Fixed

- Zig
  - Unterminated string at the end of the file soft-locks the editor
  - Trailing commas in for loop parameters don't get parsed correctly

## [20.1.0]

### Added

- Zig
  - String, character literal, and `@"identifier"` quote matching

### Fixed

- Zon
  - Broken string quote handling

## [20.0.4]

### Fixed

- Renamed Zig new file task to "Zig File" and moved to the file creation group

## [20.0.3]

### Fixed

- Project
  - "Save all documents" hanging when trying to run a zig file

## [20.0.2]

### Added

- Zig
  - Escape sequence highlighting in char literals

### Changed

- Project
  - Direnv now only runs automatically in trusted projects
  - Toolchain autodetection is now done in the background on project load

### Fixed

- Zig
  - Unicode characters in char literals triggered an error

## [20.0.1]

### Fixed

- Project
  - IDE freezes when opening a zig project / doing zig init
  - Test tasks don't work and try to run the file as an executable

- Zig
  - Struct fields being styled as static fields instead of instance fields

## [20.0.0]

### Added

- Debugging
  - Progress indicator while zig is compiling the debuggable exe

### Changed

- The entire plugin has been re-implemented in Kotlin

### Fixed

- Most of the internals have been rewritten to be fully asynchronous, so freezes should happen way less

## [19.3.0]

### Added

- Toolchains, Run Configurations
  - [Direnv](https://github.com/direnv/direnv) support

### Fixed

- Zig
  - Missing description for string conversion intentions

## [19.2.0]

### Added

- Zig
  - Enter key handling in strings and multi line strings
  - Intentions for converting between multi line and quoted strings

### Fixed

- Zig
  - Multiline string language injections broke when editing the injected text

## [19.1.0]

### Added

- Zig
  - Language injections in strings
  - Syntax highlighting for escape sequences in strings

- LSP
  - Option to toggle inlay hints on/off
  - Compacted error{...} blocks in inlay hints

### Changed

- Runner
  - The process execution pipeline is now fully asynchronous
  - Error output is no longer redirected to standard output

### Fixed

- Debugger
  - Zig compilation will no longer cause IDE freezes
  - Debugging with GDB no longer causes internal IDE warnings
  - Debugging `zig run` configurations is now possible
- LSP
  - Rare error when checking LSP presence
  - No more error spam when zig or zls binary is missing

## [18.0.0]

### Added

- Zig
  - Labeled switch statements

### Changed

- LSP
  - Updated to LSP4IJ 0.7.0

## [17.3.0]

### Added

- Zig
  - Structure view

### Changed

- LSP
  - Updated to LSP4IJ 0.6.0

### Fixed

- Project
  - CLion will no longer prompt you to import zig projects as CMake

## [17.2.0]

### Added

- IDEA 2024.3 support

### Fixed

- Project
  - Safer standard library path resolution

## [17.1.0]

### Fixed

- Project
  - Relative paths in zig toolchain configuration would break the entire IDE

### Removed

- ZLS
  - Obsolete config options which are no longer used since migrating to LSP4IJ

## [17.0.0]

### Added

- Project
  - Zig Build integrated into an IDE tool window. Currently only supports running single steps, for more complex steps,
create a custom build configuration as before.

### Changed

- Project
  - Increased internal zig tool timeout to 10 seconds. Note that tasks don't have timeout, this is only used for
ZigBrains getting metadata about the compiler and the buildscript.

### Fixed

- Project
  - Toolchain working directory was not set when requesting compiler metadata

## [16.1.3]

### Changed

- Debugger (Windows)
  - MSVC debugger metadata download now requires consent from the user
  - Metadata download is now cached after the first fetch
  - Metadata download timeout has been set to 3 seconds, after which it reverts to the fallback file

## [16.1.2]

### Fixed

- Zig
  - Comptime struct fields not being parsed properly

## [16.1.1]

### Fixed

- Zig
  - Standard library override always auto-enabling
  - Better toolchain autodetect

- ZLS
  - Better language server autodetect

## [16.1.0]

### Added

- Zon
  - Support for .lazy dependency property
  - Comment/uncomment hotkey support

### Fixed

- Zon
  - More reliable autocomplete

## [16.0.0]

### Fixed

- Debugger
  - Added fallback metadata for windows debugger downloading
  - Automatic exe path discovery for zig build run debugging on windows

- Zig
  - Color settings has more accurate color preview text.
  - Better builtin indentation

### Changed

- LSP
  - Migrated to Red Hat's LSP4IJ LSP adapter.

## [15.2.0]

### Added

- Project
  - Modifying the standard library path now also applies to ZLS

## [15.1.1]

### Fixed

- Project
  - PTY emulation is now opt-in in run configurations

## [15.1.0]

### Added

- Project
  - PTY emulation for non-debug runs. Fixes colored output in Ziglings.

## [15.0.3]

### Fixed

- Zig
  - More autocomplete fixes

## [15.0.2]

### Fixed

- Zig
  - Autocomplete not working when the caret is placed right after a "("

## [15.0.1]

### Fixed

- Zig
  - Trailing commas in struct initializers showed an error

## [15.0.0]

### Changed

- Debugging
  - Major update, debugging on linux now works outside CLion (confirmed working in RustRover, IDEA Ultimate)
  - Windows debugging has been made much more streamlined, user doesn't need to download random files manually anymore
(except the visual studio debugging sdk of course)
  - debugging support on macOS with LLDB
- Project
  - Updated new project templates to the latest Zig 0.13.0 init files

### Fixed

- Zig
  - Fixed inconsistent caret indenting for switches and function parameters
  - More robust highlighting when auto-formatting
  - Fixed multiple grammar errors

### Removed

- LSP
  - Notification spam about ZLS missing in non-zig projects

## [14.4.0]

### Fixed

- Zig
  - Fixed indentation to be more consistent with zig fmt
  - Code completion now works correctly on the first line in a file too

## [14.3.0]

### Added

- Project
  - Extra compiler arguments field for zig test/run tasks

### Fixed

- Debugging
  - The debugger no longer freezes the IDE while zig is compiling

- Project
  - Exe args for zig run not visible in the GUI

## [14.2.0]

### Added

- Zig
  - External Libraries support for zig stdlib

### Fixed

- Debugging (Windows)
  - Variables sometimes don't show up in the variable inspector when in breakpoint state

## [14.1.0]

### Fixed

- Debugging
    - Huge rework for starting the various debugging runs, and more robust compilation error visualization instead of a tiny
      popup

- LSP
  - No more notification popup about zig env not being detected when not in a zig projects.

- Project
  - ZLS should now be detected more reliably when creating new projects

## [14.0.1]

### Fixed

- Zig
  - If statements without a block always showed an error

## [14.0.0]

### Added

- LSP
  - The status widget now auto-hides itself when the selected editor is not a zig file in the current window

- Project
  - Completely overhauled the configuration system and the new project creation window. All the configs have been unified
  into a single screen, and project creation has been fully integrated as a mainline feature, instead of just a "nice to have".

### Changed

- LSP
  - The injection of the various language actions (Go to declaration/implementation, reformat, etc.) has been
  reimplemented from the ground up to be much more reliable and compatible in the presence of other languages and plugins.

- Zig, ZLS
  - The configurations have been unified into a single cohesive interface
  - Improved auto-detection for both Zig and ZLS

### Fixed

- LSP
  - Putting the caret on a diagnostics error now no longer highlights the whole file

- Project
  - Fixed invalid --colored command line argument for zig tasks

- Zig
  - More robust indentation logic, also works with semi-invalid syntax now

## [13.2.0]

### Added

- Debugging
  - For Zig build tasks, the target executable is now auto-detected in `zig-out/bin` if not specified.
  Autodetect fails if multiple executables are present for consistency's sake.
  - You can specify custom command line arguments for the debugged executable.

- Project
  - The line marker generated `zig build` now defaults to the `run` step.

### Changed

- Project
  - `zig build` steps are now specified separately from miscellaneous command line arguments.
  This is needed for the debugger to work properly.
  - The zig build debug executable target configs are now hidden from Zig build tasks in IDEs without native debugging support.
  - Native Application (Zig) is now hidden in IDEs without native debugging support.

### Fixed

- Debugging
  - Debugger locks up when trying to debug `zig build run` tasks.

## [13.1.1]

### Fixed

- Project
  - Creating new project throws a write access error when git is enabled

- Zig
  - Accidental regression while renaming the action IDs that broke "find usages"

## [13.1.0]

### Added

- Zig
  - Parameter info (CTRL + P) is now properly integrated
  - Parser error recovery (completion will still work even with missing semicolons in a statement)

### Fixed

- LSP
  - The registry IDs of some of the LSP handlers were colliding with the Rust intellij plugin
  - Autocompletion insertion is now fully handled by intellij, this should fix some of the weirdness

- Zig
  - Indent support for function parameters and struct initializers
  - Updated to latest grammar spec (https://github.com/ziglang/zig-spec/commit/78c2e2e5cfa7090965deaf631cb8ca6f405b7c42)

## [13.0.1]

### HOTFIX CHANGES
- Fixed multiple critical null safety problems that caused plugin crashes on some systems
- Splitting the editor now no longer breaks semantic highlighting

The rest of the 13.0.0 changes are available below:

### Added

- Debugging
  - Debugging support for tests when launched using the ZigTest task type (and with the gutter icons in the editor)
  - Debugging support on Windows systems

- Project
  - Added `zig init` as a new project creation option
  - New projects will now have the project name in the build files instead of "untitled"

- Zig
  - Updated semantic highlighting to latest ZLS protocol

- ZLS
  - ZLS configuration is now partially editable through the GUI

### Fixed

- Project
  - Fixed build.zig and build.zig.zon getting placed in src/ during project creation

- Plugin
  - Removed a bunch of write action locking, the editor should feel more responsive now

- Zig
  - Error highlighting was breaking all the time

### Removed

- Project
  - !!!BREAKING CHANGE!!! There is now no arbitrary "zig execution" task, all zig tasks have been categorized into Zig run/build/test tasks respectively.

## [12.0.0]

### Added

- Debugger
  - Now uses the toolchains you set in Settings | Build, Execution, Deployment | Toolchains
  - Standard library stack frames are now automatically filtered from the debug stack trace

- Zig
  - Go to Declaration/Usages now functions as expected, taking you to the declaration of a symbol instead of its resolved
    implementation.
  - For the time being, the "Quick Definition" (CTRL+Shift+I) action has been repurposed as Go To Definition. This will be
    replaced with a properly integrated solution once a way to couple the PSI symbol system and the LSP has been found.

### Fixed

- LSP
  - Diagnostics race condition
  - Code action annotations no longer lose range

- Zig
  - Syntax highlighting no longer breaks after refactoring or reformatting
  - Go to Usages no longer freezes the IDE

## [11.1.0]

### Changed

- Zig
  - Updated to latest language grammar (destructuring syntax)

## [11.0.0]

### Changed

- Zon
  - Updated autocompletion to latest as per the zig spec

- The versioning scheme used for ZigBrains has been revamped. See the plugin's GitHub repo for more information.

### Fixed

- Zig
  - Autocomplete now uses the LSP
  - Auto-indentation is now more accurate when creating new {...} blocks

- Zon
  - Fixed auto-indent for strings and comments

### Removed

- Zig
  - Code style settings. The official zig formatter is not configurable either, and ZigBrains aims to minimize
    divergence from any official or ZLS-supplied features where possible.

## [0.10.0]

### Added

- Zig
  - Code formatter and code style settings

### Fixed

- Project generation
  - Now actually populates the project directory with example files instead of just creating an empty directory

## [0.9.0]

### Added

- Zig
  - Commenter

- Zon
  - Can now parse the .paths attribute properly

### Changed

- Maximum compatible IDE version 232.* -> 233.*

### Fixed

- Dev env
  - nix jbr points to the correct path

- LSP
  - Crash in huge projects


## [0.8.1]

### Changed

- LSP
  - Dulled the colors of the status indicator, and added a gray "idle" color when ZLS is disconnected but not due to an error.

### Fixed

- Actions
  - Blocking other languages' run tasks
  - Files not autosaving before actions run

- Documentation
  - No longer breaks the documentation of other languages

- Editor
  - Race condition causing IllegalArgumentException

- LSP
  - Occasional NullPointerException when LSP returns blank data for inlay hints

## [0.8.0]

### Added

- Editor
  - Compatibility with 0.11 for loop ranges
  - Gutter icons for:
    - Launching a file with a `main` top level function
    - Launching a file with tests in it
    - Running `zig build` from a build.zig file

- Toolchain
  - Debugging Support


### Fixed

- Toolchain
  - Zig run configurations now save properly

## [0.7.0]

### Added

- Toolchain
  - Zig compiler toolchain integration and run actions (no debugging support yet, see the readme)
- Zig
  - Inlay hints
  - Breakpoints (CLion/IDEA Ultimate)
  - File creation prompt
- LSP
  - ZLS is now auto-detected on project startup from PATH
    - (You can also manually auto-detect it in the config menu)

### Changed

- Accessibility
  - The LSP status icon now has symbols in it instead of just colors:
    - Stopped(Red): X
    - Starting(Yellow): Refresh arrow
    - Started(Green): Empty

### Fixed

- LSP
  - NullPointerException in folding range provider when closing editors quickly
- Config
  - Changes to the ZLS configuration no longer require an IDE restart

## [0.6.0]

### Added

#### LSP
- Separate timeout category for syntax highlighting

#### Zig
- Basic "dumb" syntax highlighting when LSP is not connected
- Go to usages now works properly
- Color scheme preview now works properly
- Better "smart" syntax highlighting when LSP is connected
- Brace/Parenthesis/Bracket matching

### Fixed

#### Code Actions
- IDE no longer freezes when ZLS responds slowly


### Security

- Updated dependencies
- Integrated LSP4IntelliJ directly into ZigBrains

## [0.5.2]

### Fixed
- NullPointerException when clicking the red circle when the LSP is not connected

## [0.5.1] "Modernization"

### Added
- Proper documentation view (CTRL+Q) instead of the janky hover thing

### Removed
- IDEA 2022 support (Necessary change for the new documentation backend in lsp4intellij)

### Fixed
- Error highlighting now works on IDEA 2023

## [0.5.0] "The *ZON*iverse"

### Added

#### .zon files
- Basic parser and PSI tree
- Basic syntax highlighting
- Color settings page
- Brace and quote matching
- Code completion
- Code Folding
- Indentation

### Changed
- Updated the LSP backend, it should be more resilient now

## [0.4.0]

### Added

#### Error diagnostics (NEW)
- Basic diagnostics info from LSP (mostly just trivial syntax errors)

#### Code Folding
- Asynchronous folding (Enable it in the settings!)

### Fixed

#### Syntax Highlighting
- Made the logic even more asynchronous, should lead to much less UI stuttering

## [0.3.1]

### Added

#### Folding
- Better folding regions instead of just `{...}`
  - `...` for the general case
  - `///...` for doc comments

### Fixed

#### Folding
- Race condition on IDE startup throwing exceptions
- Folding ranges not appearing on Windows
- Typo in the bounds checking code

## [0.3.0]

### Added

#### Highlighting
- Support for Semantic Token Deltas (more compact way for the LSP server to send back data when typing fast)

#### LSP
- Temporary "increase timeout" toggle (currently, it bumps all timeouts to 15 seconds)

### Fixed

#### Folding
- Occasional NPE in LSP4IntellIJ

#### Highlighting
- Last token in file not getting highlighted

#### LSP
- (Windows) ZLS binary not executing if the file path has weird characters

## [0.2.0]

### Added
- Code completion
- Code folding
- More ZLS config options

## [0.1.0]

### Added
- Initial prototype. Lots of important stuff not yet implemented, but basic syntax highlighting and go to definition works.