{"_id":"@boilertown/node-package-boilerplate","name":"@boilertown/node-package-boilerplate","dist-tags":{"latest":"0.0.0"},"versions":{"0.0.0":{"name":"@boilertown/node-package-boilerplate","version":"0.0.0","description":"Your Node.js package","exports":{"import":"./dist/index.esm.js","require":"./dist/index.cjs.js"},"main":"./dist/index.cjs.js","module":"./dist/index.esm.js","types":"dist/types/index.d.ts","lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","prettier --write"],"*.{md,mdx,yml,json}":["prettier --write"]},"devDependencies":{"@babel/core":"^7.20.12","@babel/plugin-transform-runtime":"^7.19.6","@babel/preset-env":"^7.20.2","@changesets/cli":"^2.26.0","@commitlint/cli":"^17.4.1","@commitlint/config-conventional":"^17.4.0","@rollup/plugin-babel":"^6.0.3","@rollup/plugin-commonjs":"^24.0.0","@rollup/plugin-node-resolve":"^15.0.1","@rollup/plugin-terser":"^0.3.0","@trivago/prettier-plugin-sort-imports":"^4.0.0","@types/node":"^18.11.18","@typescript-eslint/eslint-plugin":"^5.48.1","@typescript-eslint/parser":"^5.48.1","eslint":"^8.31.0","eslint-config-prettier":"^8.6.0","eslint-plugin-prettier":"^4.2.1","husky":"^8.0.3","lint-staged":"^13.1.0","prettier":"^2.8.2","rollup":"^2.79.1","rollup-plugin-delete":"^2.0.0","rollup-plugin-typescript2":"^0.34.1","typescript":"^4.9.4","vitest":"^0.27.1"},"engines":{"node":">=14.16"},"scripts":{"build":"rollup -c","test":"vitest","changeset":"changeset","release":"changeset publish"},"_id":"@boilertown/node-package-boilerplate@0.0.0","_integrity":"sha512-/YW6GBQ+twQtBk0k8sX9rTs9r3mATv8ogVNnTy8JyQyAZhqysIu3OhyzDZiIhn0po4KVKpaioTcbsN9Bpn1TWw==","_resolved":"/tmp/33e65df971408c0fde4311dc3af87cc4/boilertown-node-package-boilerplate-0.0.0.tgz","_from":"file:boilertown-node-package-boilerplate-0.0.0.tgz","_nodeVersion":"16.18.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-/YW6GBQ+twQtBk0k8sX9rTs9r3mATv8ogVNnTy8JyQyAZhqysIu3OhyzDZiIhn0po4KVKpaioTcbsN9Bpn1TWw==","shasum":"27cfe1bf41d420ef4001e98fea52508e1332747a","tarball":"https://registry.npmjs.org/@boilertown/node-package-boilerplate/-/node-package-boilerplate-0.0.0.tgz","fileCount":7,"unpackedSize":6166,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAkTCUFg0+mGcz+hIva9grObjYp7AoSCku+fC4LKPKwOAiBgRMlyHt5wNXkaZfdCX5lPzpia8+pkTJAjM3xfo0N77w=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjv7GPACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpLbQ/+OFkHD4f3YiVbJl6fVDo4/fVEPC8e7s4SR+JcbiNXDfdJzC+U\r\nkaKdSDR/uuwDzYOAguuuwH4R9uhXxjJidjqubATJGD92vyaKdJiA1ihuyEpW\r\nkfnMbhfKlCoi3yDltRpYQstzBvWu57sA3ZORl8HcgI/rlmyCs/DfRR7I0xxY\r\nytps3R1Ndu8ECdtVuXU/cgCHEvAVmUoy0cY3ZDX3WRmcVHeuqvy1vTxiJVWF\r\nnX/fMWABLEWRUUJbem0+h8+YHeIyHHmUI84zSf7oKi+BCT2eloLSVXEsjuta\r\ncuGlrDV9xNiGNKK2J3jbKuCPMSbg0OL2y0qMggUUBVbihOYpOHeI7hP0VLrU\r\n45Bfm9gLlBfZ9qYYgDIO+xDZ7wd9Cqbuz3STinBC0PrZFtc/CU19Qkz5agGX\r\n3xDLcXATobs36LWiOalwSwmZfOqx7SDhA2OxH81YQCtd2cs0QSULOyLh92Dq\r\nN9aC2xV0GmqeHjQqfB5xgDLb9HJEZrj+aNzfY4vWwRpuMbyMiC3dZX+hJvXt\r\nXHNh2a8EI3AN/gwTi+NQUEF0Gse8TauKuILdbxqGX1ZvCKDZ2bLN4kT/H+0J\r\nRWYXWc+5kwmzMc9mN7yvmRTO3VG4Mu7XqedoHJkl5r31Gg53rY2hF/SdtrS7\r\nhhMz7NuL4yNJ/n+o9Z1RQLqlHW9lxnj2l+4=\r\n=+KHZ\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_1673507215366_0.13711248320790892"},"_hasShrinkwrap":false}},"time":{"created":"2023-01-12T07:06:55.299Z","0.0.0":"2023-01-12T07:06:55.524Z","modified":"2023-01-12T07:06:55.699Z"},"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 [Boilertown](https://github.com/boilertown/create-boilertown) CLI.\n\n ```sh\n # npm\n npm create boilertown@latest -- -b node-package-boilerplate\n\n # yarn\n yarn create boilertown -b node-package-boilerplate\n\n # pnpm\n pnpm create boilertown -b node-package-boilerplate\n\n # bun\n bun create boilertown/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- Build the package to release:\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[boilertown-url]: https://github.com/boilertown\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"}