Skip to content

Commit 95329bf

Browse files
fix: include Type Checking section in DEVELOPMENT.md (#765)
## PR Checklist - [x] Addresses an existing open issue: fixes #764 - [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 Adds it in, always.
1 parent e9fe495 commit 95329bf

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

src/steps/writing/creation/dotGitHub/createDevelopment.test.ts

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,21 @@ describe("createDevelopment", () => {
122122
This repository includes a [VS Code launch configuration](https://code.visualstudio.com/docs/editor/debugging) for debugging unit tests.
123123
To launch it, open a test file, then run _Debug Current Test File_ from the VS Code Debug panel (or press F5).
124124
125+
## Type Checking
126+
127+
You should be able to see suggestions from [TypeScript](https://typescriptlang.org) in your editor for all open files.
128+
129+
However, it can be useful to run the TypeScript command-line (\`tsc\`) to type check all files in \`src/\`:
130+
131+
\`\`\`shell
132+
pnpm tsc
133+
\`\`\`
134+
135+
Add \`--watch\` to keep the type checker running in a watch mode that updates the display as you save files:
136+
137+
\`\`\`shell
138+
pnpm tsc --watch
139+
\`\`\`
125140
"
126141
`);
127142
});
@@ -209,6 +224,21 @@ describe("createDevelopment", () => {
209224
This repository includes a [VS Code launch configuration](https://code.visualstudio.com/docs/editor/debugging) for debugging unit tests.
210225
To launch it, open a test file, then run _Debug Current Test File_ from the VS Code Debug panel (or press F5).
211226
227+
## Type Checking
228+
229+
You should be able to see suggestions from [TypeScript](https://typescriptlang.org) in your editor for all open files.
230+
231+
However, it can be useful to run the TypeScript command-line (\`tsc\`) to type check all files in \`src/\`:
232+
233+
\`\`\`shell
234+
pnpm tsc
235+
\`\`\`
236+
237+
Add \`--watch\` to keep the type checker running in a watch mode that updates the display as you save files:
238+
239+
\`\`\`shell
240+
pnpm tsc --watch
241+
\`\`\`
212242
"
213243
`);
214244
});

src/steps/writing/creation/dotGitHub/createDevelopment.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,5 +103,20 @@ This repository includes a [VS Code launch configuration](https://code.visualstu
103103
To launch it, open a test file, then run _Debug Current Test File_ from the VS Code Debug panel (or press F5).
104104
`
105105
}
106+
## Type Checking
107+
108+
You should be able to see suggestions from [TypeScript](https://typescriptlang.org) in your editor for all open files.
109+
110+
However, it can be useful to run the TypeScript command-line (\`tsc\`) to type check all files in \`src/\`:
111+
112+
\`\`\`shell
113+
pnpm tsc
114+
\`\`\`
115+
116+
Add \`--watch\` to keep the type checker running in a watch mode that updates the display as you save files:
117+
118+
\`\`\`shell
119+
pnpm tsc --watch
120+
\`\`\`
106121
`;
107122
}

0 commit comments

Comments
 (0)