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

All Contributors should respect a .prettierrc if one is found #347

Closed
JoshuaKGoldberg opened this issue Dec 12, 2022 · 5 comments
Closed
Labels

Comments

@JoshuaKGoldberg
Copy link
Contributor

Describe the bug
I have a .prettierrc in a repo that indicates its .allcontributorsrc file should be formatted as JSON with tabs. But the allcontributors bot is still formatting it as JSON with two spaces.

See https://github.com/JoshuaKGoldberg/template-typescript-node-package/pull/99/files#diff-cb22095514d0cab1f755ae3a7902f7d64d10199da210fbd1eb2b29eb758b38d2

To Reproduce
Steps to reproduce the behavior:

  1. Create a new repo
  2. Create a .pretterrc file like https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/3b1bbc2b57a4ec40492d1e94814d3e48d9deb910/.prettierrc
  3. Set up allcontributors

Expected behavior
Prettier settings should be applied when formatting the file.

@Berkmann18
Copy link
Member

That's an excellent point, do you know of any project or have a PoC that respects .prettierrc?

@JoshuaKGoldberg
Copy link
Contributor Author

Yup, the repo linked in the OP uses Prettier for formatting files. It has an explicit override to ignore .all-contributorsrc because of this issue.

https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/129e4560bb966339ec5bf4b73741e07fb5b5262f/.prettierignore#L4-L5

@Berkmann18
Copy link
Member

That makes sense! Do you have an idea of how the bot could appropriately take it into account?

@JoshuaKGoldberg
Copy link
Contributor Author

In theory you can run npx prettier .all-contributorsrc --write and that'll pick up whatever Prettier config is checked into the repo (as long as the bot has done at least a shallow clone).

@Berkmann18
Copy link
Member

I see, so it seems like something that could be integrated into the CLI (especially since the bot uses it to an extent).

JoshuaKGoldberg pushed a commit to JoshuaKGoldberg/create-typescript-app that referenced this issue Sep 5, 2023
<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 💖.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [x] Addresses an existing open issue: fixes #801
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

<!-- Description of what is changed and how the code change does that.
-->
This PR is a fix for the all-contributors/cli#347 issue now being
resolved. Ignoring the `.all-contributorsrc` file in the
`.prettierignore` file is unnecessary. 😎
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants