feat: add -v flag to display version

[xl4624]

PR Checklist

• Addresses an existing open issue: fixes 🚀 Feature: Add a --version CLI option #704
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

I was browsing the list of issues labeled good first issue and saw that issue #704 had its attached PR closed. The version feature has basically already been implemented, but this just adds the flag to display the version.

🧢

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (21c8529) 94.17% compared to head (3c59c29) 94.18%.
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1063   +/-   ##
=======================================
  Coverage   94.17%   94.18%           
=======================================
  Files          96       96           
  Lines        5564     5571    +7     
  Branches      446      448    +2     
=======================================
+ Hits         5240     5247    +7     
  Misses        323      323           
  Partials        1        1           

Flag	Coverage Δ
create	70.63% <50.00%> (-0.04%)	⬇️
initialize	41.83% <50.00%> (+<0.01%)	⬆️
migrate	69.80% <50.00%> (-0.04%)	⬇️
unit	72.06% <90.00%> (+0.03%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[JoshuaKGoldberg]

Looks like you're making good progress - and thanks for adding a test too! 🙌

Let me know if you need any help fixing up the last bits of complaints. https://github.com/JoshuaKGoldberg/create-typescript-app/blob/386bd14573d1ea1230e9adbe8436e935d7077c27/.github/DEVELOPMENT.md#development describes the things that are failing so far, and has a link at the top to a blog post too.

[xl4624]

I think I fixed it? The issue was that my PR wasn't updated to the changes from the upstream repository, right? I kind of messed up and had to git push --force

From the blog:

git checkout main
git pull upstream main
git push

Once I do this step to update my local/origin main, do I need to git checkout feature-branch and then git merge main to apply these changes to my feature branch?

[JoshuaKGoldberg]

Once I do this step to update my local/origin main, do I need to git checkout feature-branch and then git merge main to apply these changes to my feature branch?

Yup, exactly! Now that your main is in sync with the upstream's, those are the two commands that will merge in the commits from main to your feature branch.

Though, I think the lint errors are legit and not from some history weirdness. From the linked ❌ lint report:

/home/runner/work/create-typescript-app/create-typescript-app/src/bin/index.test.ts
Error:   6:1  error  Expected "./index.js" to come before "./packageJson.js"  perfectionist/sort-imports

The ESLint extension for your editor should be able to auto-fix that. Alternately, pnpm run lint --fix should do it for you.

[xl4624]

Ah I see 👀. I missed that when I was looking back at this PR, I just saw @codecov's report and thought it was just that my PR was not updated. Just ran pnpm run lint --fix

Although now that I'm looking at the pre-commit script, how come npx lint-staged doesn't run that automatically for any committed files?

[JoshuaKGoldberg]

Great question! There are two kinds of tools folks often run as precommit hooks:

• Formatters (e.g. Prettier): quickly reformat code to a standard preference
• Linters (e.g. ESLint): run a set of logical rules of various complexity levels

This repo template only runs Prettier as a commit hook. It doesn't run ESLint because:

• Some of the enabled lint rules use type information, which makes them slow. Slow commit hooks are annoying.
• Lint rules that use type info can introduce complaints in files that aren't touched by Git, so the commit hook might not catch everything anyway.

[JoshuaKGoldberg]

💯, perfect - thanks for this!

[JoshuaKGoldberg]

@all-contributors please add @xl4624 for code.

🤖 Beep boop! This comment was added automatically by all-contributors-auto-action.
Not all contributions can be detected from Git & GitHub alone. Please comment any missing contribution types this bot missed.
...and of course, thank you for contributing! 💙

[allcontributors]

@JoshuaKGoldberg

I've put up a pull request to add @xl4624! 🎉

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

[github-actions]

🎉 This is included in version v1.49.0 🎉

The release is available on:

• GitHub releases
• npm package (@latest dist-tag)

Cheers! 📦🚀