Changelog¶
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
0.10.2 - 2026-10-27¶
Added¶
- Add a changelog following the Keep a Changelog format.
- Add a configuration doc section for the language server settings.
- Add keywords to the package metadata.
- Document the
sshconfigfiletype in the Neovim integration page.
Changed¶
- Updated to Python 3.15, which is now the minimum supported version.
- Use
lazyimport keyword instead of importing within CLI function. - Ensure all URLs use HTTPS.
- Update prek hooks and dev dependencies.
- Use the official ty hook instead of a local hook.
- README intro have been cleaned.
Security¶
- Update uv to 0.13.5, fixing the eMudhra intermediate CA compromise.
0.10.1 - 2026-08-16¶
Added¶
sshls formatnow accepts multiple files.sshls formatnow prints how many files have been formatted or left unchanged.
0.10.0 - 2026-08-11¶
Added¶
- A
KeywordDefclass to define properties for each keyword.
Changed¶
- The
KeywordStrEnum class defined inlexer.pyhas been replaced by anEnuminkeywords.py. - Members of
Keywordare now UPPERCASE instead of CamelCase.
0.9.1 - 2026-08-10¶
Changed¶
- The "Bad configuration option" error has been renamed "E001". Its description has been changed to "The keyword
{keyword}is unknown.". - The "No argument after keyword" error has been renamed "E002".
0.9.0 - 2026-08-10¶
Added¶
- The server now publishes diagnostics (
textDocument/publishDiagnostics) when an SSH config file is opened or changed. - A new function
tokenize_with_errorsthat returns the caughtSSHConfigErrors alongside the tokens when applying the lexer. - For now, two errors are diagnosed:
- If an unknown keyword is used, send an error with the description "Bad configuration option:
{keyword}is unknown.". - If a keyword is alone on its line (i.e. without argument), send an error with the description "No argument after keyword.".
- The
KeywordArgTokennow takes an additionalline_numberfield to link to the file line number.
0.8.2 - 2026-08-10¶
Changed¶
- Keyword completion now works when the cursor is anywhere in the keyword (i.e. the first word of the line).
0.8.1 - 2026-08-07¶
Changed¶
- Completion for keywords is now enabled when other words are on the line.
0.8.0 - 2026-08-07¶
Added¶
textDocument/completioncapability added to the server for keywords.- Tests for exceptions raised on an invalid indent or separator when formatting.
0.7.7 - 2026-07-09¶
Fixed¶
- Arguments starting with
=are now quoted to preserve idempotency when formatting.
0.7.6 - 2026-06-27¶
Added¶
- CLI command
sshls versionto print the package version. - PyPI badge in the README.
- Idempotency tests for the parser and the formatter.
Changed¶
- Corrected CLI commands in the README.
- Use the PyPI package name in the README installation section.
0.7.5 - 2026-06-27¶
Changed¶
- Exceptions are now caught silently when formatting with the language server.
Fixed¶
- Fix CI package publishing by adding a PyPI token.
0.7.4 - 2026-06-27¶
Added¶
- A new argument
sort_directivesto disable sorting within blocks when formatting (enabled by default). - The package is now published to PyPI for each Git tag, through CI and the uv build system.
0.7.3 - 2026-06-27¶
Changed¶
- By default,
sshlsandsshls formatnow show help when run without arguments.
0.7.2 - 2026-06-22¶
Added¶
- Directives are now sorted within blocks if there is no standalone comment in the block.
0.7.1 - 2026-06-22¶
Changed¶
- Formatting no longer adds an extra empty line at the end of the file.
0.7.0 - 2026-06-19¶
Added¶
- The language server has been implemented with the pygls dependency.
textDocument/formattingcapability added to the language server.sshls serverlaunches the language server.
0.6.3 - 2026-06-16¶
Added¶
- Indent and keyword-argument separator are now options of the
sshls formatCLI. - Indent and keyword-argument separator defaults are now named
DEFAULT_INDENTandDEFAULT_SEPARATORconstants.
0.6.2 - 2026-06-15¶
Added¶
- Type alias
SSHBlockfor the union of the three config blocksGlobalBlock,HostBlockandMatchBlock.
Changed¶
- Replaced the
forloop in syntax tree formatting with a list comprehension.
0.6.1 - 2026-06-15¶
Added¶
- Formatting removes blocks if they are empty (i.e. without directives).
0.6.0 - 2026-06-15¶
Added¶
- A CLI has been created through the
sshlsinterface, implemented with the typer dependency. - Formatting is available in the CLI with the
sshls formatcommand. sshls serveris reserved for the language server, to be implemented.
0.5.0 - 2026-06-14¶
Added¶
- The formatter has been implemented, used through the
format_treefunction. - Tests for the formatter.
0.4.0 - 2026-06-14¶
Added¶
Changed¶
- The tokenizer has been renamed lexer.
0.3.0 - 2026-06-05¶
Added¶
- The parser has been implemented, used through the
parsefunction. - Tests for the parser.
0.2.1 - 2026-05-29¶
Added¶
- Module docstring long description.
- CI has been added, with ruff check/format.
check-yamladded to prek hooks.- Documentation is published with pdoc through CI and added to the project URLs.
pdoc,ruffandtyhave been added as dev dependencies.
Changed¶
- The repository has been renamed
ssh-config-ls. pytesthas been moved from dependencies to dev dependencies.
0.2.0 - 2026-05-27¶
Added¶
- Add prek hooks:
check-toml,end-of-file-fixer, ruff formatting. - The tokenizer now consumes comments instead of discarding them.
Changed¶
- The
LineTokennamed type, representing a tokenized config line, has been replaced by the frozen dataclassKeywordArgToken, with an optional comment property.