{"_id":"@2600hz/js-utilities","_rev":"6-e7c67a1d7017729879c8007fbee54ede","name":"@2600hz/js-utilities","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@2600hz/js-utilities","version":"0.1.0","keywords":["utilities"],"author":{"url":"https://github.com/shark764","name":"Daniel Hernandez","email":"fhernandez@2600hz.com"},"license":"MIT","_id":"@2600hz/js-utilities@0.1.0","maintainers":[{"name":"dfhernandez-org","email":"farid.hdz.64@gmail.com"},{"name":"kinetic_pixels","email":"joshs@2600hz.com"},{"name":"armando-cierra","email":"armando_cierra@outlook.com"},{"name":"bitbashing","email":"karl@2600hz.com"}],"homepage":"https://github.com/2600hz/js-utilities#readme","bugs":{"url":"https://github.com/2600hz/js-utilities/issues"},"dist":{"shasum":"d8d3ef2a05f45d65aad2c0b1022541c70f3a811b","tarball":"https://registry.npmjs.org/@2600hz/js-utilities/-/js-utilities-0.1.0.tgz","fileCount":76,"integrity":"sha512-QQo/e7mV5GzevH7iZZ6kSEDrbzjXK92U1lPkAftdDULiI5wIOZDnQz2vndOy66FgfvV5x2CqWsRTqFgsMCocnQ==","signatures":[{"sig":"MEYCIQD9QwrRSfDxVcx68089/o/PhalHyx1TeZI2X7IQHe1yGQIhAJ7IGEdwpKrBmDa+VlfXi9y+MOLKuA6flR1idFSlExDA","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":72674,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhNRXoCRA9TVsSAnZWagAAUvwQAKUxODrTM0vMa5zyyZcp\nWEg5qqfz77FQD3Uq222n7qZ0GvE/f6Ry0l6SzAeTCXVQaTj8te5ZjBaEFhMP\nQs6ZOa42QqvioDiqKZo+KVTWO1M3K4haieJUf39vvZmHhJsJCQEBM3NhwWzj\n3IwHq4czy7L8UUndsbIpzzai9F0I0o+5htJdZidXKAjhGj2e2d2N6Tyg5hoA\nqPxnDzKeYksqdFj4o7Bbz1i3laMCWhefcwf4lzB0ns4wAqfil/WgSZQkgbgB\nOyCULBriUYBlzIW8YDsq3j5rViByaZz7jt/DLkUyDqqFCTFrSwxtrIJd/OYJ\nMlgqP/4LEwnYrZA3qrWJI/aYeUtW1tFkPDM5VVicZn6voRNZ/pEmvaaFu/fh\nK5Z/T02jjmmRpbLK0VIBigMZ+xqq2f18bvkySNHq4/Y5aoGjcd+iBPZWPbet\nuPcs5y0bxVcuiR5lvtjArGfZm5YxS9psZzmfOo1pBBaW1OnoTnWVyCO+SMgX\noc41ruH7xqjwd7B/5Pg5u06+yxDWmB2DK8L5KLoZZDnz9AUorPkjnSYuSrUq\ngQ4UnbmCzUZ+s82Pls9/xqARR7kzw6iR/LDITBnwBVaGe/I5uFVVKX3nC77Y\n4Ik/J4MXSEGkgU8LMbVVu2nPuJdvFfZMj0FtCKG0zHVYE+QxxU4LopX5HOe4\nH00G\r\n=GZtG\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","types":"lib/index.d.ts","source":"src/index","engines":{"node":">=14"},"gitHead":"2efa48123a05bdb8ed7e989573415d7a6371c84d","scripts":{"lint":"eslint \"**/*.{js,jsx,ts,tsx}\"","test":"jest --watchAll","build":"yarn clean && tsc","clean":"rimraf lib","format":"prettier --write \"**/*.+(js|jsx|ts|tsx|json)\"","prepare":"husky install","release":"release-it","lint:fix":"yarn lint --fix","prettify":"yarn run format && yarn run lint:fix","full-check":"yarn run prettify && yarn run typescript","pre-commit":"lint-staged","typescript":"tsc --noEmit"},"_npmUser":{"name":"dfhernandez-org","email":"farid.hdz.64@gmail.com"},"repository":{"url":"git+https://github.com/2600hz/js-utilities.git","type":"git"},"_npmVersion":"7.20.3","description":"Library written in JS that contains all useful functions and setups","directories":{},"_nodeVersion":"14.17.3","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^26.0.1","husky":"^7.0.0","eslint":"^7.32.0","rimraf":"^3.0.2","prettier":"^2.3.2","commitlint":"^11.0.0","release-it":"^14.2.2","typescript":"~4.0.0","lint-staged":"^11.1.2","eslint-plugin-node":"^11.1.0","eslint-plugin-import":"^2.24.2","eslint-plugin-promise":"^5.1.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^3.1.3","@typescript-eslint/parser":"^4.29.3","eslint-config-airbnb-base":"^14.2.1","@commitlint/config-conventional":"^13.1.0","@typescript-eslint/eslint-plugin":"^4.29.3","eslint-import-resolver-typescript":"^2.4.0","@release-it/conventional-changelog":"^2.0.0","eslint-config-standard-with-typescript":"^20.0.0"},"_npmOperationalInternal":{"tmp":"tmp/js-utilities_0.1.0_1630868967989_0.4912469121816039","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-09-05T19:09:27.945Z","modified":"2024-07-16T19:37:09.573Z","0.1.0":"2021-09-05T19:09:28.171Z"},"bugs":{"url":"https://github.com/2600hz/js-utilities/issues"},"author":{"url":"https://github.com/shark764","name":"Daniel Hernandez","email":"fhernandez@2600hz.com"},"license":"MIT","homepage":"https://github.com/2600hz/js-utilities#readme","keywords":["utilities"],"repository":{"url":"git+https://github.com/2600hz/js-utilities.git","type":"git"},"description":"Library written in JS that contains all useful functions and setups","maintainers":[{"email":"eduardolmedi00@gmail.com","name":"eduardodevolmedo"},{"email":"luis@2600hz.com","name":"lazedo"},{"email":"karl@2600hz.com","name":"bitbashing"},{"email":"armando_cierra@outlook.com","name":"armando-cierra"},{"email":"joshs@2600hz.com","name":"kinetic_pixels"}],"readme":"# 2600Hz - Commio\n## _JS Utilities Library_\n\nLibrary that contains all sharable utilities and configuration files, written in Javascript\n\n## Installation\n\n```sh\nyarn add @2600hz/js-utilities\n```\n\n## Usage\n\n```js\nimport { capitalize, humanize } from '@2600hz/js-utilities';\n\n// ...\n\n<Text>{capitalize(headerText)}</Text>\n<Button title={humanize(buttonName)} onPress={}.... />\n```\n\nYou can also import or require directly from folder\n\n```js\nconst {\n  prettierBaseConfig,\n} = require('@2600hz/js-utilities/lib/prettier-config');\n\nprettierBaseConfig.jsxBracketSameLine = false;\n\nmodule.exports = prettierBaseConfig;\n```\n\n**Configuration files**\nYou can extend any of the following configs:\n- eslint (_.eslintrc.js_)\n- prettier (_..prettierrc.js_)\n- release-it (_.release-it.js_)\n- commitlint (_commitlint.config.js_)\n- svgrrc (_.svgrrc.js_)\n- jest (_jest.config.js_)\n- lint-staged (_lint-staged.config.js_)\n- tsconfig (_tsconfig.json_)\n\nAll configuration files are imported and used same way, there are just two files that need different treatment\n\n*eslint*\nEslint file exports a function that receives the root folder\n\n```js\nconst {\n  eslintBaseConfig,\n} = require('@2600hz/js-utilities/lib/eslint-config');\n\nmodule.exports = eslintBaseConfig(__dirname);\n```\n\n*tsconfig*\nThis file must extends from any of the ts config files available\n```json\n{\n  \"extends\": \"@2600hz/js-utilities/tsconfig.base\",\n  \"compilerOptions\": {\n    \"baseUrl\": \"./\",\n    ...\n  },\n  \"exclude\": [...],\n  \"include\": [...],\n}\n  \n```\n\n## Development\n\nThis project requires [Node.js](https://nodejs.org/) v14+ to run.\n\nUsing *.nvmrc* file helps to normalize node version used by all maintainers.\nIf you are required to use version specified in this file, run these commands.\n\n```bash\nnvm use\nnvm install\n```\n\nUse the package manager [yarn](https://yarnpkg.com/getting-started/install) v1+ to install dependencies and devDependencies.\n\n```bash\nyarn install\nyarn\n```\n\n**Create symlink**\nRun the following command on package root folder, so you can consume on an app locally\n\n```bash\nyarn link\n```\n\n**Watch project**\nBuild package whenever there is a change\n```bash\nyarn watch\n```\n\n**Consume the package**\n`Both projects must be placed on same folder, otherwise won't work`\n```bash\nyarn link @2600hz/js-utilities\n```\n\nBuild the package\n_Automatically will build the project_\n```bash\nyarn build\n```\n\n## Utilities\n\nFormat code using [Eslint](https://eslint.org/)\n\n```bash\nyarn run lint:fix\n```\n\nFormat code using [Prettier](https://prettier.io/)\n```bash\nyarn run format\n```\n\nFormat code using [Prettier](https://prettier.io/) and [Eslint](https://eslint.org/)\n```bash\nyarn run prettify\n```\n\nCheck [Typescript](https://www.typescriptlang.org/docs/handbook/react.html) on files\n```bash\nyarn run typescript\n```\n\nRun full check\n```bash\nyarn run full-check\n```\n\n## Tech\nComponents library uses a number of open source projects to work properly:\n\n- [Typescript](https://www.typescriptlang.org/docs/handbook/react.html) - Strongly typed programming language which builds on JavaScript\n- [NodeJs](https://nodejs.org/es/) - Allows execute javascript scripts on the terminal\n- [Luxon](https://moment.github.io/luxon/) - library for dealing with dates and times in JavaScript (better alternative than Moment.js)\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nSee the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.\n\n**Commits**\nCommits must follow [conventional commit format](https://conventionalcommits.org/)\nMake sure your messages look like the following examples\n```\nfeat: Adding new badge component\nfix: Touchable component not being exported correctly\nfix!: Drop support for Typescript\n```\n_Note that the last one will generate a Major commit. It has the same result as adding a breaking change footer_\n\nFollow [Semantic Versioning 2.0.0](https://semver.org/) to update project version.\n\n[Release-It](https://github.com/release-it/release-it) will take care of versioning, you just have to give the correct type to commit:\n\n- **fix** - to indicate a bug fix (PATCH) ex . v0.0.1\n- **feat** - to indicate a new feature (MINOR) ex. v0.1.0\n- **chore** - for updates that do not require a version bump (.gitignore, comments, etc.)\n- **docs** - for updates to the documentation\n- **BREAKING CHANGE** - regardless of type, indicates a Major release (MAJOR) ex. v1.0.0\n\nVisit [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more examples.\n\n## License\n\nMIT\n","readmeFilename":"README.md"}