{"_id":"s-formatters","name":"s-formatters","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"s-formatters","version":"1.0.0","description":"A template for creating npm packages using TypeScript","main":"./lib/index.js","scripts":{"build":"tsc --project tsconfig.build.json","clean":"rm -rf ./lib/","cm":"cz","lint":"eslint ./src/ --fix","prepare":"husky install","test:watch":"jest --watch","test":"jest --coverage","typecheck":"tsc --noEmit"},"repository":{"type":"git","url":"git+https://github.com/SebastianWesolowski/s-formatters.git"},"license":"MIT","author":{"name":"Sebastian Wesolowski","email":"SebastianWesolowski@users.noreply.github.com","url":"https://github.com/SebastianWesolowski"},"engines":{"node":">=18.17.1"},"keywords":["boilerplate","template","typescript","vscode","jest","husky","commitizen","semantic-release","codecov"],"bugs":{"url":"https://github.com/SebastianWesolowski/s-formatters/issues"},"homepage":"https://github.com/SebastianWesolowski/s-formatters#readme","devDependencies":{"@ryansonshine/commitizen":"^4.2.8","@ryansonshine/cz-conventional-changelog":"^3.3.4","@types/jest":"^27.5.2","@types/node":"^12.20.11","@typescript-eslint/eslint-plugin":"^4.22.0","@typescript-eslint/parser":"^4.22.0","conventional-changelog-conventionalcommits":"^5.0.0","eslint":"^7.25.0","eslint-config-prettier":"^8.3.0","eslint-plugin-node":"^11.1.0","eslint-plugin-prettier":"^3.4.0","husky":"^6.0.0","jest":"^27.2.0","lint-staged":"^13.2.1","prettier":"^2.2.1","@semantic-release/changelog":"^6.0.3","@semantic-release/git":"^10.0.1","semantic-release":"^21.0.1","ts-jest":"^27.0.5","ts-node":"^10.2.1","typescript":"^4.2.4"},"config":{"commitizen":{"path":"./node_modules/@ryansonshine/cz-conventional-changelog"}},"lint-staged":{"*.ts":"eslint --cache --cache-location .eslintcache --fix"},"release":{"branches":["main"],"plugins":[["@semantic-release/commit-analyzer",{"preset":"conventionalcommits","releaseRules":[{"type":"build","scope":"deps","release":"patch"}]}],["@semantic-release/release-notes-generator",{"preset":"conventionalcommits","presetConfig":{"types":[{"type":"feat","section":"Features"},{"type":"fix","section":"Bug Fixes"},{"type":"build","section":"Dependencies and Other Build Updates","hidden":false}]}}],["@semantic-release/changelog",{"changelogFile":"CHANGELOG.md"}],"@semantic-release/npm","@semantic-release/github",["@semantic-release/git",{"assets":["lib/**/*.{js,ts,d.ts}","package.json","CHANGELOG.md"],"message":"chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"}]]},"_id":"s-formatters@1.0.0","gitHead":"7716fa894d7d2729ef3b40a9ff2d77ebacdce084","types":"./lib/index.d.ts","_nodeVersion":"18.18.0","_npmVersion":"9.8.1","dist":{"integrity":"sha512-v8IjDELuANZtMsIF6uHz8nKBU/JI/NTFv0W3vj+5GRFNA8j4VrCeoPPIIsbHI3RUowWbd31Pk/EhOuw/2q/4Kg==","shasum":"953fcbf02bba9fe393af2694c5b58db1282094ba","tarball":"https://registry.npmjs.org/s-formatters/-/s-formatters-1.0.0.tgz","fileCount":5,"unpackedSize":8047,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDt32s3XfEJ8O43bEcF9en9pAjsADOCWfTP8iC/hlAHMwIgKHqu/XCDeO0/z3EMfbGaG3KeyX7TAPy5OVcIVuaJeBY="}]},"_npmUser":{"name":"sebastian.wesolowski.sw","email":"sebastian.wesolowski.sw@gmail.com"},"directories":{},"maintainers":[{"name":"sebastian.wesolowski.sw","email":"sebastian.wesolowski.sw@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/s-formatters_1.0.0_1696698080771_0.9693146104596859"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-07T17:01:20.771Z","1.0.0":"2023-10-07T17:01:21.037Z","modified":"2023-10-07T17:01:21.307Z"},"maintainers":[{"name":"sebastian.wesolowski.sw","email":"sebastian.wesolowski.sw@gmail.com"}],"description":"A template for creating npm packages using TypeScript","homepage":"https://github.com/SebastianWesolowski/s-formatters#readme","keywords":["boilerplate","template","typescript","vscode","jest","husky","commitizen","semantic-release","codecov"],"repository":{"type":"git","url":"git+https://github.com/SebastianWesolowski/s-formatters.git"},"author":{"name":"Sebastian Wesolowski","email":"SebastianWesolowski@users.noreply.github.com","url":"https://github.com/SebastianWesolowski"},"bugs":{"url":"https://github.com/SebastianWesolowski/s-formatters/issues"},"license":"MIT","readme":"# s-formatters\n\n> Template to kickstart creating a Node.js module using TypeScript and VSCode\n\nInspired by [node-module-boilerplate](https://github.com/sindresorhus/node-module-boilerplate)\n\n## Features\n\n- [Semantic Release](https://github.com/semantic-release/semantic-release)\n- [Issue Templates]\n- [GitHub Actions]\n- [Codecov](https://about.codecov.io/)\n- [VSCode Launch Configurations]\n- [TypeScript](https://www.typescriptlang.org/)\n- [Husky](https://github.com/typicode/husky)\n- [Lint Staged](https://github.com/okonet/lint-staged)\n- [Commitizen](https://github.com/search?q=commitizen)\n- [Jest](https://jestjs.io/)\n- [ESLint](https://eslint.org/)\n- [Prettier](https://prettier.io/)\n\n## Getting started\n\n### Set up your repository\n\nReplace `FULL_NAME`, `GITHUB_USER`, `NODE_VERSION` and `REPO_NAME` in the `./customize.sh` script with your own details to personalize your new package: \n\n```bash\nFULL_NAME=\"John Smith\"\nGITHUB_USER=\"johnsmith\"\nREPO_NAME=\"my-cool-package\"\nNODE_VERSION=\"18.17.1\"\n```\nAdd permission to edit `chmod +x ./customize.sh` and rund it `./customize.sh` \n\n### Add Tokens for NPM(**Automation**), Github, CodeCov\n\nAdd your npm token to your GitHub repository secrets as `NPM_TOKEN`, `GH_TOKEN` and `CODECOV_TOKEN`\n\n### Add Codecov integration\n\nEnable the Codecov GitHub App [here](https://github.com/apps/codecov).\n\n**Remove everything from here and above**\n\n---\n\n# s-formatters\n\n[![npm package][npm-img]][npm-url]\n[![Build Status][build-img]][build-url]\n[![Downloads][downloads-img]][downloads-url]\n[![Issues][issues-img]][issues-url]\n[![Code Coverage][codecov-img]][codecov-url]\n[![Commitizen Friendly][commitizen-img]][commitizen-url]\n[![Semantic Release][semantic-release-img]][semantic-release-url]\n\n> My awesome module\n\n## Install\n\n```bash\nnpm install s-formatters\n```\n\n## Usage\n\n```ts\nimport { myPackage } from 's-formatters';\n\nmyPackage('hello');\n//=> 'hello from my package'\n```\n\n## API\n\n### myPackage(input, options?)\n\n#### input\n\nType: `string`\n\nLorem ipsum.\n\n#### options\n\nType: `object`\n\n##### postfix\n\nType: `string`\nDefault: `rainbows`\n\nLorem ipsum.\n\n[build-img]:https://github.com/SebastianWesolowski/s-formatters/actions/workflows/release.yml/badge.svg\n[build-url]:https://github.com/SebastianWesolowski/s-formatters/actions/workflows/release.yml\n[downloads-img]:https://img.shields.io/npm/dt/s-formatters\n[downloads-url]:https://www.npmtrends.com/s-formatters\n[npm-img]:https://img.shields.io/npm/v/s-formatters\n[npm-url]:https://www.npmjs.com/package/s-formatters\n[issues-img]:https://img.shields.io/github/issues/SebastianWesolowski/s-formatters\n[issues-url]:https://github.com/SebastianWesolowski/s-formatters/issues\n[codecov-img]:https://codecov.io/gh/SebastianWesolowski/s-formatters/branch/main/graph/badge.svg\n[codecov-url]:https://codecov.io/gh/SebastianWesolowski/s-formatters\n[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-release-url]:https://github.com/semantic-release/semantic-release\n[commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\n[commitizen-url]:http://commitizen.github.io/cz-cli/\n","readmeFilename":"README.md"}