🙀 Elasticsearch Query Builder
A class for building a valid ElasticSearch query search expression, using best practices for each operators.
Clone from the current repo and then run the following command inside the root folder:
npm are included as follows:
testruns the unit test suites
commitwizard for creating a commit message that will automatically add interesting stuff to changelog and have a meaning. You may also use
git czif you install
npm i -g commitizen
semantic-releasewill be responsible for releasing the proper version to npm and add changelog.
watch-testautomatically re-runs your test suite when code in
full-testruns tests, lint fix and outdated module check
lintruns ESLint which find problematic patterns in code
fix-lintruns ESLint with --fix flag to fix problematic patterns in code
prettierruns prettier opinionated code formatter to align style of code
watch-fix-lintautomatically fix ESLint issues when code in
coverageruns nyc to produce a test coverage report
davidwhich check if package npm dependencies are out of date
nspwhich check if package npm dependencies have security issues
🤵 Directory Layout
.├── test/ # Unit, integration and load tests├── index.js # Node.js file (entery point)├── Dockerfile # Commands for building a Docker image for production├── Jenkinsfile # Commands for building in Jenkins CI├── Makefile # Commands as described below└── package.json # The list of project dependencies
npm run fix-lint
Istanbul is used to produce a test coverage report. Look inside the
coverage folder after running
npm run coverage to see the results.
npm run coverage
There is no need to deploy once your tests have passed and your branch has merged with master. However you may have to update your
package.json to the newest version, in the repo that is using this package, depending on how your
package.json is configured.
Pull requests are welcome. For major changes, please discuss first what you would like to change and why. Please make sure to update tests as appropriate.