{"_id":"@boilertowns/node-package-boilerplate","name":"@boilertowns/node-package-boilerplate","dist-tags":{"latest":"0.0.0"},"versions":{"0.0.0":{"name":"@boilertowns/node-package-boilerplate","version":"0.0.0","description":"Your Node.js package","type":"module","exports":{"import":"./dist/index.esm.js","require":"./dist/index.cjs.js"},"main":"./dist/cjs/index.js","module":"./dist/esm/index.js","lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","prettier --write"],"*.{md,mdx,yml,json}":["prettier --write"]},"devDependencies":{"@changesets/cli":"^2.24.1","@commitlint/cli":"^17.0.3","@commitlint/config-conventional":"^17.0.3","@rollup/plugin-commonjs":"^22.0.2","@rollup/plugin-node-resolve":"^13.3.0","@trivago/prettier-plugin-sort-imports":"^3.2.0","@types/node":"^18.0.3","@typescript-eslint/eslint-plugin":"^5.30.5","@typescript-eslint/parser":"^5.30.5","eslint":"^8.19.0","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^4.2.1","husky":"^8.0.1","lint-staged":"^13.0.3","prettier":"^2.7.1","rollup":"^2.78.1","rollup-plugin-delete":"^2.0.0","rollup-plugin-terser":"^7.0.2","rollup-plugin-typescript2":"^0.33.0","typescript":"^4.8.2","vitest":"^0.22.1"},"engines":{"node":">=14.16"},"scripts":{"build":"rollup -c","release":"changeset publish","test":"vitest"},"_id":"@boilertowns/node-package-boilerplate@0.0.0","_integrity":"sha512-xLl21yAXP9QBBtLoIzyTDuewA6u69fPGWtMlMXq/VqXFtnZs+TiWJVP1NZoc29hQ4d+a8sAKRKKtQJgol3CXhw==","_resolved":"/tmp/602c2c5e767392223aecb8bd64b3debb/boilertowns-node-package-boilerplate-0.0.0.tgz","_from":"file:boilertowns-node-package-boilerplate-0.0.0.tgz","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-xLl21yAXP9QBBtLoIzyTDuewA6u69fPGWtMlMXq/VqXFtnZs+TiWJVP1NZoc29hQ4d+a8sAKRKKtQJgol3CXhw==","shasum":"2abfe8242d9f0ddd434127d0b0402922c31dad1e","tarball":"https://registry.npmjs.org/@boilertowns/node-package-boilerplate/-/node-package-boilerplate-0.0.0.tgz","fileCount":7,"unpackedSize":6007,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFAsPpyf4iXB0iTmS2Qbaulf7CWwDmpBDpF0Rp4t8qSuAiEAnFLARX5CYJfVpQolSE34IzYffZvrjcXAA7RVNFNIrUk="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjCIrKACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqBww//Uz8aKdnlRD378g7ZaU+9cYPHhmhKk5qOYX/aRYstA0T7Buy/\r\n6p7QzuTdU2DQQHrJsxHgh6WYZzzs9PdULPnwnbDA+nMLR0SWFAfYmmip+jzF\r\nbqaWho0t8CNjM/VRp01E7fSDJ5gusanXexRHzwlfAnr/mROVc1D2BI5ur5R4\r\n4b7be7Ct9Yry1WhgUzSdKreQwuL5swjvVP1TMxD2ctIV6AVFOeeqqhdPHm46\r\n80a5HT4UgduNTDo5jCemBsgmMXqEEieUe0TxKsfQgBrCPrbD+W1TvAJKhH6w\r\nEmipjX/ZfVkyUQNrY4IM7zjkxkME7qdJK1VFmodgs3s25IVVFW0zZQbyi0PN\r\nyz5u0V5Fjews5skgq95aAOtS5hlkN7ih6fGUlQ/J1GRTMNQ81fUyh9ICJI5I\r\nhhx77tbxS4e0b+u3V2U5PPPI0/vniqJolZ2nkxjwKnesl8BNvwnCpcZAx83P\r\nuvzXlhWOBg9qD2P2mfRk5i21Q6VTenbq3v6m0SI/10DELUvcMWZavaU4uVAh\r\nk4tBfyXIGQHFPpXH4/wJPZHn2Mx/F/aYRu76QgDBD4r0wndDl+dBBtvyzAU/\r\njvy5Wdffe7wBSJeCo6F9E45BfC0xUKpJ+k45v4tJNb3kmI0Zcl9rqJqMy/aX\r\n0XL29D/caYRbzeqyUNHajB3GHrGfkNOUAmQ=\r\n=egEt\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"phammikun","email":"mikun1993@gmail.com"},"directories":{},"maintainers":[{"name":"phammikun","email":"mikun1993@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/node-package-boilerplate_0.0.0_1661504202308_0.3731817541483946"},"_hasShrinkwrap":false}},"time":{"created":"2022-08-26T08:56:42.235Z","0.0.0":"2022-08-26T08:56:42.513Z","modified":"2022-08-26T08:56:42.709Z"},"maintainers":[{"name":"phammikun","email":"mikun1993@gmail.com"}],"description":"Your Node.js package","readme":"

♨️ Node Package Boilerplate

\n\n
\n

\n A boilerplate with opinionated setup to help you kickstart your own Node.js package.\n

\n \"MIT\n
\n\n## The Setup\n\n- [TypeScript][typescript-url]\n- Linting with [Eslint][eslint-url] and code formatting with [Prettier][prettier-url]\n- Conventional commit messages with [Commitlint][commitlint-url]\n- Build with [Rollup][rollup-url]\n- [Vitest][vitest-url] for Unit test\n- Automated release with [changesets][changesets-url]\n- Build library for Node.js 14 or newer.\n- Support both CJS & ESM.\n\n## Get Started\n\n- Use [Boilertowns](https://github.com/boilertowns/create-boilertowns) CLI.\n\n ```sh\n # npm\n npm create boilertowns@latest -- -b node-package-boilerplate\n\n # yarn\n yarn create boilertowns -b node-package-boilerplate\n\n # pnpm\n pnpm create boilertowns -b node-package-boilerplate\n\n # bun\n bun create boilertowns/node-package-boilerplate [package-name]\n ```\n\n- Click the green \"Use this template\" button to generate a new repository with the same structure and files.\n\n \"Use\n\n [Ref: Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)\n\n## Development\n\n- Run the package in development mode:\n\n ```sh\n pnpm dev\n ```\n\n- Build for production:\n\n ```sh\n pnpm build\n ```\n\n- Create changeset:\n\n ```sh\n pnpm changeset\n ```\n\n## Release & Publish\n\nThis boilerplate uses [changesets][changesets-url] to automatically generate `CHANGELOG`, create releases and publish to NPM registry via GitHub Actions. You can see action details at [release.yml](/.github/workflows//release.yml).\n\nTo automating publish your Node.js package, follow these steps:\n\n- Create a `NPM_TOKEN`. [See this article for more details](https://docs.npmjs.com/creating-and-viewing-access-tokens). Make sure the type of access token is **Automation**.\n\n- [Follow this instruction](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to add the created token to your GitHub Actions secrets. Name of the secret is `NPM_TOKEN`.\n\n- Install [changeset bot](https://github.com/apps/changeset-bot).\n\n- [Adding changeset and commit](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md#i-am-in-a-single-package-repository).\n\n**P/S**: Remember to check the `Allow GitHub Actions to create and approve pull requests` in your repo Settings > Actions > General & scroll to Workflow permissions.\n\n## Contributing\n\n**node-package-boilerplate** ❤️ your contributions. If you have any ideas, suggestions, fixes, feel free to contribute.\n\n[boilertowns-url]: https://github.com/boilertowns\n[typescript-url]: https://www.typescriptlang.org\n[eslint-url]: https://eslint.org\n[commitlint-url]: https://github.com/conventional-changelog/commitlint\n[prettier-url]: https://prettier.io\n[changesets-url]: https://github.com/changesets/changesets\n[rollup-url]: https://rollupjs.org\n[vitest-url]: https://vitest.dev/\n","readmeFilename":"README.md"}