Merge branch 'release/1.4.0'

DEVELOPING.md

@@ -14,6 +14,7 @@ pnpm start https://raw.githubusercontent.com/lindsayevans/scffld/develop/example
 pnpm start github:lindsayevans/scffld/examples/simple --name="My Github Component"
 pnpm start github:lindsayevans/scffld/examples/simple@main --name="My Github Component"
 pnpm start reg:parcel-web-app --overwrite --outputDirectory=./demo-src/reg-app/
+pnpm start show github:lindsayevans/scffld/examples/simple
 ```
 
 Generator

docs/generator.md

@@ -22,13 +22,13 @@ If a `.gitignore` is present it will respect it.
 Grab everything in a directory:
 
 ```sh
-npx @querc/scffld@alpha generate ./src/ > templates/app.md
+npx @querc/scffld generate ./src/ > templates/app.md
 ```
 
 Only include specific filetypes in a subdirectory:
 
 ```sh
-npx @querc/scffld@alpha generate \
+npx @querc/scffld generate \
     ./src/components/**/*.{tsx,scss} */ \
     > templates/components.md
 ```

docs/show.md

@@ -0,0 +1,24 @@
+# Show command
+
+Outputs the contents of a template
+
+## Syntax
+
+```
+scffld show <template>
+```
+
+## Examples
+
+Print the template to the screen:
+
+```sh
+npx @querc/scffld show github:lindsayevans/scffld/examples/simple
+```
+
+Copy a template to local:
+
+```sh
+npx @querc/scffld show github:lindsayevans/scffld/examples/simple \
+    > templates/thing.md
+```

docs/usage.md

@@ -108,3 +108,8 @@ npx @querc/scffld github:lindsayevans/scffld/examples/simple@v0.11.0 \
 | `-h` `--help`            | Show available options for the template                                                                   |
 | `-o` `--outputDirectory` | Base directory where files should be written<br>Defaults to the `outputDirectory` defined in the template |
 | `--overwrite`            | `true`: overwrite existing files<br>`false`: exit instead of overwriting                                  |
+
+## Other commands
+
+- [`show`](./show.md) - Outputs the contents of a template
+- [`generate`](./generator.md) - Generate template from existing files

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@querc/scffld",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "Simple code scaffolding tool using a Markdown file to define templates & properties",
   "main": "dist/index.js",
   "bin": "./dist/cli.js",

src/cli.ts

@@ -1,9 +1,12 @@
 #!/usr/bin/env node
 
+import { SHOW_COMMAND, show } from './cli/show.js';
 import { GENERATE_COMMAND, generate } from './cli/generate.js';
 import { scaffold } from './cli/scaffold.js';
 
-if (process.argv[2] === GENERATE_COMMAND) {
+if (process.argv[2] === SHOW_COMMAND) {
+  show(process.argv);
+} else if (process.argv[2] === GENERATE_COMMAND) {
   generate(process.argv);
 } else {
   scaffold(process.argv);

src/cli/loadTemplate.ts

@@ -1,9 +1,13 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import ora from 'ora';
+import ora, { Ora } from 'ora';
 
-export const loadTemplate = async (templateName: string): Promise<string> => {
+export const loadTemplate = async (
+  templateName: string,
+  options: { quiet?: boolean } = {}
+): Promise<string> => {
   let templateContent: string;
+  const { quiet } = options;
 
   if (
     templateName.startsWith('http:') ||
@@ -12,8 +16,11 @@ export const loadTemplate = async (templateName: string): Promise<string> => {
     templateName.startsWith('reg:')
   ) {
     // Remote template
-    console.log('');
-    const fetchSpinner = ora(`Fetching template ${templateName}...`).start();
+    let fetchSpinner: Ora | undefined = undefined;
+    if (!quiet) {
+      console.log('');
+      fetchSpinner = ora(`Fetching template ${templateName}...`).start();
+    }
     let url = templateName;
 
     if (templateName.startsWith('github:')) {
@@ -48,7 +55,9 @@ export const loadTemplate = async (templateName: string): Promise<string> => {
 
     const response = await fetch(url);
     templateContent = await response.text();
-    fetchSpinner.succeed();
+    if (fetchSpinner !== undefined && !quiet) {
+      fetchSpinner.succeed();
+    }
   } else {
     // Local template
     templateContent = fs

src/cli/show.ts

@@ -0,0 +1,10 @@
+import { loadTemplate } from './loadTemplate.js';
+
+export const SHOW_COMMAND = 'show';
+
+export const show = async (argv: string[]) => {
+  const templateName = argv[3];
+  const template = await loadTemplate(templateName, { quiet: true });
+
+  console.log(template);
+};