@remix-run/cli 0.0.0 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (155) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +80 -3
  3. package/bootstrap/AGENTS.md +35 -0
  4. package/bootstrap/README.md +27 -0
  5. package/bootstrap/app/controllers/auth.tsx +21 -0
  6. package/bootstrap/app/controllers/home.tsx +26 -0
  7. package/bootstrap/app/router.ts +10 -0
  8. package/bootstrap/app/routes.ts +6 -0
  9. package/bootstrap/app/ui/document.tsx +21 -0
  10. package/bootstrap/app/ui/layout.tsx +22 -0
  11. package/bootstrap/app/utils/render.tsx +7 -0
  12. package/bootstrap/package.json +22 -0
  13. package/bootstrap/server.ts +37 -0
  14. package/bootstrap/tsconfig.json +19 -0
  15. package/dist/index.d.ts +2 -0
  16. package/dist/index.d.ts.map +1 -0
  17. package/dist/index.js +1 -0
  18. package/dist/lib/bootstrap-project.d.ts +17 -0
  19. package/dist/lib/bootstrap-project.d.ts.map +1 -0
  20. package/dist/lib/bootstrap-project.js +137 -0
  21. package/dist/lib/cli-context.d.ts +11 -0
  22. package/dist/lib/cli-context.d.ts.map +1 -0
  23. package/dist/lib/cli-context.js +19 -0
  24. package/dist/lib/cli.d.ts +6 -0
  25. package/dist/lib/cli.d.ts.map +1 -0
  26. package/dist/lib/cli.js +87 -0
  27. package/dist/lib/commands/completion.d.ts +3 -0
  28. package/dist/lib/commands/completion.d.ts.map +1 -0
  29. package/dist/lib/commands/completion.js +51 -0
  30. package/dist/lib/commands/doctor.d.ts +4 -0
  31. package/dist/lib/commands/doctor.d.ts.map +1 -0
  32. package/dist/lib/commands/doctor.js +293 -0
  33. package/dist/lib/commands/help.d.ts +4 -0
  34. package/dist/lib/commands/help.d.ts.map +1 -0
  35. package/dist/lib/commands/help.js +124 -0
  36. package/dist/lib/commands/new.d.ts +4 -0
  37. package/dist/lib/commands/new.d.ts.map +1 -0
  38. package/dist/lib/commands/new.js +70 -0
  39. package/dist/lib/commands/routes.d.ts +4 -0
  40. package/dist/lib/commands/routes.d.ts.map +1 -0
  41. package/dist/lib/commands/routes.js +161 -0
  42. package/dist/lib/commands/skills.d.ts +6 -0
  43. package/dist/lib/commands/skills.d.ts.map +1 -0
  44. package/dist/lib/commands/skills.js +222 -0
  45. package/dist/lib/commands/test.d.ts +4 -0
  46. package/dist/lib/commands/test.d.ts.map +1 -0
  47. package/dist/lib/commands/test.js +19 -0
  48. package/dist/lib/commands/version.d.ts +4 -0
  49. package/dist/lib/commands/version.d.ts.map +1 -0
  50. package/dist/lib/commands/version.js +29 -0
  51. package/dist/lib/completion.d.ts +12 -0
  52. package/dist/lib/completion.d.ts.map +1 -0
  53. package/dist/lib/completion.js +408 -0
  54. package/dist/lib/contained-path.d.ts +2 -0
  55. package/dist/lib/contained-path.d.ts.map +1 -0
  56. package/dist/lib/contained-path.js +10 -0
  57. package/dist/lib/controller-files.d.ts +14 -0
  58. package/dist/lib/controller-files.d.ts.map +1 -0
  59. package/dist/lib/controller-files.js +53 -0
  60. package/dist/lib/controller-ownership.d.ts +41 -0
  61. package/dist/lib/controller-ownership.d.ts.map +1 -0
  62. package/dist/lib/controller-ownership.js +224 -0
  63. package/dist/lib/display-path.d.ts +2 -0
  64. package/dist/lib/display-path.d.ts.map +1 -0
  65. package/dist/lib/display-path.js +12 -0
  66. package/dist/lib/doctor/controller-findings.d.ts +4 -0
  67. package/dist/lib/doctor/controller-findings.d.ts.map +1 -0
  68. package/dist/lib/doctor/controller-findings.js +132 -0
  69. package/dist/lib/doctor/controller-fix-plans.d.ts +4 -0
  70. package/dist/lib/doctor/controller-fix-plans.d.ts.map +1 -0
  71. package/dist/lib/doctor/controller-fix-plans.js +130 -0
  72. package/dist/lib/doctor/controller-placeholders.d.ts +4 -0
  73. package/dist/lib/doctor/controller-placeholders.d.ts.map +1 -0
  74. package/dist/lib/doctor/controller-placeholders.js +183 -0
  75. package/dist/lib/doctor/controllers.d.ts +8 -0
  76. package/dist/lib/doctor/controllers.d.ts.map +1 -0
  77. package/dist/lib/doctor/controllers.js +13 -0
  78. package/dist/lib/doctor/environment.d.ts +17 -0
  79. package/dist/lib/doctor/environment.d.ts.map +1 -0
  80. package/dist/lib/doctor/environment.js +226 -0
  81. package/dist/lib/doctor/fixes.d.ts +3 -0
  82. package/dist/lib/doctor/fixes.d.ts.map +1 -0
  83. package/dist/lib/doctor/fixes.js +65 -0
  84. package/dist/lib/doctor/project.d.ts +10 -0
  85. package/dist/lib/doctor/project.d.ts.map +1 -0
  86. package/dist/lib/doctor/project.js +371 -0
  87. package/dist/lib/doctor/types.d.ts +48 -0
  88. package/dist/lib/doctor/types.d.ts.map +1 -0
  89. package/dist/lib/doctor/types.js +15 -0
  90. package/dist/lib/errors.d.ts +173 -0
  91. package/dist/lib/errors.d.ts.map +1 -0
  92. package/dist/lib/errors.js +318 -0
  93. package/dist/lib/help-text.d.ts +13 -0
  94. package/dist/lib/help-text.d.ts.map +1 -0
  95. package/dist/lib/help-text.js +43 -0
  96. package/dist/lib/load-route-map-worker.d.ts +2 -0
  97. package/dist/lib/load-route-map-worker.d.ts.map +1 -0
  98. package/dist/lib/load-route-map-worker.js +92 -0
  99. package/dist/lib/parse-args.d.ts +22 -0
  100. package/dist/lib/parse-args.d.ts.map +1 -0
  101. package/dist/lib/parse-args.js +35 -0
  102. package/dist/lib/remix-version.d.ts +2 -0
  103. package/dist/lib/remix-version.d.ts.map +1 -0
  104. package/dist/lib/remix-version.js +58 -0
  105. package/dist/lib/reporter.d.ts +56 -0
  106. package/dist/lib/reporter.d.ts.map +1 -0
  107. package/dist/lib/reporter.js +357 -0
  108. package/dist/lib/route-map.d.ts +38 -0
  109. package/dist/lib/route-map.d.ts.map +1 -0
  110. package/dist/lib/route-map.js +195 -0
  111. package/dist/lib/skills-cache.d.ts +19 -0
  112. package/dist/lib/skills-cache.d.ts.map +1 -0
  113. package/dist/lib/skills-cache.js +89 -0
  114. package/dist/lib/skills.d.ts +30 -0
  115. package/dist/lib/skills.d.ts.map +1 -0
  116. package/dist/lib/skills.js +441 -0
  117. package/dist/lib/terminal.d.ts +17 -0
  118. package/dist/lib/terminal.d.ts.map +1 -0
  119. package/dist/lib/terminal.js +66 -0
  120. package/package.json +48 -5
  121. package/src/index.ts +1 -0
  122. package/src/lib/bootstrap-project.ts +222 -0
  123. package/src/lib/cli-context.ts +38 -0
  124. package/src/lib/cli.ts +120 -0
  125. package/src/lib/commands/completion.ts +74 -0
  126. package/src/lib/commands/doctor.ts +393 -0
  127. package/src/lib/commands/help.ts +157 -0
  128. package/src/lib/commands/new.ts +104 -0
  129. package/src/lib/commands/routes.ts +251 -0
  130. package/src/lib/commands/skills.ts +306 -0
  131. package/src/lib/commands/test.ts +25 -0
  132. package/src/lib/commands/version.ts +39 -0
  133. package/src/lib/completion.ts +561 -0
  134. package/src/lib/contained-path.ts +13 -0
  135. package/src/lib/controller-files.ts +79 -0
  136. package/src/lib/controller-ownership.ts +397 -0
  137. package/src/lib/display-path.ts +16 -0
  138. package/src/lib/doctor/controller-findings.ts +157 -0
  139. package/src/lib/doctor/controller-fix-plans.ts +184 -0
  140. package/src/lib/doctor/controller-placeholders.ts +242 -0
  141. package/src/lib/doctor/controllers.ts +23 -0
  142. package/src/lib/doctor/environment.ts +289 -0
  143. package/src/lib/doctor/fixes.ts +84 -0
  144. package/src/lib/doctor/project.ts +435 -0
  145. package/src/lib/doctor/types.ts +95 -0
  146. package/src/lib/errors.ts +379 -0
  147. package/src/lib/help-text.ts +88 -0
  148. package/src/lib/load-route-map-worker.ts +110 -0
  149. package/src/lib/parse-args.ts +82 -0
  150. package/src/lib/remix-version.ts +80 -0
  151. package/src/lib/reporter.ts +535 -0
  152. package/src/lib/route-map.ts +303 -0
  153. package/src/lib/skills-cache.ts +140 -0
  154. package/src/lib/skills.ts +706 -0
  155. package/src/lib/terminal.ts +86 -0
