Skip to content

Commit 6c15440

Browse files
dominicduffin1JoshuaKGoldberg
dominicduffin1
and
JoshuaKGoldberg
authored
feat: Add help cli (#775)
<!-- 👋 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 #703 - [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. --> I've added functionality to print to the terminal help documentation based on the existing docs when the `--help` or `-h` terminal flags are used. This will run in place of the functionality. I've marked this as a draft PR as I have a few questions so it is not yet complete, maybe you can assist @JoshuaKGoldberg : - What kind of test coverage would you be looking for for this functionality? - What is the best approach to fetch the version number? - I'm not clear what is meant by "running `parseargs`" to check for missing options (from the issue). Beyond that, is what I've included and how I've formatted the printout what you were expecting? --------- Co-authored-by: Josh Goldberg ✨ <[email protected]>
1 parent 8782106 commit 6c15440

8 files changed

+865
-61
lines changed

‎src/bin/help.test.ts

+336
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,336 @@
1+
import chalk from "chalk";
2+
import { SpyInstance, beforeEach, describe, expect, it, vi } from "vitest";
3+
4+
import { logHelpText } from "./help.js";
5+
6+
function makeProxy<T extends object>(receiver: T): T {
7+
return new Proxy(receiver, {
8+
get: () => makeProxy((input: string) => input),
9+
});
10+
}
11+
12+
vi.mock("chalk", () => ({
13+
default: makeProxy({}),
14+
}));
15+
16+
let mockConsoleLog: SpyInstance;
17+
18+
describe("logHelpText", () => {
19+
beforeEach(() => {
20+
mockConsoleLog = vi
21+
.spyOn(console, "log")
22+
.mockImplementation(() => undefined);
23+
});
24+
25+
it("logs help text when called", () => {
26+
logHelpText([
27+
chalk.yellow(
28+
"⚠️ This template is early stage, opinionated, and not endorsed by the TypeScript team. ⚠️",
29+
),
30+
chalk.yellow(
31+
"⚠️ If any tooling it sets displeases you, you can always remove that portion manually. ⚠️",
32+
),
33+
]);
34+
35+
expect(mockConsoleLog.mock.calls).toMatchInlineSnapshot(`
36+
[
37+
[
38+
"⚠️ This template is early stage, opinionated, and not endorsed by the TypeScript team. ⚠️",
39+
],
40+
[
41+
" ",
42+
],
43+
[
44+
"⚠️ If any tooling it sets displeases you, you can always remove that portion manually. ⚠️",
45+
],
46+
[
47+
" ",
48+
],
49+
[
50+
"
51+
A quickstart-friendly TypeScript template with comprehensive formatting,
52+
linting, releases, testing, and other great tooling built-in.
53+
",
54+
],
55+
[
56+
" ",
57+
],
58+
[
59+
"Core options:",
60+
],
61+
[
62+
"
63+
--base (string): Whether to scaffold the repository with:
64+
• everything: that comes with the template (recommended)
65+
• minimum: amounts of tooling, essentially opting out of everything
66+
• prompt: for which portions to exclude",
67+
],
68+
[
69+
"
70+
--create-repository: Whether to create a corresponding repository on github.com
71+
(if it doesn't yet exist)",
72+
],
73+
[
74+
"
75+
--description (string): Sentence case description of the repository
76+
(e.g. A quickstart-friendly TypeScript package with lots of great
77+
repository tooling. ✨)",
78+
],
79+
[
80+
"
81+
--mode (string): Whether to:
82+
• create: a new repository in a child directory
83+
• initialize: a freshly repository in the current directory
84+
• migrate: an existing repository in the current directory",
85+
],
86+
[
87+
"
88+
--owner (string): GitHub organization or user the repository is underneath
89+
(e.g. JoshuaKGoldberg)",
90+
],
91+
[
92+
"
93+
--repository (string): The kebab-case name of the repository
94+
(e.g. create-typescript-app)",
95+
],
96+
[
97+
"
98+
--title (string): Title Case title for the repository to be used in
99+
documentation (e.g. Create TypeScript App)",
100+
],
101+
[],
102+
[
103+
" ",
104+
],
105+
[
106+
"Optional options:",
107+
],
108+
[
109+
"
110+
--access (string): (\\"public\\" | \\"restricted\\"): Which npm publish --access to
111+
release npm packages with (by default, \\"public\\")",
112+
],
113+
[
114+
"
115+
--author (string): Username on npm to publish packages under (by
116+
default, an existing npm author, or the currently logged in npm user, or
117+
owner.toLowerCase())",
118+
],
119+
[
120+
"
121+
--directory (string): Directory to create the repository in (by default, the same
122+
name as the repository)",
123+
],
124+
[
125+
"
126+
--email (string): Email address to be listed as the point of contact in docs
127+
and packages (e.g. [email protected])",
128+
],
129+
[
130+
"
131+
--email-github (string): Optionally, may be provided to use different emails in .md
132+
files",
133+
],
134+
[
135+
"
136+
--email-npm (string): Optionally, may be provided to use different emails in
137+
package.json",
138+
],
139+
[
140+
"
141+
--funding (string): GitHub organization or username to mention in funding.yml
142+
(by default, owner)",
143+
],
144+
[
145+
"
146+
--guide (string): Link to a contribution guide to place at the top of the
147+
development docs",
148+
],
149+
[
150+
"
151+
--guide-title (string): If --guide is provided or detected from an existing
152+
DEVELOPMENT.md, the text title to place in the guide link",
153+
],
154+
[
155+
"
156+
--keywords (string): Any number of keywords to include in package.json (by default,
157+
none). This can be specified any number of times, like
158+
--keywords apple --keywords \\"banana cherry\\"",
159+
],
160+
[
161+
"
162+
--logo (string): Local image file in the repository to display near the top of
163+
the README.md as a logo",
164+
],
165+
[
166+
"
167+
--logo-alt (string): If --logo is provided or detected from an existing README.md,
168+
alt text that describes the image will be prompted for if not provided",
169+
],
170+
[
171+
"
172+
--preserve-generated-form: Whether to keep the GitHub repository generated from
173+
notice (by default, false)",
174+
],
175+
[],
176+
[
177+
" ",
178+
],
179+
[
180+
"Opt-outs:",
181+
],
182+
[
183+
"
184+
⚠️ Warning: Specifying any --exclude-* flag on the command-line will
185+
cause the setup script to skip prompting for more excludes. ⚠️",
186+
],
187+
[
188+
"
189+
--exclude-all-contributors: Don't add all-contributors to track contributions
190+
and display them in a README.md table.",
191+
],
192+
[
193+
"
194+
--exclude-compliance: Don't add a GitHub Actions workflow to verify that PRs match
195+
an expected format.",
196+
],
197+
[
198+
"
199+
--exclude-lint-deprecation: Don't use eslint-plugin-deprecation to report on usage
200+
of code marked as @deprecated.",
201+
],
202+
[
203+
"
204+
--exclude-lint-jsdoc: Don't use eslint-plugin-jsdoc to enforce good practices around
205+
JSDoc comments.",
206+
],
207+
[
208+
"
209+
--exclude-lint-json: Don't apply linting and sorting to *.json, and
210+
*.jsonc files.",
211+
],
212+
[
213+
"
214+
--exclude-lint-knip: Don't add Knip to detect unused files, dependencies, and code
215+
exports.",
216+
],
217+
[
218+
"
219+
--exclude-lint-md: Don't apply linting to *.md files.",
220+
],
221+
[
222+
"
223+
--exclude-lint-package-json: Don't add npm-package-json-lint to lint for
224+
package.json correctness.",
225+
],
226+
[
227+
"
228+
--exclude-lint-packages: Don't add a pnpm dedupe workflow to ensure packages
229+
aren't duplicated unnecessarily.",
230+
],
231+
[
232+
"
233+
--exclude-lint-perfectionist: Don't apply eslint-plugin-perfectionist to ensure
234+
imports, keys, and so on are in sorted order.",
235+
],
236+
[
237+
"
238+
--exclude-lint-regex: Don't add eslint-plugin-regex to enforce good practices around
239+
regular expressions.",
240+
],
241+
[
242+
"
243+
--exclude-lint-spelling: Don't add cspell to spell check against dictionaries
244+
of known words.",
245+
],
246+
[
247+
"
248+
--exclude-lint-strict: Don't augment the recommended logical lint rules with
249+
typescript-eslint's strict config.",
250+
],
251+
[
252+
"
253+
--exclude-lint-stylistic: Don't add stylistic rules such as typescript-eslint's
254+
stylistic config.",
255+
],
256+
[
257+
"
258+
--exclude-lint-yml: Don't apply linting and sorting to *.yaml and *.yml files.",
259+
],
260+
[
261+
"
262+
--exclude-releases: Don't add release-it to generate changelogs, package bumps,
263+
and publishes based on conventional commits.",
264+
],
265+
[
266+
"
267+
--exclude-renovate: Don't add a Renovate config to dependencies up-to-date with
268+
PRs.",
269+
],
270+
[
271+
"
272+
--exclude-tests: Don't add Vitest tooling for fast unit tests, configured
273+
with coverage tracking.",
274+
],
275+
[
276+
"
277+
You can prevent the migration script from making some network-based
278+
changes using any or all of the following CLI flags:",
279+
],
280+
[
281+
"
282+
--exclude-contributors: Skips network calls that fetch all-contributors
283+
data from GitHub",
284+
],
285+
[
286+
"
287+
--skip-all-contributors-api: Skips network calls that fetch all-contributors data from
288+
GitHub. This flag does nothing if --exclude-all-contributors was specified.",
289+
],
290+
[
291+
"
292+
--skip-github-api: Skips calling to GitHub APIs.",
293+
],
294+
[
295+
"
296+
--skip-install: Skips installing all the new template packages with pnpm.",
297+
],
298+
[
299+
"
300+
You can prevent the migration script from making some changes on disk
301+
using any or all of the following CLI flags:",
302+
],
303+
[
304+
"
305+
--skip-removal: Skips removing setup docs and scripts, including this docs/
306+
directory",
307+
],
308+
[
309+
"
310+
--skip-restore: Skips the prompt offering to restore the repository if an
311+
error occurs during setup",
312+
],
313+
[
314+
"
315+
--skip-uninstall: Skips uninstalling packages only used for setup scripts",
316+
],
317+
[],
318+
[
319+
" ",
320+
],
321+
[
322+
"Offline Mode:",
323+
],
324+
[
325+
"
326+
--offline: You can run create-typescript-app in an \\"offline\\" mode.
327+
Doing so will:
328+
• Enable --exclude-all-contributors-api and --skip-github-api
329+
• Skip network calls when setting up contributors
330+
• Run pnpm commands with pnpm's --offline mode",
331+
],
332+
[],
333+
]
334+
`);
335+
});
336+
});

0 commit comments

Comments
 (0)