feat: debugging in vs code

[johnnyreilly]

PR Checklist

• Addresses an existing open issue: fixes 🚀 Feature: ability to debug the running package code #1145
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

This PR enables debugging by adding a tasks.json

{
	"version": "2.0.0",
	"tasks": [
		{
			"type": "npm",
			"script": "build",
			"problemMatcher": [],
			"label": "build",
			"detail": "Build the project"
		}
	]
}

and the below configuration to the launch.json:

{
	// Use IntelliSense to learn about possible attributes.
	// Hover to view descriptions of existing attributes.
	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
	"version": "0.2.0",
	"configurations": [
		{
			"type": "node",
			"request": "launch",
			"name": "Debug Program",
			"skipFiles": ["<node_internals>/**"],
			"program": "lib/index.js",
			"preLaunchTask": "build"
		}
	]
}

Here's an example of debugging using it:

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (11ecd4a) 94.69% compared to head (001eb3e) 94.71%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1153      +/-   ##
==========================================
+ Coverage   94.69%   94.71%   +0.02%     
==========================================
  Files         102      102              
  Lines        5689     5719      +30     
  Branches      468      475       +7     
==========================================
+ Hits         5387     5417      +30     
  Misses        301      301              
  Partials        1        1              

Flag	Coverage Δ
create	70.15% <68.75%> (-0.11%)	⬇️
initialize	42.24% <0.00%> (-0.23%)	⬇️
migrate	69.87% <87.50%> (+0.05%)	⬆️
unit	74.84% <100.00%> (+1.01%)	⬆️

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.

[johnnyreilly]

I can see the migration test is failing: https://github.com/JoshuaKGoldberg/create-typescript-app/actions/runs/7365793330/job/20047430315?pr=1153

Error: 
Oh no! Running the migrate script modified some files:
 - .vscode/launch.json

That likely indicates changes made to the repository without
corresponding updates to templates in src/.

Please search for those file(s)' name(s) under src/migrate for
the corresponding template and update those as well.

I've looked but don't see anything:

I've read and re-read https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/DEVELOPMENT.md#the-migration-script but I'm a little lost as to how to update the snapshots. Is there a command to execute I'm missing?

[JoshuaKGoldberg]

Is there a command to execute I'm missing?

Yeah sorry, planning on documenting that soon: #1141. #1141 (comment) in the meantime for my personal workflow. And #1153 (comment) is the specific issue here.

[JoshuaKGoldberg]

Tried this out locally and it works, yay! But, questions on the design 🙂

[johnnyreilly]

Oh no! Running the migrate script modified some files:

• .vscode/launch.json

That likely indicates changes made to the repository without corresponding updates to templates in src/.

Please search for those file(s)' name(s) under src/migrate for the corresponding template and update those as well.

I'm a little at a loss as to what this error is asking me to do.

Please search for those file(s)' name(s) under src/migrate for the corresponding template and update those as well.

Looking here: https://github.com/JoshuaKGoldberg/create-typescript-app/tree/debug-code/src/migrate

I don't see a .vscode/launch.json file. And if I did I wouldn't know what to do to it to fix the test.

[johnnyreilly]

I do not like you lint_markdown, no I do not.

[johnnyreilly]

Is there any more to do on this PR @JoshuaKGoldberg? Don't make me send you a 🎂😆

[JoshuaKGoldberg]

D'oh, sorry! No cake needed (not that I'd say no to free food, of course). Just missed the notification. Looking now!

[JoshuaKGoldberg]

Yup this looks great, thanks! 🚀

Looks like the .github/DEVELOPMENT.md changes got merged out. But that's ok, we can take them on as a followup. They'll need to be dynamically constructed based on whether options.bin is provided.

Edit: #1217

[github-actions]

🎉 This is included in version v1.54.0 🎉

The release is available on:

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

Cheers! 📦🚀