gauge-vscode icon indicating copy to clipboard operation
gauge-vscode copied to clipboard

Specfication formatting - moves comment metadata below specs

Open srizzling opened this issue 4 years ago • 3 comments

Describe the bug

When specifying comments like below

<!-- Space: testing -->
<!-- Title: test -->

When for you format the document, it moves the comments below the specification header like this

markdown-comments

I'm hoping that the metadata This is used to add metadata to specs.. which can then be processed by a internal tool to push to confluence / jira,

Is there anyway this behaviour in particular can be suppressed or ignored?

srizzling avatar Dec 17 '20 01:12 srizzling

This is a bug. Unfortunately there's no workaround for this at the moment.

zabil avatar Dec 17 '20 10:12 zabil

If I wanted to tackle this - where would I start?

srizzling avatar Dec 21 '20 05:12 srizzling

You could start by writing a test to cover this case at https://github.com/getgauge/gauge/blob/master/formatter/formatter_test.go

The test above invokes the formatter.

zabil avatar Dec 21 '20 08:12 zabil