Skip to content

Commit 1910eb2

Browse files
committed
Fix the description and rename the project-folder option of generate-docs
1 parent 1da368b commit 1910eb2

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/spec-node/featuresCLI/generateDocs.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { getPackageConfig } from '../../spec-utils/product';
99
export function featuresGenerateDocsOptions(y: Argv) {
1010
return y
1111
.options({
12-
'project-folder': { type: 'string', alias: 'p', default: '.', description: 'Path to folder containing \'src\' and \'test\' sub-folders. This is likely the git root of the project.' },
12+
'src-folder': { type: 'string', alias: 'p', default: '.', description: 'Path to folder containing containing numerous subdirectories, each of which contains a devcontainer-feature.json.' },
1313
'registry': { type: 'string', alias: 'r', default: 'ghcr.io', description: 'Name of the OCI registry.' },
1414
'namespace': { type: 'string', alias: 'n', require: true, description: `Unique indentifier for the collection of features. Example: <owner>/<repo>` },
1515
'github-owner': { type: 'string', default: '', description: `GitHub owner for docs.` },
@@ -28,7 +28,7 @@ export function featuresGenerateDocsHandler(args: FeaturesGenerateDocsArgs) {
2828
}
2929

3030
export async function featuresGenerateDocs({
31-
'project-folder': collectionFolder,
31+
'src-folder': collectionFolder,
3232
'registry': registry,
3333
'namespace': namespace,
3434
'github-owner': gitHubOwner,

src/spec-node/templatesCLI/generateDocs.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { getPackageConfig } from '../../spec-utils/product';
99
export function templatesGenerateDocsOptions(y: Argv) {
1010
return y
1111
.options({
12-
'project-folder': { type: 'string', alias: 'p', default: '.', description: 'Path to folder containing \'src\' and \'test\' sub-folders. This is likely the git root of the project.' },
12+
'src-folder': { type: 'string', alias: 'p', default: '.', description: 'Path to folder containing containing numerous subdirectories, each of which contains a devcontainer-template.json.' },
1313
'github-owner': { type: 'string', default: '', description: `GitHub owner for docs.` },
1414
'github-repo': { type: 'string', default: '', description: `GitHub repo for docs.` },
1515
'log-level': { choices: ['info' as 'info', 'debug' as 'debug', 'trace' as 'trace'], default: 'info' as 'info', description: 'Log level.' }
@@ -26,7 +26,7 @@ export function templatesGenerateDocsHandler(args: TemplatesGenerateDocsArgs) {
2626
}
2727

2828
export async function templatesGenerateDocs({
29-
'project-folder': collectionFolder,
29+
'src-folder': collectionFolder,
3030
'github-owner': gitHubOwner,
3131
'github-repo': gitHubRepo,
3232
'log-level': inputLogLevel,

0 commit comments

Comments
 (0)