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

USWDS-Site - Feature: Run prettier on accessibility tests, yml, and more #3120

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
15 changes: 15 additions & 0 deletions .circleci/config.yml
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Tip

Running separately gives us faster feedback and allows us to clearly see formatting failures.

Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,18 @@ jobs:
root: ~/project
paths:
- "node_modules"
lint_and_format:
executor: my-executor
steps:
- checkout
- attach_workspace:
at: ~/project
- run:
name: lint
command: npm run lint
- run:
name: format
command: npm run prettier
build:
executor: my-executor
steps:
Expand Down Expand Up @@ -131,6 +143,9 @@ workflows:
jobs:
- install_ruby_deps
- install_node_deps
- lint_and_format:
requires:
- install_node_deps
- build:
requires:
- install_ruby_deps
Expand Down
3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ Gemfile.lock
*.csv
*.html
*.md
*.min.js
!/**/accessibility-tests.md
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Tip

For now, only running on accessibility tests. Need to scope out work to get all markdown files formatted without visual regressions.

*.min.js
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Here are a few other utility commands you may find useful:

- `npm run lint`: Runs `eslint` and `sass-lint` against JavaScript and Sass files.

- `npm run prettier`: Runs prettier against SCSS, accessibility tests markdown, and YML in `_data`.

- `npm test`: Runs all tests and linters.

