inquirerjs-checkbox-search 0.3.0 → 0.5.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 (2) hide show
  1. package/README.md +8 -0
  2. package/package.json +8 -2
package/README.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  A multi-select prompt with text filtering/search capability for [inquirer.js](https://github.com/SBoudrias/Inquirer.js).
4
4
 
5
+ ![Demo showing inquirerjs-checkbox-search in action](docs/img/basic-demo.gif)
6
+
5
7
  This prompt combines the functionality of `@inquirer/checkbox` and `@inquirer/search`, allowing you to:
6
8
 
7
9
  - ✅ **Multi-select** multiple options with checkboxes
@@ -234,6 +236,12 @@ npm run prepublishOnly # Full build + test + validation pipeline
234
236
  └── .prettierrc # Formatting config
235
237
  ```
236
238
 
239
+ #### Demo Generation
240
+
241
+ Demo GIFs are automatically generated in CI for PRs and releases: The [vhs](https://github.com/charmbracelet/vhs) tool is used to record the [examples](./examples/) and save them to GIFs in [`docs/img/`](./docs/img/)
242
+
243
+ To generate demos locally, run `npm run demo:generate:all` (requires `docker`).
244
+
237
245
  #### Quality Assurance Workflow
238
246
 
239
247
  1. **Before Committing**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "inquirerjs-checkbox-search",
3
- "version": "0.3.0",
3
+ "version": "0.5.0",
4
4
  "description": "A multi-select prompt with text filtering for inquirer.js",
5
5
  "keywords": [
6
6
  "answer",
@@ -80,7 +80,13 @@
80
80
  "typecheck": "tsc --noEmit",
81
81
  "attw": "attw --pack",
82
82
  "pkg:inspect": "rimraf package-inspect *.tgz && npm run build && npm pack && mkdir package-inspect && tar -xzf *.tgz -C package-inspect && echo '\\n📦 Package extracted to package-inspect/ for inspection'",
83
- "prepublishOnly": "npm run clean && npm run build && npm run test:ci && npm run attw"
83
+ "prepublishOnly": "npm run clean && npm run build && npm run test:ci && npm run attw",
84
+ "demo:docker:build": "docker build -f demos/Dockerfile -t vhs-node-demo .",
85
+ "demo:docker:run": "docker run --rm -v $PWD/docs/img:/workspace/docs/img vhs-node-demo",
86
+ "demo:generate": "node scripts/generate-demo.js",
87
+ "demo:generate:basic": "node scripts/generate-demo.js basic",
88
+ "demo:generate:validation": "node scripts/generate-demo.js validation",
89
+ "demo:generate:all": "node scripts/generate-demo.js all"
84
90
  },
85
91
  "dependencies": {
86
92
  "@inquirer/core": "^10.1.13",