Skip to content

feat(api-history): --check-descriptions #80

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Aug 9, 2024
Merged

feat(api-history): --check-descriptions #80

merged 5 commits into from
Aug 9, 2024

Conversation

@piotrpdev
Copy link
Contributor

@piotrpdev piotrpdev commented Aug 6, 2024

Resolves: #78

Throws error if description field is not surrounded by double quotation marks.

@dsanders11 @erickzhao @VerteDinde

@piotrpdev piotrpdev added ✨ enhancement New feature or request javascript Pull requests that update Javascript code labels Aug 6, 2024
@piotrpdev piotrpdev requested a review from a team as a code owner August 6, 2024 00:30
@piotrpdev piotrpdev changed the title feat(api-history): --check-descriptions feat(api-history): --check-descriptions Aug 7, 2024
@piotrpdev piotrpdev mentioned this pull request Aug 7, 2024
Merged
dsanders11
dsanders11 reviewed Aug 9, 2024
View reviewed changes
Copy link
Member

@dsanders11 dsanders11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good minus one comment about a continue statement.

Worth noting that this only allows for single-line quoted descriptions. In theory the user could provide a multi-line quoted description, but I think it's fine to only support single-line for now.

dsanders11
dsanders11 reviewed Aug 9, 2024
View reviewed changes
@piotrpdev @dsanders11
fix(api-history): description for loop
7fa70bd 
Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
Reference: #80 (comment)
@piotrpdev
Copy link
Contributor Author

piotrpdev commented Aug 9, 2024

@dsanders11 Worth noting that this only allows for single-line quoted descriptions. In theory the user could provide a multi-line quoted description, but I think it's fine to only support single-line for now.

https://stackoverflow.com/a/21699210

There are 5 6 NINE (or 63*, depending how you count) different ways to write multi-line strings in YAML.

I think I might leave that for someone else to figure out 😭

@dsanders11 dsanders11 merged commit dacce87 into main Aug 9, 2024
@dsanders11 dsanders11 deleted the feat/check-descriptions branch August 9, 2024 23:25
dsanders11 added a commit that referenced this pull request Aug 9, 2024
@piotrpdev @dsanders11
feat(api-history): --disallow-comments (#81)
3d87b7b 
* feat(api-history): `--check-descriptions`

Reference: #78 (comment)

* test(api-history): description test

* fix(api-history): only double quotes

* feat(api-history): `--disallow-comments`

Reference: #79

* feat(api-history): traverse tree instead

* fix(api-history): description `for` loop

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
Reference: #80 (comment)

* style(api-history): fix lint, leave comment

---------

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
@continuous-auth
Copy link

continuous-auth bot commented Aug 9, 2024

🎉 This PR is included in version 2.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dsanders11 dsanders11 dsanders11 approved these changes

Assignees

No one assigned

Labels

javascript Pull requests that update Javascript code released ✨ enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Enforce use of double quotation marks for descriptions in API History

3 participants

@piotrpdev @dsanders11