Repository containing javascript utility methods for string, date and regex based manipulation
- Clone this repository and install its dependencies
$ git clone https://github.com/copartit/front-end-utils
$ cd front-end-utils
$ yarn install && yarn typed
yarn typed
searches the libdef repo and download all the libdefs that are relevant for project and install them.
- Watch files and recompile whenever they change
$ yarn start
yarn start
builds the library, then keeps rebuilding it whenever the source files change.
- Compile and bundle code
$ yarn build
yarn build
builds the library to dist
, generating three major files:
-
dist/frontendutils.cjs.js
a CommonJS bundle, suitable for use in Node.js, that requires the external dependency. This corresponds to the"main"
field in package.json -
dist/frontendutils.esm.js
an ES module bundle, suitable for use in other people's libraries and applications, that imports the external dependency. This corresponds to the"module"
field in package.json -
dist/frontendutils.umd.js
a UMD build, suitable for use in any environment (including the browser, as a <script> tag), that includes the external dependency. This corresponds to the"browser"
field in package.json
- Check the code quality
$ yarn lint
yarn lint
checks the code, whether it meets Airbnb's JavaScript style guide, and type checking using Flow.
- Run the unit tests
$ yarn test
yarn test
runs the unit tests using Jest to check if the function is executable.