https://github.com/iamdevlinph/common-utils-pkg
A package of commonly used utilities
https://github.com/iamdevlinph/common-utils-pkg
Last synced: 9 months ago
JSON representation
A package of commonly used utilities
- Host: GitHub
- URL: https://github.com/iamdevlinph/common-utils-pkg
- Owner: iamdevlinph
- License: mit
- Created: 2018-06-26T02:23:39.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T01:51:36.000Z (about 1 year ago)
- Last Synced: 2025-04-12T06:18:55.472Z (9 months ago)
- Language: TypeScript
- Homepage: https://common-utils-pkg.js.org/
- Size: 2.16 MB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Common Utilities Package
A package of commonly used JavaScript utilities.
[Site](https://iamdevlinph.github.io/common-utils-pkg/) | [Docs](https://iamdevlinph.github.io/common-utils-pkg/docs.html)
#### Package Details
[![npm version][npm-img]][npm-url]
[![node version][node-img]][node-url]
[![coverage][codecov-img]][codecov-url]
[![downloads][downloads-img]][downloads-url]
#### Repo Details
[![open issues][issues-img]][issues-url]
[![open prs][pr-img]][pr-url]
[![contributors][contributor-img]][contributor-url]
# :tada: `v4` is here
v4 is just migrating the code base to TypeScript. Kindly refer to the [changelog](https://common-utils-pkg.js.org/changelog) for more info.
## `v3` is here
Version 3 introduces a code-breaking change. Each method is exported independently instead of having them under a "category utility". Read more on how to use it [here](https://iamdevlinph.github.io/common-utils-pkg/usage.html).
## Installation
NPM
```
npm i --save common-utils-pkg
```
Yarn
```
yarn add common-utils-pkg
```
## Usage
### ES6
```
// Specific methods
import { randomPastelColor } from 'common-utils-pkg';
randomPastelColor();
```
```
// All methods
import * as UTILS from 'common-utils-pkg';
UTILS.randomPastelColor();
```
### Browser
```
// Specific methods
const randomPastelColor = window['common-utils-pkg].randomPastelColor;
randomPastelColor();
```
```
// All methods
const UTILS = window['common-utils-pkg'];
UTILS.randomPastelColor();
```
Read more about the usage [here](https://iamdevlinph.github.io/common-utils-pkg/usage.html)
## Available Methods
Read more about the methods available [here](https://iamdevlinph.github.io/common-utils-pkg/docs.html)
## Features
* Transpile ES6 to ES5 using [Babel](https://github.com/babel/babel)
* Coverage using [Istanbul](https://github.com/gotwarlost/istanbul) with [nyc](https://github.com/istanbuljs/nyc) and report by [Codecov](https://github.com/codecov/codecov-node)
* Create the bundle using [webpack](https://github.com/webpack/webpack)
* Run tests using [Mocha](https://github.com/mochajs/mocha) and [chai](https://github.com/chaijs/chai)
* Lint stuff using [ESLint](https://github.com/eslint/eslint)
* Build status by [Travis](https://github.com/travis-ci/travis-ci)
* Precommit using [lint-staged](https://github.com/okonet/lint-staged) and [husky](https://github.com/typicode/husky)
* Provides TypeScript type definitions
# Contributing
1.Create a folder under `src/` and name the folder with the same name as the method.
2.Create `methodName.js` and `methodName.spec.js`
The full directory should look like this:
```
src/
methodName/
- methodName.js
- methodName.spec.js
```
3.If the method you are authoring has expected parameters then import `expects`
```js
import expects from '../expects/expects';
```
Wrap your exported function with `expects`
```js
export default expects(
methodName,
'methodName',
{ // required parameters
0: 'string', // 1st parameter is required and is a string
1: 'number', // 2nd parameter is required and is a number
},
{ // optional parameters
2: 'number' // 3rd parameter is optional but is a number
}
)
```
# Publishing
### Publish to NPM
To publish version, just create a relase tag and a github workflow will automatically handle the publishing to npm.
### Publish doc updates
Doc updates should be automatically be deployed once merged to main by github action.
[contributor-img]: https://img.shields.io/github/contributors/iamdevlinph/common-utils-pkg.svg?style=flat-square&maxAge=7200
[contributor-url]: https://github.com/iamdevlinph/common-utils-pkg/graphs/contributors
[deps-img]: https://img.shields.io/david/iamdevlinph/common-utils-pkg.svg?style=flat-square&maxAge=7200
[deps-url]: https://david-dm.org/iamdevlinph/common-utils-pkg
[devdeps-img]: https://img.shields.io/david/dev/iamdevlinph/common-utils-pkg.svg?style=flat-square&maxAge=7200
[devdeps-url]: https://david-dm.org/iamdevlinph/common-utils-pkg?type=dev
[downloads-img]: https://img.shields.io/npm/dm/common-utils-pkg.svg?style=flat-square&maxAge=7200
[downloads-url]: https://npmcharts.com/compare/common-utils-pkg?minimal=true
[issues-img]: https://img.shields.io/github/issues/iamdevlinph/common-utils-pkg.svg?style=flat-square&maxAge=7200
[issues-url]: https://github.com/iamdevlinph/common-utils-pkg/issues
[node-img]: https://img.shields.io/node/v/common-utils-pkg.svg?style=flat-square&maxAge=7200
[node-url]: https://nodejs.org/en/
[npm-img]: https://img.shields.io/npm/v/common-utils-pkg.svg?style=flat-square&maxAge=7200
[npm-url]: https://www.npmjs.com/package/common-utils-pkg
[pr-img]: https://img.shields.io/github/issues-pr/iamdevlinph/common-utils-pkg.svg?style=flat-square&maxAge=7200
[pr-url]: https://github.com/iamdevlinph/common-utils-pkg/pulls
[travis-img]: https://img.shields.io/travis/iamdevlinph/common-utils-pkg/master.svg?style=flat-square&maxAge=7200
[travis-url]: https://travis-ci.org/iamdevlinph/common-utils-pkg
[codecov-img]: https://img.shields.io/codecov/c/github/iamdevlinph/common-utils-pkg.svg?style=flat-square&maxAge=7200
[codecov-url]: https://codecov.io/gh/iamdevlinph/common-utils-pkg
[forks-img]: https://img.shields.io/github/forks/iamdevlinph/common-utils-pkg.svg?style=social&label=Fork&maxAge=7200
[forks-url]: https://github.com/iamdevlinph/common-utils-pkg/network/members
[stars-img]: https://img.shields.io/github/stars/iamdevlinph/common-utils-pkg.svg?style=social&label=Stars&maxAge=7200
[stars-url]: https://github.com/iamdevlinph/common-utils-pkg/stargazers