- `npm run watch`: Runs a series of commands that watches for any changes in both USWDS node module and the root level asset folders in this repo.
Expand Down
2 changes: 1 addition & 1 deletion _components/accordion/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Accordion accessibility tests
category: Components
lead: Any USWDS accordion should pass these manual accessibility tests.
changelog:
key: 'component-accordion-accessibility'
key: "component-accordion-accessibility"
---
6 changes: 3 additions & 3 deletions _components/alert/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/alert/accessibility-tests/
layout: accessibility-test
component:
name: Alert
name: Alert
title: Alert accessibility tests
category: Components
lead: Any USWDS alert component should pass these manual accessibility tests.
changelog:
key: 'component-alert-accessibility'
---
key: "component-alert-accessibility"
---
2 changes: 1 addition & 1 deletion _components/banner/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Banner accessibility tests
category: Components
lead: Any USWDS banner component should pass these manual accessibility tests.
changelog:
key: 'component-banner-accessibility'
key: "component-banner-accessibility"
---
2 changes: 1 addition & 1 deletion _components/breadcrumb/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Breadcrumb accessibility tests
category: Components
lead: Any USWDS breadcrumb should pass these manual accessibility tests.
changelog:
key: 'component-breadcrumb-accessibility'
key: "component-breadcrumb-accessibility"
---
4 changes: 2 additions & 2 deletions _components/button-group/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/button-group/accessibility-tests/
layout: accessibility-test
component:
name: button group
name: button group
title: Button group accessibility tests
category: Components
lead: Any USWDS button group component should pass these manual accessibility tests.
changelog:
key: 'component-button-group-accessibility'
key: "component-button-group-accessibility"
---
2 changes: 1 addition & 1 deletion _components/button/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Button accessibility tests
category: Components
lead: Any USWDS button should pass these manual accessibility tests.
changelog:
key: 'component-button-accessibility'
key: "component-button-accessibility"
---
6 changes: 3 additions & 3 deletions _components/card/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/card/accessibility-tests/
layout: accessibility-test
component:
name: card
name: card
title: Card accessibility tests
category: Components
lead: Any USWDS card component should pass these manual accessibility tests.
changelog:
key: 'component-card-accessibility'
---
key: "component-card-accessibility"
---
2 changes: 1 addition & 1 deletion _components/character-count/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Character count accessibility tests
category: Components
lead: Any USWDS character count component should pass these manual accessibility tests.
changelog:
key: 'component-character-count-accessibility'
key: "component-character-count-accessibility"
---
4 changes: 2 additions & 2 deletions _components/checkbox/guidance/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/checkbox/accessibility-tests/
layout: accessibility-test
component:
name: checkbox
name: checkbox
title: Checkbox accessibility tests
category: Components
lead: Any USWDS checkbox component should pass these manual accessibility tests.
changelog:
key: 'component-checkbox-accessibility'
key: "component-checkbox-accessibility"
---
2 changes: 1 addition & 1 deletion _components/collection/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Collection accessibility tests
category: Components
lead: Any USWDS collection component should pass these manual accessibility tests.
changelog:
key: 'component-collection-accessibility'
key: "component-collection-accessibility"
---
4 changes: 2 additions & 2 deletions _components/combo-box/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/combo-box/accessibility-tests/
layout: accessibility-test
component:
name: combo-box
name: combo-box
title: Combo box accessibility tests
category: Components
lead: Any USWDS combo box component should pass these manual accessibility tests.
changelog:
key: 'component-combo-box-accessibility'
key: "component-combo-box-accessibility"
---
4 changes: 2 additions & 2 deletions _components/date-picker/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/date-picker/accessibility-tests/
layout: accessibility-test
component:
name: date-picker
name: date-picker
title: Date picker accessibility tests
category: Components
lead: Any USWDS date picker component should pass these manual accessibility tests.
changelog:
key: 'component-date-picker-accessibility'
key: "component-date-picker-accessibility"
---
6 changes: 3 additions & 3 deletions _components/date-range-picker/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/date-range-picker/accessibility-tests/
layout: accessibility-test
component:
name: date-range-picker
name: date-range-picker
title: Date range picker accessibility tests
category: Components
lead: Any USWDS date range picker component should pass these manual accessibility tests.
changelog:
key: 'component-date-range-picker-accessibility'
---
key: "component-date-range-picker-accessibility"
---
2 changes: 1 addition & 1 deletion _components/footer/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Footer accessibility tests
category: Components
lead: Any USWDS footer component should pass these manual accessibility tests.
changelog:
key: 'component-footer-accessibility'
key: "component-footer-accessibility"
---
4 changes: 2 additions & 2 deletions _components/header/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/header/accessibility-tests/
layout: accessibility-test
component:
name: header
name: header
title: Header accessibility tests
category: Components
lead: Any USWDS header component should pass these manual accessibility tests.
changelog:
key: 'component-header-accessibility'
key: "component-header-accessibility"
---
4 changes: 2 additions & 2 deletions _components/icon-list/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/icon-list/accessibility-tests/
layout: accessibility-test
component:
name: icon list
name: icon list
title: Icon list accessibility tests
category: Components
lead: Any USWDS icon list component should pass these manual accessibility tests.
changelog:
key: 'component-icon-list-accessibility'
key: "component-icon-list-accessibility"
---
2 changes: 1 addition & 1 deletion _components/icon/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Icon accessibility tests
category: Components
lead: Any USWDS icon should pass these manual accessibility tests.
changelog:
key: 'component-icon-accessibility'
key: "component-icon-accessibility"
---
4 changes: 2 additions & 2 deletions _components/identifier/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Identifier accessibility tests
category: Components
lead: Any USWDS identifier component should pass these manual accessibility tests.
changelog:
key: 'component-identifier-accessibility'
---
key: "component-identifier-accessibility"
---
2 changes: 1 addition & 1 deletion _components/in-page-navigation/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: In-page navigation accessibility tests
category: Components
lead: Any USWDS in-page navigation component should pass these manual accessibility tests.
changelog:
key: 'component-in-page-navigation-accessibility'
key: "component-in-page-navigation-accessibility"
---
2 changes: 1 addition & 1 deletion _components/link/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Link accessibility tests
category: Components
lead: Any USWDS link should pass these manual accessibility tests.
changelog:
key: 'component-link-accessibility'
key: "component-link-accessibility"
---
4 changes: 2 additions & 2 deletions _components/list/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/list/accessibility-tests/
layout: accessibility-test
component:
name: list
name: list
title: List accessibility tests
category: Components
lead: Any USWDS list component should pass these manual accessibility tests.
changelog:
key: 'component-list-accessibility'
key: "component-list-accessibility"
---
4 changes: 2 additions & 2 deletions _components/memorable-date/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/memorable-date/accessibility-tests/
layout: accessibility-test
component:
name: memorable date
name: memorable date
title: Memorable date accessibility tests
category: Components
lead: Any USWDS memorable date component should pass these manual accessibility tests.
changelog:
key: 'component-memorable-date-accessibility'
key: "component-memorable-date-accessibility"
---
4 changes: 2 additions & 2 deletions _components/modal/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/modal/accessibility-tests/
layout: accessibility-test
component:
name: modal
name: modal
title: Modal accessibility tests
category: Components
lead: Any USWDS modal component should pass these manual accessibility tests.
changelog:
key: 'component-modal-accessibility'
key: "component-modal-accessibility"
---
4 changes: 2 additions & 2 deletions _components/process-list/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/process-list/accessibility-tests/
layout: accessibility-test
component:
name: process list
name: process list
title: Process list accessibility tests
category: Components
lead: Any USWDS process list component should pass these manual accessibility tests.
changelog:
key: 'component-process-list-accessibility'
key: "component-process-list-accessibility"
---
4 changes: 2 additions & 2 deletions _components/prose/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/prose/accessibility-tests/
layout: accessibility-test
component:
name: prose
name: prose
title: Prose accessibility tests
category: Components
lead: Any USWDS prose component should pass these manual accessibility tests.
changelog:
key: 'component-prose-accessibility'
key: "component-prose-accessibility"
---
4 changes: 2 additions & 2 deletions _components/radio-buttons/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/radio-buttons/accessibility-tests/
layout: accessibility-test
component:
name: radio buttons
name: radio buttons
title: Radio buttons accessibility tests
category: Components
lead: Any USWDS radio button should pass these manual accessibility tests.
changelog:
key: 'component-radio-buttons-accessibility'
key: "component-radio-buttons-accessibility"
---
4 changes: 2 additions & 2 deletions _components/search/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/search/accessibility-tests/
layout: accessibility-test
component:
name: search
name: search
title: Search accessibility tests
category: Components
lead: Any USWDS search component should pass these manual accessibility tests.
changelog:
key: 'component-search-accessibility'
key: "component-search-accessibility"
---
4 changes: 2 additions & 2 deletions _components/select/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Select accessibility tests
category: Components
lead: Any USWDS select component should pass these manual accessibility tests.
changelog:
key: 'component-select-accessibility'
---
key: "component-select-accessibility"
---
4 changes: 2 additions & 2 deletions _components/site-alert/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/site-alert/accessibility-tests/
layout: accessibility-test
component:
name: site alert
name: site alert
title: Site alert accessibility tests
category: Components
lead: Any USWDS site alert component should pass these manual accessibility tests.
changelog:
key: 'component-site-alert-accessibility'
key: "component-site-alert-accessibility"
---
4 changes: 2 additions & 2 deletions _components/step-indicator/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/step-indicator/accessibility-tests/
layout: accessibility-test
component:
name: step indicator
name: step indicator
title: Step indicator accessibility tests
category: Components
lead: Any USWDS step indicator component should pass these manual accessibility tests.
changelog:
key: 'component-step-indicator-accessibility'
key: "component-step-indicator-accessibility"
---
4 changes: 2 additions & 2 deletions _components/summary-box/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
permalink: /components/summary-box/accessibility-tests/
layout: accessibility-test
component:
name: Summary box
name: Summary box
title: Summary box accessibility tests
category: Components
lead: Any USWDS summary box component should pass these manual accessibility tests.
changelog:
key: 'component-summary-box-accessibility'
key: "component-summary-box-accessibility"
---
2 changes: 1 addition & 1 deletion _components/table/accessibility-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Table accessibility tests
category: Components
lead: Any USWDS table should pass these manual accessibility tests.
changelog:
key: 'component-table-accessibility'
key: "component-table-accessibility"
---
Loading