{"_id":"@dwmkerr/inquirer-advanced-input-prompt","name":"@dwmkerr/inquirer-advanced-input-prompt","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@dwmkerr/inquirer-advanced-input-prompt","version":"0.1.0","description":"An Inquirer.js input prompt that offers 'hints' displayed below the input field, useful for providing instructions to users.","author":{"name":"dwmkerr"},"main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc","build:watch":"tsc -w","start":"ts-node src/demo.ts","start:debug":"node --inspect-brk node_modules/.bin/ts-node ./src/demo.ts","lint":"eslint .","lint:fix":"eslint --fix .","test":"jest --no-coverage","test:debug":"node --inspect-brk node_modules/.bin/jest --runInBand --no-coverage","test:watch":"jest --watch --no-coverage","test:cov":"jest --coverage","tsc":"tsc","prepare":"husky"},"repository":{"type":"git","url":"git+https://github.com/dwmkerr/inquirer-advanced-input-prompt.git"},"keywords":["inquirer","prompt","custom","cli"],"peerDependencies":{"inquirer":">=8.0.0"},"dependencies":{"@inquirer/core":"^10.1.8","@inquirer/type":"^3.0.5","chalk":"^4.1.2"},"devDependencies":{"@types/inquirer":"^9.0.7","@types/jest":"^29.5.14","@types/mock-fs":"^4.13.4","@types/node":"^22.13.10","@typescript-eslint/eslint-plugin":"^6.19.0","eslint":"^8.53.0","eslint-config-prettier":"^8.0.0","eslint-plugin-prettier":"^5.2.3","husky":"^9.1.7","jest":"^29.7.0","mock-fs":"^5.2.0","ts-jest":"^29.2.6","ts-node":"^10.9.2","typescript":"^5.8.2"},"license":"MIT","_id":"@dwmkerr/inquirer-advanced-input-prompt@0.1.0","gitHead":"7a8eaa1703221eeb34e2b42b57647cfddbfa9460","bugs":{"url":"https://github.com/dwmkerr/inquirer-advanced-input-prompt/issues"},"homepage":"https://github.com/dwmkerr/inquirer-advanced-input-prompt#readme","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-DJRxijz5SYhrYKioRTcPykjDnkSW6obup/vZogtehZn0XPBYCrHDLHI5Qs8h9pcvH2mdHay0bRwh+i4igwUn9w==","shasum":"9bd5c2d8d142dcde0638a52519b383aef45486bd","tarball":"https://registry.npmjs.org/@dwmkerr/inquirer-advanced-input-prompt/-/inquirer-advanced-input-prompt-0.1.0.tgz","fileCount":10,"unpackedSize":12910,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIHlp8Wk6pQfcvguIEmf1YDfhznA0OwpiASyGgMVSofqYAiBFIgLe5o5gylrCOgvliYGKlFUtxKUbY+tiIAE9IH6kyw=="}]},"_npmUser":{"name":"dwmkerr-admin","email":"dwmkerr@gmail.com"},"directories":{},"maintainers":[{"name":"dwmkerr-admin","email":"dwmkerr@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/inquirer-advanced-input-prompt_0.1.0_1741724232966_0.960322693218536"},"_hasShrinkwrap":false}},"time":{"created":"2025-03-11T20:17:12.871Z","0.1.0":"2025-03-11T20:17:13.141Z","modified":"2025-03-11T20:17:13.462Z"},"maintainers":[{"name":"dwmkerr-admin","email":"dwmkerr@gmail.com"}],"description":"An Inquirer.js input prompt that offers 'hints' displayed below the input field, useful for providing instructions to users.","homepage":"https://github.com/dwmkerr/inquirer-advanced-input-prompt#readme","keywords":["inquirer","prompt","custom","cli"],"repository":{"type":"git","url":"git+https://github.com/dwmkerr/inquirer-advanced-input-prompt.git"},"author":{"name":"dwmkerr"},"bugs":{"url":"https://github.com/dwmkerr/inquirer-advanced-input-prompt/issues"},"license":"MIT","readme":"# inquirer-advanced-input-prompt\n\n[![cicd](https://github.com/dwmkerr/inquirer-advanced-input-prompt/actions/workflows/cicd.yaml/badge.svg)](https://github.com/dwmkerr/inquirer-advanced-input-prompt/actions/workflows/cicd.yaml) ![npm (scoped)](https://img.shields.io/npm/v/%40dwmkerr/inquirer-advanced-input-prompt) [![codecov](https://codecov.io/gh/dwmkerr/inquirer-advanced-input-prompt/graph/badge.svg?token=oHFSLfOHGd)](https://codecov.io/gh/dwmkerr/inquirer-advanced-input-prompt)\n\nAn input prompt implementation for [Inquirer](https://github.com/SBoudrias/Inquirer.js/) that provides some advanced features.\n\nOut of the box, this prompt works just like the [`input`](https://github.com/SBoudrias/Inquirer.js/?tab=readme-ov-file#input) prompt.\n\nThis is work in progress - I'm using it to improve the user experience of [Terminal AI](http://github.com/dwmkerr/inquirer-advanced-input-prompt). Things may not work as expected. When the API stabalises and is well-tested then the demo will be updated and linked back to the original project.\n\n## Installation\n\n```sh\nnpm install @dwmkerr/advanced-input-prompt\n```\n\n## Features\n\nThe `hint` parameter shows a hint below the input prompt. As soon as the user starts typing, the hint is hidden:\n\n## Usage\n\n```js\nimport prompt from \"./advanced-input-prompt\";\n\nasync function demo() {\n  const answer = await prompt({\n    message: \"Enter your input (required):\",\n    hint: \"<Enter> Show Menu\",\n    required: true,\n    validate: (input: string) => input.trim() !== \"\" || \"Input cannot be empty\",\n  });\n  console.log(`User input: ${answer1}`);\n}\n\n(async () => {\n  await demo();\n})();\n```\n\n## Developer Guide\n\nClone the repo, install dependencies and use `npm start` to run the demo:\n\n```bash\ngit clone git@github.com:dwmkerr/inquirer-advanced-input-prompt\ncd inquirer-advanced-input-prompt\nnpm install\nnpm start\n```\n\n","readmeFilename":"README.md","_rev":"1-13b5745ee678e80649742e7b87f954eb"}