Skip to content

Commit ea810b7

Browse files
authored
docs: use kcd-scripts Prettier config (#894)
* docs: install kcd-scripts Prettier config * docs: format with new Prettier config
1 parent af35066 commit ea810b7

File tree

86 files changed

+18079
-5224
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+18079
-5224
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+16-18
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,33 @@ about: Create a report to help us improve
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
9+
**Describe the bug** A clear and concise description of what the bug is.
10+
11+
**To Reproduce** Steps to reproduce the behavior:
1212

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
1513
1. Go to '...'
1614
2. Click on '....'
1715
3. Scroll down to '....'
1816
4. See error
1917

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
18+
**Expected behavior** A clear and concise description of what you expected to
19+
happen.
2220

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
21+
**Screenshots** If applicable, add screenshots to help explain your problem.
2522

2623
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
24+
25+
- OS: [e.g. iOS]
26+
- Browser [e.g. chrome, safari]
27+
- Version [e.g. 22]
3028

3129
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
3630

37-
**Additional context**
38-
Add any other context about the problem here.
31+
- Device: [e.g. iPhone6]
32+
- OS: [e.g. iOS8.1]
33+
- Browser [e.g. stock browser, safari]
34+
- Version [e.g. 22]
35+
36+
**Additional context** Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,16 @@ about: Suggest an idea for this project
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
**Is your feature request related to a problem? Please describe.** A clear and
10+
concise description of what the problem is. Ex. I'm always frustrated when [...]
1211

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
12+
**Describe the solution you'd like** A clear and concise description of what you
13+
want to happen.
1514

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
15+
**Describe alternatives you've considered** A clear and concise description of
16+
any alternative solutions or features you've considered.
1817

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
18+
**Additional context** Add any other context or screenshots about the feature
19+
request here.

.prettierrc.js

+1-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1 @@
1-
module.exports = {
2-
proseWrap: 'always',
3-
singleQuote: true,
4-
semi: false,
5-
trailingComma: 'es5',
6-
}
1+
module.exports = require('kcd-scripts/prettier')

.vscode/settings.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"editor.rulers": [
33
60, // try to keep examples this long
4-
80, // hard wrap
4+
80 // hard wrap
55
],
66
"files.associations": {
77
"*.md": "mdx"
8-
},
8+
}
99
}

CODE_OF_CONDUCT.md

+30-28
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,43 @@
55
In the interest of fostering an open and welcoming environment, we as
66
contributors and maintainers pledge to making participation in our project and
77
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, sex characteristics, gender identity and expression,
9-
level of experience, education, socio-economic status, nationality, personal
10-
appearance, race, religion, or sexual identity and orientation.
8+
size, disability, ethnicity, sex characteristics, gender identity and
9+
expression, level of experience, education, socio-economic status, nationality,
10+
personal appearance, race, religion, or sexual identity and orientation.
1111

1212
## Our Standards
1313

1414
Examples of behavior that contributes to creating a positive environment
1515
include:
1616

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
3333

3434
## Our Responsibilities
3535

3636
Project maintainers are responsible for clarifying the standards of acceptable
3737
behavior and are expected to take appropriate and fair corrective action in
3838
response to any instances of unacceptable behavior.
3939

40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, offensive, or harmful.
40+
Project maintainers have the right and responsibility to remove, edit, or reject
41+
comments, commits, code, wiki edits, issues, and other contributions that are
42+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
43+
contributor for other behaviors that they deem inappropriate, threatening,
44+
offensive, or harmful.
4545

4646
## Scope
4747

@@ -55,20 +55,22 @@ further defined and clarified by project maintainers.
5555
## Enforcement
5656

5757
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at [email protected]. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
58+
reported by contacting the project team at [email protected].
59+
All complaints will be reviewed and investigated and will result in a response
60+
that is deemed necessary and appropriate to the circumstances. The project team
61+
is obligated to maintain confidentiality with regard to the reporter of an
62+
incident. Further details of specific enforcement policies may be posted
63+
separately.
6364

6465
Project maintainers who do not follow or enforce the Code of Conduct in good
6566
faith may face temporary or permanent repercussions as determined by other
6667
members of the project's leadership.
6768

6869
## Attribution
6970

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
72+
version 1.4, available at
73+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
7274

7375
[homepage]: https://www.contributor-covenant.org
7476