@@ -0,0 +1,87 @@
1
+ import * as process from 'node:process';
2
+ import { runCompletionCommand } from "./commands/completion.js";
3
+ import { runDoctorCommand } from "./commands/doctor.js";
4
+ import { getCliHelpText, runHelpCommand } from "./commands/help.js";
5
+ import { runNewCommand } from "./commands/new.js";
6
+ import { runRoutesCommand } from "./commands/routes.js";
7
+ import { runSkillsCommand } from "./commands/skills.js";
8
+ import { runTestCommand } from "./commands/test.js";
9
+ import { runVersionCommand } from "./commands/version.js";
10
+ import { resolveCliContext } from "./cli-context.js";
11
+ import { renderCliError, unknownCommand } from "./errors.js";
12
+ import { configureColors, restoreTerminalFormatting } from "./terminal.js";
13
+ export async function runRemix(argv = process.argv.slice(2), options = {}) {
14
+ let context = await resolveCliContext(options);
15
+ try {
16
+ while (argv[0] === '--') {
17
+ argv = argv.slice(1);
18
+ }
19
+ let globalOptions = extractGlobalOptions(argv);
20
+ argv = globalOptions.argv;
21
+ configureColors({ disabled: globalOptions.noColor });
22
+ if (argv.length === 0) {
23
+ process.stdout.write(getCliHelpText());
24
+ return 0;
25
+ }
26
+ let [command, ...rest] = argv;
27
+ if (command === '-h' || command === '--help') {
28
+ process.stdout.write(getCliHelpText());
29
+ return 0;
30
+ }
31
+ return await runCommand(command, rest, context);
32
+ }
33
+ finally {
34
+ restoreTerminalFormatting();
35
+ }
36
+ }
37
+ async function runCommand(command, argv, context) {
38
+ if (command === 'help') {
39
+ return runHelpCommand(argv);
40
+ }
41
+ if (command === '-v' || command === '--version') {
42
+ return runVersionCommand([], context);
43
+ }
44
+ if (command === 'new') {
45
+ return runNewCommand(argv, context);
46
+ }
47
+ if (command === 'completion') {
48
+ return runCompletionCommand(argv);
49
+ }
50
+ if (command === 'doctor') {
51
+ return runDoctorCommand(argv, context);
52
+ }
53
+ if (command === 'skills') {
54
+ return runSkillsCommand(argv, context);
55
+ }
56
+ if (command === 'routes') {
57
+ return runRoutesCommand(argv, context);
58
+ }
59
+ if (command === 'test') {
60
+ return runTestCommand(argv, context);
61
+ }
62
+ if (command === 'version') {
63
+ return runVersionCommand(argv, context);
64
+ }
65
+ process.stderr.write(renderCliError(unknownCommand(command), { helpText: getCliHelpText(process.stderr) }));
66
+ return 1;
67
+ }
68
+ function extractGlobalOptions(argv) {
69
+ let filteredArgv = [];
70
+ let noColor = false;
71
+ for (let index = 0; index < argv.length; index++) {
72
+ let arg = argv[index];
73
+ if (arg === '--') {
74
+ filteredArgv.push(...argv.slice(index));
75
+ break;
76
+ }
77
+ if (arg === '--no-color') {
78
+ noColor = true;
79
+ continue;
80
+ }
81
+ filteredArgv.push(arg);
82
+ }
83
+ return {
84
+ argv: filteredArgv,
85
+ noColor,
86
+ };
87
+ }
@@ -0,0 +1,3 @@
1
+ export declare function runCompletionCommand(argv: string[]): Promise<number>;
2
+ export declare function getCompletionCommandHelpText(target?: NodeJS.WriteStream): string;
3
+ //# sourceMappingURL=completion.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"completion.d.ts","sourceRoot":"","sources":["../../../src/lib/commands/completion.ts"],"names":[],"mappings":"AAiBA,wBAAsB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CA6B1E;AAED,wBAAgB,4BAA4B,CAAC,MAAM,GAAE,MAAM,CAAC,WAA4B,GAAG,MAAM,CAShG"}
@@ -0,0 +1,51 @@
1
+ import * as process from 'node:process';
2
+ import { getCompletionResult, getCompletionScript, isCompletionShell, renderCompletionResult, } from "../completion.js";
3
+ import { invalidCompletionRequest, renderCliError, toCliError, unknownCompletionShell, } from "../errors.js";
4
+ import { formatHelpText } from "../help-text.js";
5
+ import { parseArgs } from "../parse-args.js";
6
+ export async function runCompletionCommand(argv) {
7
+ if (argv.length === 0 || argv[0] === '-h' || argv[0] === '--help') {
8
+ process.stdout.write(getCompletionCommandHelpText());
9
+ return 0;
10
+ }
11
+ if (argv[0] === '--') {
12
+ return runCompletionPlumbing(argv.slice(1));
13
+ }
14
+ let [shell, ...rest] = argv;
15
+ try {
16
+ parseArgs(rest, {}, { maxPositionals: 0 });
17
+ if (!isCompletionShell(shell)) {
18
+ throw unknownCompletionShell(shell);
19
+ }
20
+ process.stdout.write(getCompletionScript());
21
+ return 0;
22
+ }
23
+ catch (error) {
24
+ process.stderr.write(renderCliError(toCliError(error), {
25
+ helpText: getCompletionCommandHelpText(process.stderr),
26
+ }));
27
+ return 1;
28
+ }
29
+ }
30
+ export function getCompletionCommandHelpText(target = process.stdout) {
31
+ return formatHelpText({
32
+ description: 'Print a shell completion script for Remix.',
33
+ examples: ['remix completion bash >> ~/.bashrc', 'remix completion zsh >> ~/.zshrc'],
34
+ usage: ['remix completion <bash|zsh>'],
35
+ }, target);
36
+ }
37
+ function runCompletionPlumbing(argv) {
38
+ try {
39
+ let [currentIndexArg, ...words] = argv;
40
+ if (currentIndexArg == null || !/^\d+$/.test(currentIndexArg)) {
41
+ throw invalidCompletionRequest();
42
+ }
43
+ let currentIndex = Number(currentIndexArg);
44
+ process.stdout.write(renderCompletionResult(getCompletionResult(words, currentIndex)));
45
+ return 0;
46
+ }
47
+ catch (error) {
48
+ process.stderr.write(renderCliError(toCliError(error)));
49
+ return 1;
50
+ }
51
+ }
@@ -0,0 +1,4 @@
1
+ import type { CliContext } from '../cli-context.ts';
2
+ export declare function runDoctorCommand(argv: string[], context: CliContext): Promise<number>;
3
+ export declare function getDoctorCommandHelpText(target?: NodeJS.WriteStream): string;
4
+ //# sourceMappingURL=doctor.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"doctor.d.ts","sourceRoot":"","sources":["../../../src/lib/commands/doctor.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AA4CnD,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CA6C3F;AAED,wBAAgB,wBAAwB,CAAC,MAAM,GAAE,MAAM,CAAC,WAA4B,GAAG,MAAM,CAsB5F"}
@@ -0,0 +1,293 @@
1
+ import * as path from 'node:path';
2
+ import * as process from 'node:process';
3
+ import { checkControllerConventions } from "../doctor/controllers.js";
4
+ import { checkEnvironment, getEnvironmentFixPlans } from "../doctor/environment.js";
5
+ import { applyDoctorFixPlans } from "../doctor/fixes.js";
6
+ import { checkProject, getProjectFixPlans } from "../doctor/project.js";
7
+ import { createDoctorSuite, createSkippedDoctorSuite, } from "../doctor/types.js";
8
+ import { renderCliError, toCliError } from "../errors.js";
9
+ import { formatHelpText } from "../help-text.js";
10
+ import { parseArgs } from "../parse-args.js";
11
+ import { createCommandReporter, createStepProgressReporter, } from "../reporter.js";
12
+ const DOCTOR_SUITE_LABELS = {
13
+ controllers: {
14
+ complete: 'controllers',
15
+ running: 'Checking controllers',
16
+ },
17
+ environment: {
18
+ complete: 'environment',
19
+ running: 'Checking environment',
20
+ },
21
+ project: {
22
+ complete: 'project',
23
+ running: 'Checking project',
24
+ },
25
+ };
26
+ export async function runDoctorCommand(argv, context) {
27
+ if (argv.includes('-h') || argv.includes('--help')) {
28
+ process.stdout.write(getDoctorCommandHelpText());
29
+ return 0;
30
+ }
31
+ let reporter = null;
32
+ let progress = null;
33
+ try {
34
+ let options = parseDoctorCommandArgs(argv);
35
+ reporter = options.json
36
+ ? null
37
+ : createCommandReporter({
38
+ remixVersion: context.remixVersion,
39
+ stderr: process.stdout,
40
+ stdout: process.stdout,
41
+ });
42
+ progress = reporter == null ? null : createDoctorProgressReporter(reporter);
43
+ if (reporter != null) {
44
+ await reporter.status.commandHeader('doctor');
45
+ }
46
+ let report = await collectDoctorReport(progress, options, reporter, context);
47
+ if (options.json) {
48
+ process.stdout.write(`${JSON.stringify(report, null, 2)}\n`);
49
+ }
50
+ else if (reporter != null) {
51
+ writeDoctorReport(reporter, report);
52
+ reporter.finish();
53
+ }
54
+ if ((options.fix || options.strict) && hasWarningFindings(report.findings)) {
55
+ return 1;
56
+ }
57
+ return 0;
58
+ }
59
+ catch (error) {
60
+ progress?.writeSummaryGap();
61
+ process.stderr.write(renderCliError(toCliError(error), { helpText: getDoctorCommandHelpText(process.stderr) }));
62
+ reporter?.finish();
63
+ return 1;
64
+ }
65
+ }
66
+ export function getDoctorCommandHelpText(target = process.stdout) {
67
+ return formatHelpText({
68
+ description: 'Check project environment and Remix app conventions for the current project.',
69
+ examples: [
70
+ 'remix doctor',
71
+ 'remix doctor --json',
72
+ 'remix doctor --strict',
73
+ 'remix doctor --fix',
74
+ ],
75
+ options: [
76
+ { description: 'Print doctor findings as JSON', label: '--json' },
77
+ {
78
+ description: 'Exit with status 1 when warning-level findings are present',
79
+ label: '--strict',
80
+ },
81
+ { description: 'Apply low-risk project and controller fixes', label: '--fix' },
82
+ ],
83
+ usage: ['remix doctor [--json] [--strict] [--fix] [--no-color]'],
84
+ }, target);
85
+ }
86
+ function parseDoctorCommandArgs(argv) {
87
+ let parsed = parseArgs(argv, {
88
+ fix: { flag: '--fix', type: 'boolean' },
89
+ json: { flag: '--json', type: 'boolean' },
90
+ strict: { flag: '--strict', type: 'boolean' },
91
+ }, { maxPositionals: 0 });
92
+ return {
93
+ fix: parsed.options.fix,
94
+ json: parsed.options.json,
95
+ strict: parsed.options.strict,
96
+ };
97
+ }
98
+ async function collectDoctorReport(progress, options, reporter, context) {
99
+ let cwd = context.cwd;
100
+ let appliedFixes = [];
101
+ let environment = await runDoctorSuite(progress, 'environment', async () => {
102
+ let result = await checkEnvironment(cwd);
103
+ let suiteAppliedFixes = [];
104
+ let finalResult = result;
105
+ if (options.fix && result.projectRoot != null) {
106
+ let fixPlans = getEnvironmentFixPlans(result, context.remixVersion);
107
+ if (fixPlans.length > 0) {
108
+ suiteAppliedFixes = await applyDoctorFixPlans(result.projectRoot, fixPlans);
109
+ finalResult = await checkEnvironment(result.projectRoot);
110
+ }
111
+ }
112
+ let suite = finalResult.suite;
113
+ if (suiteAppliedFixes.length > 0) {
114
+ suite = {
115
+ ...suite,
116
+ appliedFixes: suiteAppliedFixes,
117
+ };
118
+ }
119
+ return {
120
+ appliedFixes: suiteAppliedFixes,
121
+ projectRoot: finalResult.projectRoot ?? result.projectRoot,
122
+ suite,
123
+ };
124
+ });
125
+ let findings = [...environment.suite.findings];
126
+ appliedFixes.push(...(environment.appliedFixes ?? []));
127
+ let suites = [environment.suite];
128
+ let routesFile = environment.projectRoot == null
129
+ ? undefined
130
+ : path.join(environment.projectRoot, 'app', 'routes.ts');
131
+ writeDoctorSuiteDetails(reporter, environment.suite);
132
+ progress?.writeSummaryGap();
133
+ if (hasWarningFindings(environment.suite.findings)) {
134
+ let projectSuite = createSkippedDoctorSuite('project', 'Blocked by environment warnings.');
135
+ let controllersSuite = createSkippedDoctorSuite('controllers', 'Blocked by environment warnings.');
136
+ suites.push(projectSuite, controllersSuite);
137
+ progress?.skip(projectSuite.name, projectSuite.reason);
138
+ writeDoctorSuiteDetails(reporter, projectSuite);
139
+ progress?.writeSummaryGap();
140
+ progress?.skip(controllersSuite.name, controllersSuite.reason);
141
+ writeDoctorSuiteDetails(reporter, controllersSuite);
142
+ progress?.writeSummaryGap();
143
+ return {
144
+ appRoot: environment.projectRoot,
145
+ appliedFixes,
146
+ findings,
147
+ remainingFindings: findings,
148
+ routesFile,
149
+ suites,
150
+ };
151
+ }
152
+ let project = await runDoctorSuite(progress, 'project', async () => {
153
+ let result = await checkProject(environment.projectRoot);
154
+ let suiteAppliedFixes = [];
155
+ let finalResult = result;
156
+ if (options.fix) {
157
+ let fixPlans = await getProjectFixPlans(environment.projectRoot);
158
+ if (fixPlans.length > 0) {
159
+ suiteAppliedFixes = await applyDoctorFixPlans(environment.projectRoot, fixPlans);
160
+ finalResult = await checkProject(environment.projectRoot);
161
+ }
162
+ }
163
+ let suite = finalResult.suite;
164
+ if (suiteAppliedFixes.length > 0) {
165
+ suite = {
166
+ ...suite,
167
+ appliedFixes: suiteAppliedFixes,
168
+ };
169
+ }
170
+ return {
171
+ appliedFixes: suiteAppliedFixes,
172
+ routeManifest: finalResult.routeManifest,
173
+ routesFile: finalResult.routesFile,
174
+ suite,
175
+ };
176
+ });
177
+ findings.push(...project.suite.findings);
178
+ appliedFixes.push(...(project.appliedFixes ?? []));
179
+ routesFile = project.routesFile;
180
+ suites.push(project.suite);
181
+ writeDoctorSuiteDetails(reporter, project.suite);
182
+ progress?.writeSummaryGap();
183
+ if (hasWarningFindings(project.suite.findings)) {
184
+ let controllersSuite = createSkippedDoctorSuite('controllers', 'Blocked by project warnings.');
185
+ suites.push(controllersSuite);
186
+ progress?.skip(controllersSuite.name, controllersSuite.reason);
187
+ writeDoctorSuiteDetails(reporter, controllersSuite);
188
+ progress?.writeSummaryGap();
189
+ return {
190
+ appRoot: environment.projectRoot,
191
+ appliedFixes,
192
+ findings,
193
+ remainingFindings: findings,
194
+ routesFile,
195
+ suites,
196
+ };
197
+ }
198
+ let controllers = await runDoctorSuite(progress, 'controllers', async () => {
199
+ let controllerResult = await checkControllerConventions(project.routeManifest.appRoot, project.routeManifest.tree);
200
+ let remainingFindings = controllerResult.suite.findings;
201
+ let suiteAppliedFixes = [];
202
+ if (options.fix && controllerResult.fixPlans.length > 0) {
203
+ suiteAppliedFixes = await applyDoctorFixPlans(project.routeManifest.appRoot, controllerResult.fixPlans);
204
+ let finalControllerResult = await checkControllerConventions(project.routeManifest.appRoot, project.routeManifest.tree);
205
+ remainingFindings = finalControllerResult.suite.findings;
206
+ }
207
+ let suite = createDoctorSuite('controllers', remainingFindings);
208
+ if (suiteAppliedFixes.length > 0) {
209
+ suite.appliedFixes = suiteAppliedFixes;
210
+ }
211
+ return { appliedFixes: suiteAppliedFixes, suite };
212
+ });
213
+ findings.push(...controllers.suite.findings);
214
+ appliedFixes.push(...(controllers.appliedFixes ?? []));
215
+ suites.push(controllers.suite);
216
+ writeDoctorSuiteDetails(reporter, controllers.suite);
217
+ progress?.writeSummaryGap();
218
+ let report = {
219
+ appRoot: environment.projectRoot,
220
+ findings,
221
+ routesFile,
222
+ suites,
223
+ };
224
+ if (options.fix) {
225
+ report.appliedFixes = appliedFixes;
226
+ report.remainingFindings = findings;
227
+ }
228
+ return report;
229
+ }
230
+ function hasWarningFindings(findings) {
231
+ return findings.some((finding) => finding.severity === 'warn');
232
+ }
233
+ function formatAppliedFix(appliedFix) {
234
+ if (appliedFix.kind === 'update-file') {
235
+ return `Updated ${appliedFix.path}`;
236
+ }
237
+ return `Created ${appliedFix.path}`;
238
+ }
239
+ async function runDoctorSuite(progress, label, callback) {
240
+ progress?.start(label);
241
+ try {
242
+ let result = await callback();
243
+ if (result.suite.status === 'ok') {
244
+ progress?.succeed(label);
245
+ }
246
+ else if (result.suite.status === 'issues') {
247
+ progress?.fail(label);
248
+ }
249
+ else {
250
+ progress?.skip(label, result.suite.reason);
251
+ }
252
+ return result;
253
+ }
254
+ catch (error) {
255
+ progress?.fail(label);
256
+ throw error;
257
+ }
258
+ }
259
+ function createDoctorProgressReporter(reporter) {
260
+ return createStepProgressReporter(reporter.status, DOCTOR_SUITE_LABELS);
261
+ }
262
+ function writeDoctorReport(reporter, report) {
263
+ let warningCount = report.findings.filter((finding) => finding.severity === 'warn').length;
264
+ let adviceCount = report.findings.length - warningCount;
265
+ if ((report.appliedFixes?.length ?? 0) > 0) {
266
+ let fixCount = report.appliedFixes.length;
267
+ reporter.out.line(`Applied ${fixCount} ${fixCount === 1 ? 'fix' : 'fixes'}.`);
268
+ }
269
+ if (report.findings.length === 0) {
270
+ reporter.out.line('Doctor found no issues.');
271
+ }
272
+ reporter.out.line(`Summary: ${warningCount} warnings, ${adviceCount} advice.`);
273
+ }
274
+ function writeDoctorSuiteDetails(reporter, suite) {
275
+ if (reporter == null) {
276
+ return;
277
+ }
278
+ if (suite.findings.length === 0 && (suite.appliedFixes?.length ?? 0) === 0) {
279
+ return;
280
+ }
281
+ reporter.out.withIndent(() => {
282
+ for (let finding of suite.findings) {
283
+ reporter.out.bullet(reporter.out.label(finding.severity.toUpperCase(), finding.message, {
284
+ tone: finding.severity === 'warn' ? 'warn' : undefined,
285
+ }));
286
+ }
287
+ if ((suite.appliedFixes?.length ?? 0) > 0) {
288
+ reporter.out.section('Applied fixes:', () => {
289
+ reporter.out.bullets((suite.appliedFixes ?? []).map(formatAppliedFix));
290
+ });
291
+ }
292
+ });
293
+ }
@@ -0,0 +1,4 @@
1
+ export declare function runHelpCommand(argv: string[]): Promise<number>;
2
+ export declare function getCliHelpText(target?: NodeJS.WriteStream): string;
3
+ export declare function getHelpCommandHelpText(target?: NodeJS.WriteStream): string;
4
+ //# sourceMappingURL=help.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../../../src/lib/commands/help.ts"],"names":[],"mappings":"AAgBA,wBAAsB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAepE;AAED,wBAAgB,cAAc,CAAC,MAAM,GAAE,MAAM,CAAC,WAA4B,GAAG,MAAM,CAoClF;AAED,wBAAgB,sBAAsB,CAAC,MAAM,GAAE,MAAM,CAAC,WAA4B,GAAG,MAAM,CAkB1F"}
@@ -0,0 +1,124 @@
1
+ import * as process from 'node:process';
2
+ import { getCompletionCommandHelpText } from "./completion.js";
3
+ import { renderCliError, toCliError, unknownHelpTopic } from "../errors.js";
4
+ import { formatHelpText } from "../help-text.js";
5
+ import { getDoctorCommandHelpText } from "./doctor.js";
6
+ import { getNewCommandHelpText } from "./new.js";
7
+ import { getRoutesCommandHelpText } from "./routes.js";
8
+ import { getSkillsCommandHelpText, getSkillsInstallCommandHelpText, getSkillsListCommandHelpText, } from "./skills.js";
9
+ import { getTestCommandHelpText } from "./test.js";
10
+ import { getVersionCommandHelpText } from "./version.js";
11
+ export async function runHelpCommand(argv) {
12
+ if (argv.includes('-h') || argv.includes('--help')) {
13
+ process.stdout.write(getHelpCommandHelpText());
14
+ return 0;
15
+ }
16
+ try {
17
+ process.stdout.write(getCommandHelpText(argv));
18
+ return 0;
19
+ }
20
+ catch (error) {
21
+ process.stderr.write(renderCliError(toCliError(error), { helpText: getCliHelpText(process.stderr) }));
22
+ return 1;
23
+ }
24
+ }
25
+ export function getCliHelpText(target = process.stdout) {
26
+ return formatHelpText({
27
+ commands: [
28
+ { description: 'Print shell completion scripts for Remix', label: 'completion' },
29
+ { description: 'Show help for Remix commands', label: 'help [command]' },
30
+ { description: 'Create a new Remix project', label: 'new <name>' },
31
+ { description: 'Check project health for the current project', label: 'doctor' },
32
+ { description: 'Show the route tree for the current project', label: 'routes' },
33
+ { description: 'Manage Remix skills for the current project', label: 'skills' },
34
+ { description: 'Run tests for the current project', label: 'test [glob]' },
35
+ { description: 'Show the current Remix version', label: 'version' },
36
+ ],
37
+ examples: [
38
+ 'remix completion bash',
39
+ 'remix help',
40
+ 'remix help completion',
41
+ 'remix help doctor',
42
+ 'remix help skills install',
43
+ 'remix doctor',
44
+ 'remix new my-remix-app',
45
+ 'remix new my-remix-app --app-name "My Remix App"',
46
+ 'remix routes',
47
+ 'remix skills install',
48
+ 'remix test',
49
+ 'remix version',
50
+ ],
51
+ options: [
52
+ { description: 'Show help', label: '-h, --help' },
53
+ { description: 'Disable ANSI color output', label: '--no-color' },
54
+ { description: 'Show version', label: '-v, --version' },
55
+ ],
56
+ usage: ['remix <command> [options]'],
57
+ }, target);
58
+ }
59
+ export function getHelpCommandHelpText(target = process.stdout) {
60
+ return formatHelpText({
61
+ description: 'Show help for Remix commands.',
62
+ examples: [
63
+ 'remix help',
64
+ 'remix help completion',
65
+ 'remix help doctor',
66
+ 'remix help new',
67
+ 'remix help routes',
68
+ 'remix help skills install',
69
+ 'remix help test',
70
+ 'remix help version',
71
+ ],
72
+ usage: ['remix help [command]'],
73
+ }, target);
74
+ }
75
+ function getCommandHelpText(argv) {
76
+ if (argv.length === 0) {
77
+ return getCliHelpText();
78
+ }
79
+ let [command, ...rest] = argv;
80
+ if (command === 'help') {
81
+ return rest.length === 0 ? getHelpCommandHelpText() : getNestedHelpText(command, rest);
82
+ }
83
+ if (command === 'new' && rest.length === 0) {
84
+ return getNewCommandHelpText();
85
+ }
86
+ if (command === 'completion' && rest.length === 0) {
87
+ return getCompletionCommandHelpText();
88
+ }
89
+ if (command === 'doctor' && rest.length === 0) {
90
+ return getDoctorCommandHelpText();
91
+ }
92
+ if (command === 'routes' && rest.length === 0) {
93
+ return getRoutesCommandHelpText();
94
+ }
95
+ if (command === 'skills') {
96
+ return getSkillsHelpText(rest);
97
+ }
98
+ if (command === 'test' && rest.length === 0) {
99
+ return getTestCommandHelpText();
100
+ }
101
+ if (command === 'version' && rest.length === 0) {
102
+ return getVersionCommandHelpText();
103
+ }
104
+ throw unknownHelpTopic(argv.join(' '));
105
+ }
106
+ function getNestedHelpText(command, argv) {
107
+ throw unknownHelpTopic(`${command} ${argv.join(' ')}`);
108
+ }
109
+ function getSkillsHelpText(argv) {
110
+ if (argv.length === 0) {
111
+ return getSkillsCommandHelpText();
112
+ }
113
+ let [subcommand, ...rest] = argv;
114
+ if (rest.length > 0) {
115
+ throw unknownHelpTopic(`skills ${argv.join(' ')}`);
116
+ }
117
+ if (subcommand === 'install') {
118
+ return getSkillsInstallCommandHelpText();
119
+ }
120
+ if (subcommand === 'list') {
121
+ return getSkillsListCommandHelpText();
122
+ }
123
+ throw unknownHelpTopic(`skills ${argv.join(' ')}`);
124
+ }
@@ -0,0 +1,4 @@
1
+ import type { CliContext } from '../cli-context.ts';
2
+ export declare function runNewCommand(argv: string[], context: CliContext): Promise<number>;
3
+ export declare function getNewCommandHelpText(target?: NodeJS.WriteStream): string;
4
+ //# sourceMappingURL=new.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"new.d.ts","sourceRoot":"","sources":["../../../src/lib/commands/new.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAiBnD,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAqCxF;AAED,wBAAgB,qBAAqB,CAAC,MAAM,GAAE,MAAM,CAAC,WAA4B,GAAG,MAAM,CAazF"}
@@ -0,0 +1,70 @@
1
+ import * as process from 'node:process';
2
+ import { bootstrapProject } from "../bootstrap-project.js";
3
+ import { renderCliError, missingTargetDirectory, toCliError } from "../errors.js";
4
+ import { getDisplayPath } from "../display-path.js";
5
+ import { formatHelpText } from "../help-text.js";
6
+ import { parseArgs } from "../parse-args.js";
7
+ import { createCommandReporter, createStepProgressReporter, } from "../reporter.js";
8
+ const NEW_PROGRESS_LABELS = {
9
+ 'finalize-package-json': 'Finalize package.json',
10
+ 'generate-scaffold-files': 'Generate scaffold files',
11
+ 'prepare-target-directory': 'Prepare target directory',
12
+ };
13
+ export async function runNewCommand(argv, context) {
14
+ if (argv.length === 0 || argv.includes('-h') || argv.includes('--help')) {
15
+ process.stdout.write(getNewCommandHelpText());
16
+ return 0;
17
+ }
18
+ let reporter = null;
19
+ let progress = null;
20
+ try {
21
+ let options = parseNewCommandArgs(argv);
22
+ reporter = createCommandReporter({ remixVersion: context.remixVersion });
23
+ progress = createNewProgressReporter(reporter);
24
+ await reporter.status.commandHeader('new');
25
+ let result = await bootstrapProject({
26
+ ...options,
27
+ cwd: context.cwd,
28
+ remixVersion: context.remixVersion,
29
+ }, progress);
30
+ progress.writeSummaryGap();
31
+ reporter.out.line(`Created ${result.appDisplayName} at ${getDisplayPath(result.targetDir, context.cwd)}`);
32
+ reporter.finish();
33
+ return 0;
34
+ }
35
+ catch (error) {
36
+ progress?.writeSummaryGap();
37
+ process.stderr.write(renderCliError(toCliError(error), { helpText: getNewCommandHelpText(process.stderr) }));
38
+ reporter?.finish();
39
+ return 1;
40
+ }
41
+ }
42
+ export function getNewCommandHelpText(target = process.stdout) {
43
+ return formatHelpText({
44
+ description: 'Create a new Remix project in the target directory.',
45
+ examples: [
46
+ 'remix new ./my-remix-app',
47
+ 'remix new ./my-remix-app --app-name "My Remix App"',
48
+ 'remix new ./my-remix-app --force',
49
+ ],
50
+ usage: ['remix new <target-dir> [--app-name <name>] [--force]'],
51
+ }, target);
52
+ }
53
+ function parseNewCommandArgs(argv) {
54
+ let parsed = parseArgs(argv, {
55
+ appName: { flag: '--app-name', type: 'string' },
56
+ force: { flag: '--force', type: 'boolean' },
57
+ }, { maxPositionals: 1 });
58
+ let targetDir = parsed.positionals[0] ?? null;
59
+ if (targetDir == null) {
60
+ throw missingTargetDirectory();
61
+ }
62
+ return {
63
+ appName: parsed.options.appName ?? null,
64
+ force: parsed.options.force,
65
+ targetDir,
66
+ };
67
+ }
68
+ function createNewProgressReporter(reporter) {
69
+ return createStepProgressReporter(reporter.status, NEW_PROGRESS_LABELS);
70
+ }
@@ -0,0 +1,4 @@
1
+ import type { CliContext } from '../cli-context.ts';
2
+ export declare function runRoutesCommand(argv: string[], context: CliContext): Promise<number>;
3
+ export declare function getRoutesCommandHelpText(target?: NodeJS.WriteStream): string;
4
+ //# sourceMappingURL=routes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../../../src/lib/commands/routes.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAUnD,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAyB3F;AAED,wBAAgB,wBAAwB,CAAC,MAAM,GAAE,MAAM,CAAC,WAA4B,GAAG,MAAM,CAwB5F"}