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

🛠 Tooling: Lack of indentation in generated README.md all-contributors badge #1041

Closed
3 tasks done
JoshuaKGoldberg opened this issue Nov 17, 2023 · 2 comments · Fixed by #1054
Closed
3 tasks done
Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Nov 17, 2023

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

When you first --mode create a repository using create-typescript-app right now, if --base everything is specified, this is what the badges in the README.md roughly look like:

<p align="center">
	<!-- prettier-ignore-start -->
	<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<a href="#contributors" target="_blank"><img alt="All Contributors: 1 👪" src="https://img.shields.io/badge/all_contributors-1_👪-21bb42.svg" /></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
	<!-- prettier-ignore-end -->
	<a href="https://codecov.io/gh/asdf/asdf" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh/asdf/asdf/branch/main/graph/badge.svg"/></a>
	<a href="https://github.com/asdf/asdf/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a>
	<a href="https://github.com/asdf/asdf/blob/main/LICENSE.md" target="_blank"><img alt="License: MIT" src="https://img.shields.io/github/license/asdf/asdf?color=21bb42"></a>
	<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
	<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
	<img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42" />
</p>

The indentation situation was made better in #1038, but not completely perfect. Note the lack of indentation in the all-contributors <a ... and <!-- ALL-CONTRIBUTORS-BADGE:END --> lines. It would be nice if those two lines could be indented consistently with the rest of them...

  1. <a ...: probably a matter of updating the .all-contributorsrc badge template?
  2. <!-- ALL-CONTRIBUTORS-BADGE:END -->: I don't know and haven't looked into it much. Maybe a bug / feature request to file on allcontributors in some way? Maybe?

This is pretty low priority as it doesn't actually impact users. But if anybody is motivated and wants to take a look, I'd love to get this ironed out. 😄

Additional Info

Quick shell script I'm using to create a repo within the create-typescript-app project:

mkdir temp
cd temp
node ../bin/index.js --base everything --mode create --skip-github-api --title asdf --owner asdf --repository asdf --description asdf
@JoshuaKGoldberg JoshuaKGoldberg added area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups labels Nov 17, 2023
@jaas666
Copy link
Contributor

jaas666 commented Nov 24, 2023

I was able to find where to fix the href indentation and opened #1054 for it, but can't for the life of me find where the <!-- ALL-CONTRIBUTORS-BADGE:END --> is being changed.

My guess is that something somewhere is formatting the README.md. I was able to grab a clip showing the file being created correctly then the formatting applied. Hopefully this gives a clue as to where to look.

Recording.2023-11-24.093018.mp4

JoshuaKGoldberg added a commit that referenced this issue Nov 28, 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 #1041 
- [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.
-->
Fixes the indentation for the `href` in README.md 🤘

Co-authored-by: Josh Goldberg ✨ <[email protected]>
Copy link

github-actions bot commented Dec 1, 2023

🎉 This is included in version v1.48.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants