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.

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

USWDS-Site - Feature: Enable prettier on Markdown #2868

Open
2 tasks done
mejiaj opened this issue Oct 10, 2024 · 4 comments · May be fixed by #3120
Open
2 tasks done

USWDS-Site - Feature: Enable prettier on Markdown #2868

mejiaj opened this issue Oct 10, 2024 · 4 comments · May be fixed by #3120
Assignees
@mejiaj @cathybaptista
Labels
Affects: Linting Relates to code linting Type: Feature Request New functionality

Comments

@mejiaj
Copy link
Contributor

mejiaj commented Oct 10, 2024 •
edited
Loading

Is your feature request related to a problem? Please describe.

We're ignoring markdown files and that can cause inconsistencies and errors when writing MD/Frontmatter.

Example: 1c6453d

Describe the solution you'd like

  1. Remove markdown from .prettierignore.

    uswds-site/.prettierignore

    Line 21 in c719f79

    *.md
  2. Create two new NPM script to check & fix.
  3. Create CI test for linting and formatting.
  4. Fix issues.

Describe alternatives you've considered

Only run prettier in a specific directory to avoid a ton of file changes.

Additional context

See #2868 (comment).

Code of Conduct
@mejiaj mejiaj added the Type: Feature Request New functionality label Oct 10, 2024
@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label Oct 10, 2024
@mejiaj mejiaj mentioned this issue Oct 10, 2024
Closed
2 tasks
@mejiaj mejiaj added the Affects: Linting Relates to code linting label Oct 16, 2024
@amyleadem amyleadem added the Type: Spike A short research activity to help make a decision label Oct 24, 2024
@amyleadem
Copy link
Contributor

amyleadem commented Oct 24, 2024 •
edited
Loading

Next steps:

  • Evaluate the impact of turning on prettier. Check if it breaks anything. Report back on expected LOE.

Note: We should be careful to check pages like Maturity model and Design principles, since they are indicated in the git blame for the prettierignore.

@amyleadem amyleadem removed the Status: Triage We're triaging this issue and grooming if necessary label Oct 24, 2024
@brunerae brunerae moved this to Scheduled in USWDS Core Project Data Nov 4, 2024
@mejiaj mejiaj mentioned this issue Nov 19, 2024
Merged
@cathybaptista cathybaptista moved this from Scheduled to In progress in USWDS Core Project Data Dec 27, 2024
@cathybaptista cathybaptista added this to the uswds 3.12.0 - Jan 2025 milestone Jan 27, 2025
@cathybaptista cathybaptista moved this from In progress to TBD in USWDS Core Project Data Jan 27, 2025
@cathybaptista cathybaptista moved this from TBD to In progress in USWDS Core Project Data Jan 27, 2025
@amyleadem amyleadem removed this from the uswds 3.12.0 - Jan 2025 milestone Jan 29, 2025
@amyleadem amyleadem mentioned this issue Jan 29, 2025
Closed
@cathybaptista cathybaptista moved this from In progress to Peer Review in USWDS Core Project Data Feb 3, 2025
@mejiaj mejiaj moved this from Peer Review to In progress in USWDS Core Project Data Feb 4, 2025
@mejiaj mejiaj removed Added during Sprint Type: Spike A short research activity to help make a decision labels Feb 4, 2025
@mejiaj
Copy link
Contributor Author

mejiaj commented Feb 4, 2025

Removed outdated labels. We've already researched, discussed solutions, and started solutioning.

@mahoneycm mahoneycm moved this from In progress to On deck in USWDS Core Project Data Feb 7, 2025
@mejiaj mejiaj moved this from On deck to In progress in USWDS Core Project Data Feb 10, 2025
@dct2023 dct2023 assigned mejiaj and unassigned cathybaptista Feb 10, 2025
@mejiaj mejiaj linked a pull request Feb 20, 2025 that will close this issue
Open
@mejiaj mejiaj moved this from In progress to Peer Review in USWDS Core Project Data Feb 20, 2025
@mejiaj mejiaj removed their assignment Feb 20, 2025
@mejiaj
Copy link
Contributor Author

mejiaj commented Feb 20, 2025

I've scoped this to only run on a11y pages and data for now.

We should scope the work to address all markdown fixes and take care of any potential issues with Kramdown formatting and prettier, like noted in PR #3120.

@mejiaj
Copy link
Contributor Author

mejiaj commented Feb 20, 2025

@cathybaptista passing it to you for review.

@cathybaptista cathybaptista moved this from Peer Review to In progress in USWDS Core Project Data Feb 24, 2025
@amyleadem amyleadem assigned mejiaj and unassigned amyleadem Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mejiaj mejiaj

@cathybaptista cathybaptista

Labels
Affects: Linting Relates to code linting Type: Feature Request New functionality
Projects
USWDS Core Project Data
Status: In progress
Milestone
No milestone
4 participants
@mejiaj @amyleadem @RachelCorsino @cathybaptista