@kamatte-me/npm-sandbox v0.6.0

@kamatte-me/npm-sandbox

My NPM sandbox project.

Build ESM / CJS package with TypeScript.

Tools

• pnpm
• Vite
• Vitest
• ESLint
• Prettier
• Renovate
• GitHub Actions
• auto
• publint

Getting Started 🚀

1. Create a new GitHub repository
2. Download this repository
3. Modify the Release Workflow in .github/workflows/release.yml

   - - run: pnpm auto shipit
   + - run: pnpm auto shipit --dry-run

4. Update the following package information in package.json
   • name
   • version: 0.0.0
   • description
   • keywords
   • homepage
   • repository
   • license
   • author
5. Update README.md
6. Update LICENSE
7. Push to GitHub

   git init
   git add --all
   git commit -m "first commit"
   git branch -M main
   git remote add origin git@github.com:<user>/<repo>.git
   git push -u origin main

8. Create an initial GitHub release (for auto)
   • Tag & Release Title: v0.0.0
9. Generate new tokens
   • GitHub Personal Access Token (classic)
     • Select scopes
       • repo
   • NPM Granular Access Token
     • Permissions: Read and write
10. Configure GitHub repository Settings
    • Actions > General > Workflow permissions
      • Enable Read and write permissions
      • Enable Allow GitHub Actions to create and approve pull requests
    • Secrets and variables > Actions > New repository secret
      • GH_ADMIN_TOKEN: Your GitHub Personal Access Token
      • NPM_TOKEN: Your NPM Granular Access Token
    • Branches > Add rule
      • For the main branch:
        • Enable Require a pull request before merging
          • Enable Require approvals
          • Enable Dismiss stale pull request approvals when new commits are pushed
        • Enable Require status checks to pass before merging
          • Status checks that are required.
            • test
            • lint
            • typecheck
            • build
      • For the next branch:
        • Use the same settings as the main branch
        • Enable Allow deletions
11. Install the following GitHub Apps
    • Renovate
    • renovate-approve
12. Create labels for auto

    GH_TOKEN=<Your GitHub Personal Access Token> pnpm auto create-labels

13. DEVELOP YOUR LIBRARY
    • Familiarize yourself with the auto release workflow release workflow
14. First Publish 🎉
    1. Revert the release workflow changes
    2. PR and Merge the reverted changes into the main branch
15. Remove the v0.0.0 tag