ALE v4.0.0

[w0rp]

Deprecated Features

• :ALEInfo' enhancements have led to some deprecations. See new features
  below. :ALEInfo -preview and more #3368
  • :ALEInfoToClipboard has been deprecated in favour of :ALEInfo -clipboard.

Removed Features / Breaking Changes

• golint has been removed, as it represents long ago been deprecated and
  frozen. Remove golint support #4535
• gometalinter has been removed, as it has been unsupported for a long time
  now. Remove gometalinter support #4534
• The minimum supported Neovim version is now 0.7.0, though ALE may still happen
  to work with Neovim versions lower than 0.7.0.
• ALE will no longer look for ve-py3 as a virtualenv directory by default. Maybe: Respect PEP 704 virtualenv path default #4481
• The old g:ale_linters_sh_shell_default_shell option has been removed,
  and users should use g:ale_sh_shell_default_shell instead.
• The ale_lsp_root option has been removed. Use ale_root instead.

New Features

• virtual-text has been greatly enhanced in many ways since the last version.
  • virtual-text highlights are styled to look like comments in code by default
    in compatible Vim versions, so they look very subtle when editing code. Use comment colors and characters as the default for virtual-text #4401
  • You can use let g:ale_python_auto_virtualenv = 1 to automatically update
    PATH based on Python virtualenv locations to run executables. Python: Automatically set virtualenv paths #2172
  • Better floating window borders are now used in Neovim. Fix #3616, #3903 - Use proper floating window borders in neovim #4417
  • virtual-text messages can be vertically aligned to be easier to read with
    g:ale_virtualtext_column and g:ale_virtualtext_maxcolumn. Virtualtext formatting and alignment fixes #4473
  • virtual-text can be configured to only show the first error with
    g:ale_virtualtext_single. Virtualtext formatting and alignment fixes #4473
    • This is now the default setting, as it makes editing files less annoying.
  • ALE now uses a defined order for virtualtext problems on a single line.
    • The most severe problems are shown first, such as errors instead of
      warnings.
    • If two problems lie on the same line and are equally severe, ALE shows
      the first problem by column position on the line.
  • ALE now uses a separate ale_signs group for signs as to not disturb
    virtual text messages which use the group ale. Use different group names for signs and virtual text #4704
• Floating previews are now closed when you leave a buffer or scroll. Fix #4408 - Trigger floating preview autocommand on BufWinLeave and W… #4409
• ALE now sends diagnostics to Neovim's diagnostics API by default in compatible
  versions of Neovim. diagnostics: support sending ALE output to Neovim's diagnostics API #4345 Display by Neovim diagnostics by default (where possible) #4442 Display by Neovim diagnostics by default (where possible) #4442 fix(neovim): ignore unrelated diagnostics #4597 feat: remove logic for unsupported older Neovim #4921
  • You use let g:ale_use_neovim_diagnostics_api = 0 to disable this
    behavior.
• In Vim 8.2.3874 and up numhl highlights are now supported. Support numhl highlights for vim >= 8.2.3874 #4578
• In supported Vim versions ALE uses the ModeChanged event instead of
  InsertLeave emulation with a timer to run linters when leaving insert mode,
  which is less buggy and more efficient. Possible fix for issue #4642: use ModeChanged events instead of InsertLeave emulation #4738
• ALE more efficiently fixes files in Neovim by using nvim_buf_set_lines. Improve ALEFix performance for neovim #3974
  • This avoids issues with Treesitter, but a known issue is this resets the
    jumplist and can disturb the cursor position. See Fixers + nvim + split windows causes jumps #4735.
• You can now automatically save changes to hidden buffers when LSP commands are
  run with let g:ale_save_hidden = 1.
• :ALEInfo has been supercharged with a new set of features. :ALEInfo -preview and more #3368
  • Permit :ALEInfo -clip as a shorthand for :ALEInfo -clipboard
  • Support :ALEInfo -preview to render in the preview window
  • Support :ALEInfo -echo for the classic :ALEInfo mode
  • Change the default mode to 'preview', and make it configurable. See:
    :h ale_info_default_mode.
  • Add syntax highlighting for :ALEInfo in preview mode.
  • Add a convenience to look up documentation that explains itself.
  • Don't show an empty Linter Variables section.
  • :ALEInfo no longer reports information about its own window. Prevent :ALEInfo from reporting info about its own preview window #4618
