Skip to content

Latest commit

 

History

History
121 lines (110 loc) · 5.48 KB

CHANGELOG.md

File metadata and controls

121 lines (110 loc) · 5.48 KB

Runic.jl 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.

v1.3.0 - 2024-12-17

Added

  • New executable wrapper script runic that can be put in PATH to simplify Runic invocation. This method should be preferred over a shell alias since it allows processes other than the shell to invoke Runic. Refer to the Installation section of the README for details.
  • New Git integration provided by the executable git-runic script (#122). This can be used to incrementally format a codebase by limiting formatting to changed and modified lines in each commit. Refer to the Git integration section of the README for installation and usage instructions.
  • New command line argument --verbose which enables verbose output (#121).
  • The library functions Runic.format_file and Runic.format_string are now considered part of the Runic public API and are marked with public in supported Julia versions. (#127).

Changed

  • Runic is now silent by default. Use --verbose to enable the verbose file progress printing from previous releases (#121).

Fixed

  • Improved the command line argument parsing to handle more edge cases related to input files and directories such as e.g. empty directories (#123).
  • Fix some error paths where the error would be printed before the file info output in --verbose mode (#124).

v1.2.0 - 2024-12-09

Added

  • New command line option --lines=a:b for limiting formatting to lines a to b. --lines can be repeated to specify multiple ranges (#114, #120).

v1.1.0 - 2024-12-04

Added

  • Added a suggested README badge to add to your project's README to show that you are using Runic (#108, #112). See the Badge section of the README for details.
  • Added a version policy to clarify what formatting changes are allowed in patch/minor/major releases. See the Version policy section of the README for details.

Changed

  • Fix a bug that caused "single space after keyword" to not apply after the function keyword in non-standard function definitions (#113). This bug is classified as a spec-bug and the fix will result in diffs like the following: 
    -function()
+function ()
     # ...
 end
  • Fix a bug that caused "single space after keyword" to not apply after let (#117). This bug is classified as a spec-bug and the fix will result in diffs like the following when let is followed by multiple spaces (which should be rare) in the source: 
    -let  a = 1
+let a = 1
     a
 end
  • Fix formatting of whitespace in between let-variables (#118). This bug is classified as a spec-bug and the fix will result in diffs like the following in rare cases where e.g. multiple spaces, or spaces before comma, is used in the variable list: 
    -let  a = 1,  b = 2
+let  a = 1, b = 2
     a + b
 end
  • Fix a bug that caused multiline variable blocks in let to not indent correctly (#97, #116). This bug is classified as a spec-bug and the fix will result in diffs like the following whenever multiline variable blocks exist in the source: 
     let a = 1,
-    b = 2
+        b = 2
     a + b
 end

v1.0.1 - 2024-11-28

Fixed

  • Fix an incorrect whitespace assertion in function indentation (#109, #110).

v1.0.0 - 2024-11-06

First stable release of Runic.jl. See README.md for details and documentation.