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

Auto-format markdown; switch to double quotes for JS #349

Merged
merged 2 commits into from
Dec 13, 2022

Conversation

sarayourfriend
Copy link
Collaborator

Fixes

Fixes #333 by @dhruvkb
Fixes #287 by @sarayourfriend

Description

See my rationale for the approach here: #333 (comment)

Notable, we want to have automated reflow of wrapped text so that writers can ignore it and write however they want. Having prose broken onto shorter lines allows more easily commenting on specific phrases when reviewing documents and discussions.

This also address the single quote issue with JavaScript linting. Naturally, this will create a massive diff in the frontend repository with the switch to double quotes.

I also fixed an issue with the _js_install recipe now that package.json has been moved to the top level of the repository.

Testing Instructions

Checkout the branch, run just install && just precommit && just lint and verify that there are no changes left.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • [N/A] I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@sarayourfriend sarayourfriend requested a review from a team as a code owner December 12, 2022 23:33
@openverse-bot openverse-bot added ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed 🤖 aspect: dx Concerns developers' experience with the codebase labels Dec 12, 2022
@sarayourfriend sarayourfriend changed the title Add/prettier line wrap prose Auto-format markdown; switch to single quotes for JS Dec 13, 2022
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

I think you meant double-quotes for JS!

I'm a bit undecided on prose-wrapping. I like it wrapped but I can see how people would like to wrap it to their preferred reading width and not inserting line-breaks in the text helps with that.

But other than that, I like the PR and wouldn't block it.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Great for consistency and commenting ease.

@sarayourfriend sarayourfriend changed the title Auto-format markdown; switch to single quotes for JS Auto-format markdown; switch to double quotes for JS Dec 13, 2022
@sarayourfriend
Copy link
Collaborator Author

I think you meant double-quotes for JS!

Whoops, yes, I did. Corrected the title, thanks.

I'm a bit undecided on prose-wrapping. I like it wrapped but I can see how people would like to wrap it to their preferred reading width and not inserting line-breaks in the text helps with that.

I understand where you are coming from. I find reading the wrapped prose difficult in the markdown itself, but given that it does not affect the rendering (which is available in the GitHub UI even on PR reviews), I am able to stomach it given the tremendous benefit it brings for commenting and discussion.

Thanks for the reviews folks.

@sarayourfriend sarayourfriend merged commit 1369d39 into main Dec 13, 2022
@sarayourfriend sarayourfriend deleted the add/prettier-line-wrap-prose branch December 13, 2022 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Run Prettier on Markdown files Unify formatting rules across languages
4 participants