@qrdx/cli 0.0.8 → 0.0.10

package/README.md

@@ -47,7 +47,7 @@ qrdx generate <data> [options]
 | `--logo` | | — | Center logo image URL (use with `--level H`) |
 | `--no-logo` | | — | Skip the logo prompt in interactive mode |
 | `--margin` | | `0` | Quiet zone margin (modules) |
-| `--template` | | — | Decorative template: `Arrow` `StandardBox` `SquareBorder` `StrikedBox` `Halloween` |
+| `--template` | | — | A frame drawn as a template (the whole file is `--size`, the code smaller inside it): `Arrow` `StandardBox` `SquareBorder` `StrikedBox` `Halloween` `DotRing` |
 | `--frame` | | — | Call-to-action frame: <!-- catalogue:FRAME_STYLES -->`none`, `banner-bottom`, `banner-top`, `border`, `rounded-border`, `speech-bubble`, `banner-top-bottom`, `speech-bubble-top`, `chat-bubble`, `circle`, `polaroid`, `phone`, `ticket`, `badge`, `envelope`, `tag`, `menu-card`, `sticker`, `gradient-border`, `focus`<!-- /catalogue --> |
 | `--frame-text` | | `Scan me` | Frame label, up to 24 characters (`""` hides it) |
 | `--frame-color` | | `#000000` | Frame color (hex) |
@@ -87,7 +87,7 @@ qrdx generate "https://qrdx.dev" \
 qrdx generate "https://qrdx.dev" -o gradient.svg \
   --fg '{"type":"linear","stops":[{"color":"#6366f1","offset":0},{"color":"#ec4899","offset":100}],"angle":135}'
 
-# Template
+# A frame drawn as a template
 qrdx generate "https://qrdx.dev" --template Arrow -o arrow.svg
 
 # "Scan me" frame
@@ -140,7 +140,7 @@ Each gradient needs at least 2 stops; `offset` is a percentage from 0 to 100.
 
 ## Interactive mode
 
-When run in a TTY without an output path or data, `qrdx generate` starts a guided prompt flow: data, output path, then optional customizations (patterns, colors, template, logo, margin). In CI (`CI=true`) or when stdin/stdout is not a TTY it never prompts.
+When run in a TTY without an output path or data, `qrdx generate` starts a guided prompt flow: data, output path, then optional customizations (patterns, colors, frame, logo, margin). In CI (`CI=true`) or when stdin/stdout is not a TTY it never prompts.
 
 ## Requirements
 

package/dist/index.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 import { readFileSync, mkdirSync, writeFileSync, createReadStream } from 'fs';
 import { join, resolve, extname } from 'path';
+import { BODY_PATTERN, CORNER_EYE_PATTERNS, CORNER_EYE_DOT_PATTERNS, BUILT_IN_FRAMES, getAllTemplates, DEFAULT_FRAME_TEXT, FRAME_TEXT_MAX_LENGTH, DEFAULT_MARGIN, getFrameDimensions, getTemplateIds, colorConfigSchema, errorLevelSchema, QRCodeSVG, svgToEPS, FRAME_STYLES } from 'qrdx';
 import { readFile } from 'fs/promises';
-import { BODY_PATTERN, CORNER_EYE_PATTERNS, CORNER_EYE_DOT_PATTERNS, getTemplateIds, FRAME_STYLES, DEFAULT_FRAME_TEXT, FRAME_TEXT_MAX_LENGTH, DEFAULT_MARGIN, getFrameDimensions, colorConfigSchema, errorLevelSchema, QRCodeSVG, svgToEPS } from 'qrdx';
 import { getQRAsPNG } from 'qrdx/node';
 import { createElement } from 'react';
 import { renderToStaticMarkup } from 'react-dom/server';
@@ -234,6 +234,7 @@ var RESET = "\x1B[0m";
 var TEXT = "\x1B[38;5;145m";
 var GREEN = "\x1B[38;5;114m";
 var DIM = "\x1B[38;5;102m";