• ALE now defaults g:ale_disable_lsp to a new 'auto' mode. With this
  setting applied, ALE will now check for the presence of the nvim-lspconfig
  plugin and automatically turn off particular linters if already
  configured via nvim-lspconfig.
• ALE now has an ALEStopLSP command to stop all language servers with provided
  names so only specific language servers can be stopped with a command.
• When jumping to locations through :ALEGoTo... commands ALE will now present
  the user with a list of choices if more than one location is available. Implement listing all returned results for LSP textDocument/implements #4755
• ale#floating_preview#Show, while not officially supported as part of ALE's
  API, now returns the preview window ID so you can more easily work with it.
  Return floating_preview window id #4828
• Matched text now appears in quickfix for :ALEFindReferences -quicfix for
  tsserver. Add matched text to ALEFindReferences -quickfix for tsserver #4898
• If an ALE linter callback returns anything other than a List ALE will
  now silently treat the output as if it was an empty list. more defensive coding: guard against a non-iterable loclist #4912

New Linters

• Astro - eslint Add support for astro #4780, prettier Add support for astro #4780
• ASM - llvm-mc Add support for llvm-mc as an assembly linter #4446
• Bazel - buildifier feat: support Bazel buildifier linter #4529
• C - clangcheck Add clang-check linter for C #4662
• C3 - c3lsp Add support for c3-lsp linter #4836
• Cairo - sierra Update cairo linter to Cairo 1.0 #4530, scarb Add support for Scarb in cairo files #4669
• CSS - biome Add biome (ex. rome) support for javascript #4701 Add full support for biome #4705 fix(biome): use temp file instead of stdin #4775 fix(biome): send correct language to lsp proxy #4773 fix(biome): find root when using biome.jsonc #4774 fix(biome): update biome fixer supports css and graphql #4902
• Dockerfile - dockerlinter Dockerlinter #4518
• Elixir - lexical Add lexical for linting elixir projects #4580
• ERB - htmlbeautifier Add htmlbeautifier support #4751
• Gleam - gleamlsp Gleam: Support for gleam language server #4696, gleam format Gleam: Support 'gleam format' as fixer #4710
• Glimmer - embertemplatelint Add support for gjs template linting using embertemplate lint #4653
• GraphQL - biome Add biome (ex. rome) support for javascript #4701 Add full support for biome #4705 fix(biome): use temp file instead of stdin #4775 fix(biome): send correct language to lsp proxy #4773 fix(biome): find root when using biome.jsonc #4774 fix(biome): update biome fixer supports css and graphql #4902
• Groovy - npm-groovy-lint Add support for npm-groovy-lint #4495
• HTML - djlint Add support for the [djlinter](https://www.djlint.com/) #4909, eslint add eslint plugin html for linting js in html files #4428
• Hurl - hurlfmt Fix 4740 - add hurlfmt linter #4741
• JavaScript - biome Add biome (ex. rome) support for javascript #4701 Add full support for biome #4705 fix(biome): use temp file instead of stdin #4775 fix(biome): send correct language to lsp proxy #4773 fix(biome): find root when using biome.jsonc #4774
• JSON - biome feat(biome): add support for json and jsonc #4805 fix(biome): use temp file instead of stdin #4775 fix(biome): send correct language to lsp proxy #4773 fix(biome): find root when using biome.jsonc #4774
• Lua - lua-language-server f2a21c9
• Markdown - marksman feat(markdown): add marksman lsp #4565, pymarkdown Update: #4785 New tool pymarkdown added for markdown linting #4906
• Nix - deadnix Add deadnix linter #4443
• Odein - ols Adding support for Odin language server -- ols #4679
• Python - pycln add: pycln as a python linter and fixer #4415
• Ruby - packwerk Add support for Packwerk #4594, steep Add Ruby linter with Steep #4671
• TypeScript - biome Add biome (ex. rome) support for javascript #4701 Add full support for biome #4705 fix(biome): use temp file instead of stdin #4775 fix(biome): send correct language to lsp proxy #4773 fix(biome): find root when using biome.jsonc #4774
• Verilog - slang Slang linter for Verilog/SystemVerilog. #4713
• YAML - yq Add yq support #4861
• Yara - yls Yara yls support #4886

New Fixers

• Astro - eslint Add support for astro #4780, prettier Add support for astro #4780
• APKBUILD - apkbuild-fixer Implement support for apkbuild-fixer #4881
• Clojure - cljfmt Add cljfmt fixer for clojure files #4860
• CSS - biome Add biome (ex. rome) support for javascript #4701 Add full support for biome #4705 fix(biome): use temp file instead of stdin #4775 fix(biome): send correct language to lsp proxy #4773 fix(biome): find root when using biome.jsonc #4774 fix(biome): update biome fixer supports css and graphql #4902
• Erlang - erlang-mode Add erlang-mode fixer for Erlang files #4848, erlfmt Add erlfmt fixer to the registry and use it with stdin #4868
• Go - golangci-lint Add golangci-lint fixer #4853, gopls format 0af4899
• GraphQL - biome Add biome (ex. rome) support for javascript #4701 Add full support for biome #4705 fix(biome): use temp file instead of stdin #4775 fix(biome): send correct language to lsp proxy #4773 fix(biome): find root when using biome.jsonc #4774 fix(biome): update biome fixer supports css and graphql #4902
• Groovy - npm-groovy-lint Add support for npm-groovy-lint #4495
• HTML - rustywind Add support for rustywind fixer #4477
• Haskell - fourmolu Add fourmolu fixer #4501
• Hurl - hurlfmt Fix 4740 - add hurlfmt linter #4741
• JavaScript - biome Add biome (ex. rome) support for javascript #4701 Add full support for biome #4705 Fix biome formatter #4733 fix(biome): use temp file instead of stdin #4775 fix(biome): find root when using biome.jsonc #4774 fix!(biome): allow passing options to biome check #4799
• JSON - biome feat(biome): add support for json and jsonc #4805 fix(biome): use temp file instead of stdin #4775 fix(biome): find root when using biome.jsonc #4774 fix!(biome): allow passing options to biome check #4799
• Nickel - nickel format add: support for nickel format as Nickel fixer #4665
• Nix - alejandra Add alejandra for nix #4435
• OpenSCAD - scadformat Add scadformat fixer for OpenSCAD #4808
• Python - json.tool Add fixer for json: python's json.tool #4847, pycln add: pycln as a python linter and fixer #4415, ruff format Adding support for ruff formatter #4645
• Ruby - erb-formatter Adds erb-formatter support #4546, rubyfmt add: support for rubyfmt as ruby fixer #4678
• Solidity - forge Feature: add forge fmt as a fixer for Solidity files #4598
• TypeScript - biome Add biome (ex. rome) support for javascript #4701 Add full support for biome #4705 Fix biome formatter #4733 fix(biome): use temp file instead of stdin #4775 fix(biome): find root when using biome.jsonc #4774 fix!(biome): allow passing options to biome check #4799
• YAML - yamlfmt yamlfmt #4587, yq Add yq support #4861

Linter Enhancements

• The following changes have been make to update ALE for better linter
  compatibility in newer versions.
  • nix versions before 2.4 should be supported as well as newer versions. nix: durably handle versions before 2.4 #4398
  • The filename is made known to ruff in version 0.0.69 and up. fix(ale_linters: python: ruff): add --stdin-filename if version >= 0.0.69 #4414
  • ALE has been updated to run ruff with ruff check in versions 0.3.0 and
    up to make it compatible with those versions. Fix: ruff version 0.3.0 cli breaking changes #4732 Fix for ruff fixer for ruff version >=0.5.0 #4802
  • ALE now uses --no-fix with ruff check so it doesn't modify files when
    linting. fix: force --no-fix when ruff used as a linter #4759
  • ansible-lint has been patched to work with versions 6.11.0 and newer. Fix error from ansible-lint versions >=6.11.0. #4492
  • The VSCode JSON language server now works with newer versions that use the
    vscode-json-languageserver executable name instead of
    vscode-json-language-server. fix(json): update vscode json lsp name #4601
  • ALE has been updated to work with solhint versions newer than 3.4.0, as well
    as older versions. solhint >= 3.4.0 linter is broken #4499
  • ALE has been updated to work with newer ruff versions. Fix: Ruff output option #4632
  • ALE has been updated to work with newer phpmd versions. fix tempfile for phpmd, to be able to use phpmd 2.14.0 #4617
  • The volar linter has been updated to work with version 1.0, and uses the
    global executable by default, which is required for Volar to function
    properly. fix(vue): volar v1 support #4552
  • ALE now handles stylelint error messages from stderr as well as stdout.
    This makes ALE support newer as well as older versions. Stylelint linter output stream can go to stderr #4702
  • ALE now uses JSON output in shellcheck versions 0.7.0 and above for
    creating more accurate highlights for problems. Add end_col and end_lnum to ShellCheck #4692
  • ALE now supports sqlfluff 3.0.0 and up, in addition to older versions.
    Add support for sqlfluff 3.0.0 #4743
  • jq linter error message parsing has been updated to handle output
    from versions 1.6 and up. Fix linting with jq (#4765) #4862
  • phpstan will now set the memory limit more appropriately for newer
    versions. fix: memory-limit option for phpstan #4900
• phpstan will now set use the cwd to find the configuration file so
  configuration files are detected better. phpstan: set cwd to configuration file directory #4422
• phpstan filenames will now be mapped correctly so it matches files better
  when run from inside of Docker. Add file mapping to phpstan #4685
• pyright can now be automatically be run via poetry, pipenv, venv. Support for poetry and pipenv with pyright #4389
  Fix 4490 - Fix pyright not running with poetry #4491 Fix python linting/formatting error when in virtual environment #4865
• Python linters can now be run via uv. Improve support for python package manage: pipenv, poetry and uv #4825 Fix python linting/formatting error when in virtual environment #4865
• golangci-lint is no longer configured with --enable-all by default so it
  does not conflict with project configuration files and fail to run. remove --enable-all from golangci-lint options #4488
• golangci-lint is now enabled by default. feat: enable golangci-lint by default #4536
• golangci-lint now lints the package by default, as Go can implicitly
  reference symbols from other files. Fix 4586 - Make golangci-lint lint package on by default. #4730
• golangci-lint messages are now read from JSON output for more accurate
  parsing of linter output. Fix 4913 - use JSON output for golangci-lint instead of regexps. #4917
• bicep can now be run via Azure CLI via an az_bicep linter using the az
  command. Add support for Bicep when installed as a plugin to Azure CLI #4496
• The Ruby erb linter uses keyword arguments to avoid a deprecation warning
  and make it compatible with future Ruby versions. 🐛 Fix a Ruby deprecation warning in the ERB linter #4521
• cspell has been updated to highlight the whole word. Add end_col of matched forbidden word #4556
• The glsllang linter parsing has been updated to catch more errors. fixed parsing errors when certain options are used in glslangValidator #4540
• The xmllint linter has been updated to work on XML files that haven't been
  saved yet. Support format xml file which haven't yet persisted at the disk #4585 xmllint fixer must read from stdin - not buffer filename #4884
• ALE now runs actionlint on GitHub configuration files by default by
  searching upwards for a .github directory.
• actionlint now respects project configuration files by linting in the
  directory instead of a temporary location. fix(yaml): make actionlint respect config #4584
• actionlint will be run with an appropriate configuration file. When using actionlint look for & use a config file #4858
• actionlint now lints one file at a time via stdin instead of the whole
  directory. fix #4687 - only lint one file with actionlint instead of whole directory #4688
• ALE now correctly parses messages from actionlint sub-linters. Actionlint: correctly parse error line when using shellcheck sublinter #4689
• ALE now uses rust-analyzer by default for Rust instead of rls, which was
  previously deprecated. RLS for rust has been deprecated.  #4461
• If luacheck is run for a Lua file in &runtimepath then ALE automatically
  adds --globals vim so the linter is aware of Vim globals. This makes it
  easier to lint Vim plugins written in Lua without having to configure anything
  manually.
• .venv is the preferred project directory name for virtualenv directories for
  Python tools. Maybe: Respect PEP 704 virtualenv path default #4481
• Project file search for Haskell has been improved to find projects more
  reliably. Fix project file search for haskell hls #4541
• ruff now uses json-lines output for better error messages. Ruff use json-lines output format #4656
• When ruff throws errors, don't explode with errors in Vim. Ruff always raises E474: Unidentified byte and E474: Failed to parse bash on ALELint #4714
• chktex reports better highlight columns when tabs are used instead of
  spaces. Fix chktex highlighting wrong column when using tabs instead of spaces #4661 Fix chktex highlighting wrong column when using tabs instead of spaces #4727
• ALE now passes a language ID to cspell so it can more accurately lint files.
  Add language id option of CSpell #4700 Fix 4721 - force latex language id on cspell for tex filetype #4724
• ALE now links to the shellcheck wiki in detailed messages. Add wiki link to ShellCheck linting #4681
• ALE more reliably detects the project root for Erlang projects. Update project root detection for erlang_ls linter #4619
• The elvis linter for Erlang now sets the working directory correctly. Set working directory for Elvis linter #4726
• .eslintrc.cjs configuration files are now supported. Add support for .eslintrc.cjs #4742
• ESLint flag configuration files are supported via the filenames
  eslint.config.js, eslint.config.mjs, and eslint.config.cjs. feat: add support for ESLint's flat config format #4753
• ALE now respects the modern ESLint strategy for loading configuration files
  in nested project directories. Fix/eslint cwd strategy #4781
• cmake-lint is now passed the real filename so the .cmake-format
  configuration file can be read. Make cmake-lint read .cmake-format config file #4747
• php-cs-fixer arguments are now placed in their proper place so options can
  be correctly configured. Added fix subcommand options #4746
• The Scala metals default executable was incorrectly named as metals-vim,
  and this has been fixed to be metals now. Update metals.vim #4843
• You can now use erlang-ls to select the erlang_ls linter. Add erlang-ls as an alias for erlang_ls linter #4852
• sqlfluff error messages without end line or column numbers are now handled.
  Properly handle optional end_line_no/end_line_pos in sqlfluff #4867
• ALE now parses warnings from Zeek as well as errors. Surface warnings from Zeek linter #4883
• The search path is now set for iverilog to improve linting. iverilog current file search path #4907
• The Python black linter is now told where a file is with --stdin-filename.
  Python black doesn't respect ignored files in their config files #3406
• opa check now runs on the entire directory for more context. fix: run opacheck on entire dir for more context #4531

Fixer Enhancements

• The filename is made known to ruff in version 0.0.69 and up. fix(ale_linters: python: ruff): add --stdin-filename if version >= 0.0.69 #4414
• The syntax_tree fixer now formats files without creating temporary files.
  syntax_tree: no need to write and read temporary file #4834
• The stylua fixer now uses --stdin-filepath and sets the cwd to where
  the configuration file is. fix: stylua should have cwd and --stdin-filepath #4873 Fix cwd setting to use .stylua.toml if stylua.toml is not found #4892

Bugs Fixed

• virtual-text messages are now correctly cleared if you are actively working
  on changes to ALE code. (Only impacts ALE developers.) Vim virtual-text isn't cleared when ALE's lint cycle is finished #4399
• Fixed errors when using virtual-text but not error highlights. Misbehavior in python files with v3.3.0 #4400
• Line 0 problems are placed on line 1 for virtual-text. Infrequent Error: E966: Invalid line number: 0 #4331
• virtual-text messages will no longer trigger errors if a buffer is unloaded
  before ALE can show a message. Error after upgrade from v3.2.0 to v3.3.0 #4410
• virtual-text messages will no longer trigger errors when buffers are deleted.
  Error (Invalid buffer) with fzf-lua #4413
• virtual-text messages will now always be cleared when disabling ALE. Clear virtualtext no matter how enabled #4475
  Fix mismatched type on compare g:ale_virtualtext_cursor #4476
• The contents of a file passed to language servers when a file is saved have
  been fixed to use correct newlines. Erroneous text formatting upon LSP didSave #4455
• ALE wasn't telling language servers markdown text is supported and now does.
  Communicate support for markdown to the lsp server (#4450) #4453
• ALE had a bug that was around for some time where echoed error messages would
  break the user out of visual mode. This has been fixed. Don't echom if not in normal mode #4560
• Floating window support has been updated to work better in Neovim versions
  0.10 and up. floatwin: use win_execute in NeoVim for commands when it exists #4532
• ALE no longer errors when trying to load syntax highlights for a filetype
  we don't have highlights for. Fix error loading "text" syntax for hover #4574
• Environment variable quoting wasn't quite right on Windows, and has been
  fixed. ale#Env quoting bug on Windows #3115
• Leading spaces in Markdown code fences are now properly handled. "E484: Can't open file man syntax/ man.vim" error on symbol hover #4505
• Code fences without filetypes are handled properly now. [hover] ParseLSPResult sets language 'text' for missing spec #4699
• b:undo_ftplugin has been added to ALE's ftplugin files for special filetypes
  so the changes they make can be undone. add b:undo_ftplugin #4625
• The Elm language server configuration was broken and has been fixed so it runs
  correctly now. Fix E1085: Not a callable type: elm_ls#GetOptions #4707
• ALE now sets PATH and VIRTUAL_ENV correctly when
  ale_python_auto_virtualenv is used. fix ale_python_auto_virtualenv to correctly set virtualenv env vars #4885

---

This discussion was created from the release ALE v4.0.0.