Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(formatter): preserve spaces at the head of comments #265

Conversation

Warashi
Copy link
Contributor

@Warashi Warashi commented Jun 26, 2023

This PR allows the formatter to preserve spaces at the beginning of comments.
Prior to this PR, the formatter would enforce comments to have a single space before the text, thereby removing the indentation of comment strings.

I have:

  • Added tests covering the bug / feature
  • Updated any relevant documentation

@coveralls
Copy link

Coverage Status

coverage: 88.607%. remained the same when pulling 6169548 on Warashi:feature/preserve-spaces-at-head-of-comments into fd040d1 on vektah:master.

@StevenACoffman StevenACoffman merged commit 35199fc into vektah:master Jun 26, 2023
5 checks passed
@Warashi Warashi deleted the feature/preserve-spaces-at-head-of-comments branch June 27, 2023 00:50
github-merge-queue bot pushed a commit to infratographer/x that referenced this pull request Jul 14, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[github.com/vektah/gqlparser/v2](https://togithub.com/vektah/gqlparser)
| require | patch | `v2.5.1` -> `v2.5.6` |

---

### Release Notes

<details>
<summary>vektah/gqlparser (github.com/vektah/gqlparser/v2)</summary>

###
[`v2.5.6`](https://togithub.com/vektah/gqlparser/releases/tag/v2.5.6)

[Compare
Source](https://togithub.com/vektah/gqlparser/compare/v2.5.5...v2.5.6)

#### What's Changed

- feat: support end of definition comment and end of file comment by
[@&#8203;Warashi](https://togithub.com/Warashi) in
[vektah/gqlparser#264
- feat(formatter): preserve spaces at the head of comments by
[@&#8203;Warashi](https://togithub.com/Warashi) in
[vektah/gqlparser#265

**Full Changelog**:
vektah/gqlparser@v2.5.5...v2.5.6

###
[`v2.5.5`](https://togithub.com/vektah/gqlparser/releases/tag/v2.5.5)

[Compare
Source](https://togithub.com/vektah/gqlparser/compare/v2.5.4...v2.5.5)

#### What's Changed

- feat: format with comments by
[@&#8203;Warashi](https://togithub.com/Warashi) in
[vektah/gqlparser#263

**Full Changelog**:
vektah/gqlparser@v2.5.4...v2.5.5

###
[`v2.5.4`](https://togithub.com/vektah/gqlparser/releases/tag/v2.5.4)

[Compare
Source](https://togithub.com/vektah/gqlparser/compare/v2.5.3...v2.5.4)

#### What's Changed

- feat(lexer): comment token support by
[@&#8203;Warashi](https://togithub.com/Warashi) in
[vektah/gqlparser#261

#### New Contributors

- [@&#8203;Warashi](https://togithub.com/Warashi) made their first
contribution in
[vektah/gqlparser#261

**Full Changelog**:
vektah/gqlparser@v2.5.3...v2.5.4

###
[`v2.5.3`](https://togithub.com/vektah/gqlparser/releases/tag/v2.5.3)

[Compare
Source](https://togithub.com/vektah/gqlparser/compare/v2.5.2...v2.5.3)

#### What's Changed

- Update modules by
[@&#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[vektah/gqlparser#259

**Full Changelog**:
vektah/gqlparser@v2.5.2...v2.5.3

###
[`v2.5.2`](https://togithub.com/vektah/gqlparser/releases/tag/v2.5.2)

[Compare
Source](https://togithub.com/vektah/gqlparser/compare/v2.5.1...v2.5.2)

#### What's Changed

- Add github actions to lint by
[@&#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[vektah/gqlparser#241
- GH Actions CI Additions + Linter fixups by
[@&#8203;philipaconrad](https://togithub.com/philipaconrad) in
[vektah/gqlparser#242
- Prefer to wrap third party errors by
[@&#8203;StevenACoffman](https://togithub.com/StevenACoffman) in
[vektah/gqlparser#243
- Remove a duplicate line in lexer_test.yml by
[@&#8203;ryicoh](https://togithub.com/ryicoh) in
[vektah/gqlparser#244
- Point to the right GraphQL spec by
[@&#8203;Khyme](https://togithub.com/Khyme) in
[vektah/gqlparser#250
- Bump json5 from 2.2.0 to 2.2.3 in /validator/imported by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[vektah/gqlparser#251
- support [@&#8203;defer](https://togithub.com/defer) directive by
[@&#8203;fiatjaf](https://togithub.com/fiatjaf) in
[vektah/gqlparser#255
- Don't drop repeatable keyword when formatting directive by
[@&#8203;tadeokondrak](https://togithub.com/tadeokondrak) in
[vektah/gqlparser#256
- Validate directive arguments during schema parsing by
[@&#8203;fredzqm](https://togithub.com/fredzqm) in
[vektah/gqlparser#258
- Validate enum values directive are legit by
[@&#8203;fredzqm](https://togithub.com/fredzqm) in
[vektah/gqlparser#257

#### New Contributors

- [@&#8203;ryicoh](https://togithub.com/ryicoh) made their first
contribution in
[vektah/gqlparser#244
- [@&#8203;Khyme](https://togithub.com/Khyme) made their first
contribution in
[vektah/gqlparser#250
- [@&#8203;fiatjaf](https://togithub.com/fiatjaf) made their first
contribution in
[vektah/gqlparser#255
- [@&#8203;tadeokondrak](https://togithub.com/tadeokondrak) made their
first contribution in
[vektah/gqlparser#256
- [@&#8203;fredzqm](https://togithub.com/fredzqm) made their first
contribution in
[vektah/gqlparser#258

**Full Changelog**:
vektah/gqlparser@v2.5.1...v2.5.2

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/infratographer/x).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMTAuMCIsInVwZGF0ZWRJblZlciI6IjM1LjE0MS4zIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants