Fix the description and rename the project-folder option of generate-…

…docs
devcontainers · Mar 29, 2024 · 1910eb2 · 1910eb2
1 parent 1da368b
commit 1910eb2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/spec-node/featuresCLI/generateDocs.ts b/src/spec-node/featuresCLI/generateDocs.ts
@@ -9,7 +9,7 @@ import { getPackageConfig } from '../../spec-utils/product';
 export function featuresGenerateDocsOptions(y: Argv) {
 	return y
 		.options({
-			'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.' },
+			'src-folder': { type: 'string', alias: 'p', default: '.', description: 'Path to folder containing containing numerous subdirectories, each of which contains a devcontainer-feature.json.' },
 			'registry': { type: 'string', alias: 'r', default: 'ghcr.io', description: 'Name of the OCI registry.' },
 			'namespace': { type: 'string', alias: 'n', require: true, description: `Unique indentifier for the collection of features. Example: <owner>/<repo>` },
 			'github-owner': { type: 'string', default: '', description: `GitHub owner for docs.` },
@@ -28,7 +28,7 @@ export function featuresGenerateDocsHandler(args: FeaturesGenerateDocsArgs) {
 }
 
 export async function featuresGenerateDocs({
-	'project-folder': collectionFolder,
+	'src-folder': collectionFolder,
 	'registry': registry,
 	'namespace': namespace,
 	'github-owner': gitHubOwner,

diff --git a/src/spec-node/templatesCLI/generateDocs.ts b/src/spec-node/templatesCLI/generateDocs.ts
@@ -9,7 +9,7 @@ import { getPackageConfig } from '../../spec-utils/product';
 export function templatesGenerateDocsOptions(y: Argv) {
 	return y
 		.options({
-			'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.' },
+			'src-folder': { type: 'string', alias: 'p', default: '.', description: 'Path to folder containing containing numerous subdirectories, each of which contains a devcontainer-template.json.' },
 			'github-owner': { type: 'string', default: '', description: `GitHub owner for docs.` },
 			'github-repo': { type: 'string', default: '', description: `GitHub repo for docs.` },
 			'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) {
 }
 
 export async function templatesGenerateDocs({
-	'project-folder': collectionFolder,
+	'src-folder': collectionFolder,
 	'github-owner': gitHubOwner,
 	'github-repo': gitHubRepo,
 	'log-level': inputLogLevel,