Skip to content

[JsLIGO][Formatter] Force hardline after each field of a compound structure, so a possible line comment does not absorb the next component

Christian Rinderknecht requested to merge rinderknecht@jsligo_line_comment into dev

Motivation and Context

The following code

export type xtzOp =
// @layout comb
{ amountToTransfer: nat, //in mutez
rollupAddress: address,
l2Type };

was wrongly pretty-printed as

export type xtzOp =
// @layout comb
{ amountToTransfer: nat, //in mutez rollupAddress: address, l2Type };

(the line comment captured the next field). With this MR we get instead:

export type xtzOp =
// @layout comb
{
  amountToTransfer: nat, //in mutez
  rollupAddress: address,
  l2Type
};

Description

Component

  • compiler
  • website
  • webide
  • vscode-plugin
  • debugger

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Performance improvement (non-breaking change that improves performance)
  • None (change with no changelog)

Changelog

Fixed a bug in pretty-printing JsLIGO record fields followed by line comments.

Checklist:

  • If a new syntax has been introduced, put a message on slack ligo-lsp
  • Changes follow the existing coding style (use dune @fmt to check).
  • Tests for the changes have been added (for bug fixes / feature).
  • Documentation has been updated.
  • Changelog description has been added (if appropriate).
  • Start titles under ## Changelog section with #### (if appropriate).
  • There is no image or uploaded file in changelog
  • Examples in changed behaviour have been added to the changelog (for breaking change / feature).
Edited by Christian Rinderknecht

Merge request reports