+var TEMPLATE_CHOICE = "template:";
 var HEX_COLOR = /^#(?:[0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$/i;
 var MAX_PNG_SIZE = 1e4;
 function parseColorFlag(value) {
@@ -824,31 +825,31 @@ async function runGenerate(args, meta) {
       const dotVal = res;
       dotColor = dotVal ? parseColorFlag(dotVal) : void 0;
     }
-    if (!flags.template) {
-      const templateIds = getTemplateIds();
+    if (flags.frame === void 0 && !frame && !flags.template) {
       const res = await p.select({
-        message: `Template ${DIM}(decorative wrapper around the QR code)${RESET}`,
+        message: `Frame ${DIM}(around the code)${RESET}`,
         options: [
-          { value: "", label: "none" },
-          ...templateIds.filter((id) => id !== "default").map((id) => ({ value: id, label: id }))
+          { value: "none", label: "none" },
+          ...BUILT_IN_FRAMES.map((item) => ({
+            value: item.style,
+            label: item.style,
+            hint: item.name
+          })),
+          ...getAllTemplates().filter((item) => item.id !== "default").map((item) => ({
+            value: `${TEMPLATE_CHOICE}${item.id}`,
+            label: item.id,
+            hint: `${item.name} (--template)`
+          }))
         ],
-        initialValue: ""
-      });
-      if (isCancel2(res)) {
-        handleCancel();
-      }
-      template = res || void 0;
-    }
-    if (flags.frame === void 0 && !frame) {
-      const res = await p.select({
-        message: `Frame ${DIM}(call-to-action label around the code)${RESET}`,
-        options: FRAME_STYLES.map((style) => ({ value: style, label: style })),
         initialValue: "none"
       });
       if (isCancel2(res)) {
         handleCancel();
       }
-      if (res !== "none") {
+      const choice = res;
+      if (choice.startsWith(TEMPLATE_CHOICE)) {
+        template = choice.slice(TEMPLATE_CHOICE.length);
+      } else if (choice !== "none") {
         const text2 = await p.text({
           message: `Frame text ${DIM}(up to ${FRAME_TEXT_MAX_LENGTH} characters)${RESET}`,
           placeholder: DEFAULT_FRAME_TEXT,
@@ -863,7 +864,7 @@ async function runGenerate(args, meta) {
           handleCancel();
         }
         frame = {
-          style: res,
+          style: choice,
           text: text2 || DEFAULT_FRAME_TEXT
         };
       }
@@ -1244,8 +1245,8 @@ ${BOLD}Generate Options:${RESET3}
   --no-logo           Skip the logo prompt in interactive mode
   --margin            Quiet zone margin in modules  ${DIM3}(default: 0)${RESET3}
   --size              Output pixel size for SVG/PNG/WebP  ${DIM3}(default: 512)${RESET3}
-  --template          Decorative template wrapper:
-                        ${DIM3}Arrow, StandardBox, SquareBorder, StrikedBox, Halloween${RESET3}
+  --template          A frame drawn as a template (the whole artwork is --size):
+                        ${DIM3}${getTemplateIds().filter((id) => id !== "default").join(", ")}${RESET3}
   --frame             Call-to-action frame (adds space around the code), e.g.:
                         ${DIM3}none, banner-bottom, banner-top, rounded-border,${RESET3}
                         ${DIM3}speech-bubble, polaroid, phone, ticket, sticker${RESET3}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrdx/cli",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "QR code generator CLI for developers: styled SVG, PNG, WebP and vector EPS QR codes from the command line",
   "keywords": [
     "qr-code",
@@ -45,7 +45,7 @@
   "dependencies": {
     "@clack/prompts": "^1.8.1",
     "picocolors": "^1.1.1",
-    "qrdx": "0.0.50",
+    "qrdx": "0.0.53",
     "react": "19.3.1",
     "react-dom": "19.3.1"
   },