README.md

+21-13
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,34 @@
1-
testing-library-docs
2-
--------------------
3-
1+
## testing-library-docs
42

53
<!-- prettier-ignore-start -->
64
[![Open Collective Sponsors and Backers][opencollective-badge]][opencollective]
75
[![All Contributors][allcontributors-badge]](#contributors)
86
[![Code of Conduct][coc-badge]][coc]
97
<!-- prettier-ignore-end -->
108

11-
Documentation site for [React Testing Library](https://github.com/testing-library/react-testing-library), [DOM Testing Library](https://github.com/testing-library/dom-testing-library), and [related projects](https://github.com/testing-library)
9+
Documentation site for
10+
[React Testing Library](https://github.com/testing-library/react-testing-library),
11+
[DOM Testing Library](https://github.com/testing-library/dom-testing-library),
12+
and [related projects](https://github.com/testing-library)
1213

1314
**https://testing-library.com**
1415

1516
**Build Status**:
1617

1718
[![Netlify Status][netlify-badge]][build]
1819

19-
[netlify-badge]: https://api.netlify.com/api/v1/badges/24366204-84ca-41e9-b573-2a64f0845e46/deploy-status
20+
[netlify-badge]:
21+
https://api.netlify.com/api/v1/badges/24366204-84ca-41e9-b573-2a64f0845e46/deploy-status
2022
[build]: https://app.netlify.com/sites/testing-library/deploys
2123
[opencollective]: https://opencollective.com/testing-library/
22-
[opencollective-badge]: https://img.shields.io/opencollective/all/testing-library.svg?label=opencollective%20backers&style=flat-square
23-
[allcontributors-badge]: https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square
24-
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
25-
[coc]: https://github.com/testing-library/react-testing-library/blob/main/CODE_OF_CONDUCT.md
24+
[opencollective-badge]:
25+
https://img.shields.io/opencollective/all/testing-library.svg?label=opencollective%20backers&style=flat-square
26+
[allcontributors-badge]:
27+
https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square
28+
[coc-badge]:
29+
https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
30+
[coc]:
31+
https://github.com/testing-library/react-testing-library/blob/main/CODE_OF_CONDUCT.md
2632

2733
This website was created with [Docusaurus](https://v2.docusaurus.io).
2834

@@ -69,8 +75,7 @@ For more information about docs, click [here](https://v2.docusaurus.io/docs)
6975

7076
## Editing an existing blog post
7177

72-
Edit blog posts by navigating to `blog` and editing the corresponding
73-
post:
78+
Edit blog posts by navigating to `blog` and editing the corresponding post:
7479

7580
`blog/post-to-be-edited.mdx`
7681

@@ -126,7 +131,8 @@ For more information about adding new docs, click
126131

127132
## Contributors
128133

129-
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
134+
Thanks goes to these wonderful people
135+
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
130136

131137
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
132138
<!-- prettier-ignore-start -->
@@ -355,4 +361,6 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
355361

356362
<!-- ALL-CONTRIBUTORS-LIST:END -->
357363

358-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
364+
This project follows the
365+
[all-contributors](https://github.com/all-contributors/all-contributors)
366+
specification. Contributions of any kind welcome!

blog/2019-03-17-code-blocks.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Multi-Framework Code Blocks
33
author: Alex Krolick
4-
authorURL: "http://github.com/alexkrolick"
4+
authorURL: 'http://github.com/alexkrolick'
55
---
66

77
Many of the code samples have been updated to include tabs to switch between

blog/2019-04-25-new-org.mdx

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
22
# prettier doesn't like how long this line is.: ""
33
# prettier-ignore: ""
4-
title: "Testing Library Updates: new release, github org, open collective, and twitter account"
4+
title:
5+
'Testing Library Updates: new release, github org, open collective, and
6+
twitter account'
57
author: Kent C. Dodds
6-
authorURL: "https://kentcdodds.com"
7-
authorImageURL: "https://avatars0.githubusercontent.com/u/1500684?s=120&v=4"
8+
authorURL: 'https://kentcdodds.com'
9+
authorImageURL: 'https://avatars0.githubusercontent.com/u/1500684?s=120&v=4'
810
---
911

1012
Hello friends! I'm pleased to announce the recent updates to the testing-library

0 commit comments

Comments
 (0)