zd-search-cli
Getting Started
git clone git@github.com:vorks/zd-search-cli.git
cd zd-search-cli
npm install
node ./src/index.js
It is also hosted on npm:
npm i -g zd-search-cli
However, I was unable to get my machine to recognize the command "zd-search-cli". I think this is because in my attempts to install a local copy globally, I have messed up npm that I would have to spend some time rectifying. So others may enjoy better luck. Give it a go and let me know how it goes!
Run Test Suite
npm install
npm test
The system tests ((.*-search|welcome).test.js) may fail as they rely on a timeout to ensure user input is received correctly. I have set a timeout that works for my machine, but it may not work for yours. If these tests fail for you, increase the timeout found in cmd.js.
Test Coverage
Performance Test
19066 users queried in 7 seconds
Dependencies
Inquirer.js
Inquirer.js provides all the heavy lifting in printing questions and parsing answers. The critical reasons for use were the smooth implementation of hierarchical prompts, error handling out of the box, and improved UX. Typing in answers for selection is not a pleasant experience; navigation through directions keys is far more natural.
Potential improvements
- Intelligent search
- Take data source as environment variables
- Cross-functionality between json, csv, SQL, and NoSQL
- Improved output formatting
- Multiple search parameters at once
- Allow searching within ranges
- Allow multiple date formats to still match with differently formatted date values
- Configurable output style to allow integrations and useful copy+paste
- Configurable output fields
- Improved system tests implementation
- Implement in TypeScript
- Implement a GUI
Task
