https://github.com/creemama/utiljs

Reusable JavaScript utilities for Node.js
https://github.com/creemama/utiljs

javascript javascript-library javascript-tools node nodejs

Last synced: 8 months ago
JSON representation

Reusable JavaScript utilities for Node.js

• Host: GitHub
• URL: https://github.com/creemama/utiljs
• Owner: creemama
• License: mit
• Created: 2018-06-30T07:04:29.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-07-19T02:26:55.000Z (over 2 years ago)
• Last Synced: 2025-04-16T00:11:24.555Z (8 months ago)
• Topics: javascript, javascript-library, javascript-tools, node, nodejs
• Language: JavaScript
• Homepage:
• Size: 1.4 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Util.js

> Reusable JavaScript utilities for Node.js



  



Util.js is a [Lerna](https://lerna.js.org/) monorepo with the following packages:

| Package                                                                                              |                                                                            NPM Status                                                                            |

| ---------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: |

| [@util.js/arrays](https://github.com/creemama/utiljs/tree/master/packages/utiljs-arrays)             |              |

| [@util.js/aws](https://github.com/creemama/utiljs/tree/master/packages/utiljs-aws)                   |                    |

| [@util.js/emails](https://github.com/creemama/utiljs/tree/master/packages/utiljs-emails)             |              |

| [@util.js/errors](https://github.com/creemama/utiljs/tree/master/packages/utiljs-errors)             |              |

| [@util.js/jquery](https://github.com/creemama/utiljs/tree/master/packages/utiljs-jquery)             |              |

| [@util.js/node-files](https://github.com/creemama/utiljs/tree/master/packages/utiljs-node-files)     |      |

| [@util.js/node-http](https://github.com/creemama/utiljs/tree/master/packages/utiljs-node-http)       |        |

| [@util.js/node-lerna](https://github.com/creemama/utiljs/tree/master/packages/utiljs-node-lerna)     |      |

| [@util.js/node-streams](https://github.com/creemama/utiljs/tree/master/packages/utiljs-node-streams) |  |

| [@util.js/node-timers](https://github.com/creemama/utiljs/tree/master/packages/utiljs-node-timers)   |    |

| [@util.js/numbers](https://github.com/creemama/utiljs/tree/master/packages/utiljs-numbers)           |            |

| [@util.js/objects](https://github.com/creemama/utiljs/tree/master/packages/utiljs-objects)           |            |

| [@util.js/privates](https://github.com/creemama/utiljs/tree/master/packages/utiljs-privates)         |          |

| [@util.js/promises](https://github.com/creemama/utiljs/tree/master/packages/utiljs-promises)         |          |

| [@util.js/strings](https://github.com/creemama/utiljs/tree/master/packages/utiljs-strings)           |            |

The anatomy for each package is loosely based on ["Directory structure for JavaScript/Node Projects"](https://gist.github.com/tracker1/59f2c13044315f88bee9).

Use [conventional commits](https://github.com/pvdlg/conventional-changelog-metahub) for commit messages.

See scripts/README.md for information on the scripts used to maintain this project.

## Maintenance

The scripts in this directory do the following:

- Run a Docker container for development.

  - `./dev.sh docker`

- Install and update dependencies. Use [fix] as the commit type.

  - `./dev.sh docker-update-dockerfile`

  - `./dev.sh docker-update`

  - `./dev.sh install-globals` - used in docker/Dockerfile

  - `./dev.sh install-dev-globals` - used in docker/Dockerfile

  - `./dev.sh install`

  - `./dev.sh audit`

  - `npm audit fix && ./dev.sh install` - run if an audit finds something

- Format and run a linter.

  - `./dev.sh prettier` (Use [style] as the commit type.)

  - `./dev.sh eslint`

  - `` prettier --write `git ls-files -m` ``

  - `./dev.sh shell-format`

- Update documentation. Use [docs] as the commit type.

  - `./dev.sh jsdoc`

  - `./dev.sh jsdoc2md`

  - `./dev.sh prettier`

  - `git commit -am "style: run prettier"`

- Test and publish.

  - `./dev.sh clean`

  - `./dev.sh babel`

  - `./dev.sh build` - executes clean and babel

  - `./dev.sh mocha`

  - `npm run test` - executes mocha

  - `./dev.sh publish` - bumps up the version number