@n10l/js-essential-utils v0.1.4
js-essential-utils
Essential minimalistic javascript utils for any modern application
- Generated using boilerplate https://github.com/hackingbay/js-package-minimal-boilerplate
If using yarn:
yarn add @n10l/js-essential-utils
If using npm:
npm install @n10l/js-essential-utils
To use in code:
Declare import { canUseDOM } from '@n10l/js-essential-utils'
Then use like if (canUseDOM) {} in your code.
To optimize bundle size if only specific util/function is used in project, its file can be directly references in the code as:
import { canUseDOM } from '@n10l/js-essential-utils/web'
or
import * from '@n10l/js-essential-utils/web'
or
import { canUseDOM } from '@n10l/js-essential-utils/web/can-use-dom'
Explore code in github repo for full set of utils.
TODO
- Add unit tests
- Create documentation for all utils
Editor Configuration
- Editor of your preference. I used some VSCode specific config in .vscode folder and recommend plugins for enhanced experience.
Recommended VSCode Extensions:
- Prettier (Official) - Code formatter
- ESLint (Official) - Real time JS syntax validation
Technologies Used
- Rollup.js
- Yarn
- Babel
- Prettier + ESlint
- Jest lint setup, jest can be added
Available Scripts For development
In the project directory, you can run:
yarn build
To build the project
yarn fix:all
Runs prettier formatter followed by eslint and stylelint, to format code and fix lint issues. Prettier is not good enough to run alone, must always be followed lint fixes included in this command.