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: Repository badges are out-of-date compared to the template #1088

Closed
3 tasks done
JoshuaKGoldberg opened this issue Dec 11, 2023 · 1 comment · Fixed by #1154
Closed
3 tasks done

🛠 Tooling: Repository badges are out-of-date compared to the template #1088

JoshuaKGoldberg opened this issue Dec 11, 2023 · 1 comment · Fixed by #1154
Assignees
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

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

Thanks to #1048, we see now that this repository has two bits of tooling that are different between its 🍎 actual files and 🍌 code templates (see Additional Info below for explanation of the emojis):

  • 🍎 Actual files: README.md has one set of badges:
    <a href="https://codecov.io/gh/JoshuaKGoldberg/create-typescript-app" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh/JoshuaKGoldberg/create-typescript-app/branch/main/graph/badge.svg"/></a>
    <a href="https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Code of Conduct: Enforced 🤝" src="https://img.shields.io/badge/code_of_conduct-enforced_🤝-21bb42" /></a>
    <a href="https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/LICENSE.md" target="_blank"><img alt="License: MIT 📝" src="https://img.shields.io/badge/license-MIT_📝-21bb42.svg"></a>
    <a href="https://github.com/sponsors/JoshuaKGoldberg" target="_blank"><img alt="Sponsor: On GitHub 💸" src="https://img.shields.io/badge/sponsor-on_github_💸-21bb42.svg" /></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" />
  • 🍌 Code templates: Slightly different code for those badges:
    for (const [badgeLine, existingMatcher] of [

The differences weren't very easy to spot until #1048. But now if we look at https://github.com/JoshuaKGoldberg/create-typescript-app/pull/1048/files#diff-952005694bbd0612d04baaa761118b04376a6664bef420537ab741f68968658b we can see that there are diffs. For example, note the alt text difference in the Code of Conduct badge:

-	<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Code of Conduct: Enforced 🤝" src="https://img.shields.io/badge/code_of_conduct-enforced_🤝-21bb42" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/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>

The 🍎 actual file badges are generally probably out of date compared to the 🍌 template files. Marking as accepting PRs to update the badges.

Additional Info

This repository is two things:

  • 🍎 An example of a working TypeScript repository, including builds, Knip, package publishing, and more tooling
  • 🍌 Code that can set up a new or existing repository using all of that repository tooling

For the most part, the repository's end-to-end test for --mode migration makes sure that the 🍎 actual files and 🍌 code templates stay the same. As in, if one changes, the other needs to have the same change as well. But per #546, there are some files that were missed in that test. We're only now able to verify that they're the same as of #1048. That PR is where this discrepancy was discovered.

@JoshuaKGoldberg JoshuaKGoldberg added type: bug Something isn't working :( area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! labels Dec 11, 2023
@JoshuaKGoldberg JoshuaKGoldberg added type: cleanup Tech debt or other code/repository cleanups and removed type: bug Something isn't working :( labels Dec 11, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 30, 2023
JoshuaKGoldberg added a commit that referenced this issue Dec 31, 2023
## PR Checklist

- [x] Addresses an existing open issue: fixes #1088
- [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

Standardizes README.md badges to have the emoji at the start because I
want them consistent and the npm version badge can't have the emoji
tacked on.

Streamlines them by removing the _sponsor_ and _style_ badges and
trimming the _code of conduct_ badge down to say _kept_ instead of
_enforced. This means they should all fit on one line in the npm site.

Also fixes a bug in `findExistingBadges` where matchers were being
re-created _then_ looped on, instead of re-created each instance of the
loop. `/g` regexp state matters!
Copy link

🎉 This is included in version v1.52.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.

1 participant