Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boringcodes/utils
🍭 Boring Utilities - @boringcodes
https://github.com/boringcodes/utils
boringcodes eslint lint-staged npm prettier rollup standard-version typescript
Last synced: about 2 months ago
JSON representation
🍭 Boring Utilities - @boringcodes
- Host: GitHub
- URL: https://github.com/boringcodes/utils
- Owner: boringcodes
- License: mit
- Created: 2020-02-21T06:41:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T22:57:24.000Z (about 2 years ago)
- Last Synced: 2024-11-15T20:39:29.065Z (2 months ago)
- Topics: boringcodes, eslint, lint-staged, npm, prettier, rollup, standard-version, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@boringcodes/utils
- Size: 356 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
utils
Boring Utilities
## About
This package implements a number of common `Boring Utilities`.
## Installation
This is a [Node.js](https://nodejs.org/en/) module available through the
[npm registry](https://www.npmjs.com/).
Before installing, [download and install Node.js](https://nodejs.org/en/download/).
Node.js 10.0 or higher is required.
Installation is done using the
[`yarn add` command](https://classic.yarnpkg.com/en/docs/install/):
```bash
$ yarn add @boringcodes/utils
```
## Features
The following modules are included:
- [x] Node env detector
- [x] Custom logger
- [x] Custom errors classes
- [x] Error handler
- [x] Express middleware
## Usage
Then run the build command
```bash
yarn build
```
## Directories
```tree
.
├── .github/workflows
│ ├── create-github-release.yml
│ ├── main.yml
│ ├── publish-npm.yml
├── dist (generated after building)
├── src
│ ├── errorHandler.ts
│ ├── error.ts
│ ├── express.ts
│ ├── index.ts
│ ├── logger.ts
├── .gitignore
├── .hustkyrc
├── .prettierrc.js
├── CHANGELOG.md
├── LICENSE
├── package.json
├── README.md
├── rollup.config.js
├── tsconfig.json
├── tslint.json
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## Authors
[BoringCodes](https://github.com/boringcodes)
## License
[MIT](https://github.com/boringcodes/utils/blob/master/LICENSE)