npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-rollup-npm-vite-boilerplate

v1.0.2

Published

Boilerplate for building a TypeScript + Rollup + Vite module that can be published to NPM.

Downloads

2

Readme

ts-rollup-npm-vite-boilerplate

codecov

Boilerplate for building a TypeScript + Rollup + Vite module that can be published to NPM.

⭐️ Included Packages

| Package Name | Version | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | TypeScript | TypeScript Badge | | Preact | Preact Badge | | Htm | Htm Badge | | Jest | Jest Badge | | Rollup | Rollup Badge | | Rollup-plugin-dts | Rollup-plugin-dts Badge | | Rollup-plugin-typescript2 | Rollup-plugin-typescript2 Badge | | Rollup-plugin-uglify | Rollup-plugin-uglify Badge | | @rollup/plugin-node-resolve | @rollup-plugin-node-resolve Badge | | Vite | Vite Badge | | Eslint | Eslint Badge | | Prettier | Prettier Badge |

🚀 Installation

1. Fork this Repo

After visiting this link, Fork the repository.

2. Clone your Repo

git clone https://github.com/<YOUR_GITHUB_NAME>/ts-rollup-npm-vite-boilerplate
cd ts-rollup-npm-vite-boilerplate

3. Edit the Package name, Version and Description

4. Set CODECOV_TOKEN (Optional)

If you don't need CodeCov CI, you should delete the .github/workflows/ci.yml file.

Step 1: Visite CodeCov CI and get CODECOV_TOKEN for your repository.

Copy the Upload Token text.

Step 2: Enter the token with the name CODECOV_TOKEN in the Secrets of your GitHub repository.

5. Set NPM_TOKEN (Optional)

If you don't need to Deploy with NPM, you should delete the .github/workflows/publish.yml file.

Step 1: Visite NPM and get NPM_TOKEN for your repository.

Click the Generate New Token Button

When generating a token, it must be created as an automation token.

Copy the NPM Token text.

Step 2: Enter the token with the name NPM_TOKEN in the Secrets of your GitHub repository.

Step 3: Edit the NPM account name in the publish.yml file

Don't forget the @.

🛠 Usage

Scripts

pnpm install # or (yarn|npm) install
pnpm test # unit tests
pnpm lint
pnpm build # production build
pnpm build:watch # for debug modules only
pnpm build:sandbox # for debug modules with sandbox (alias `pnpm start`)

CodeCov CI

If you have successfully set up CodeCov, if you push or PR to the main branch, CodeCov Coverage is automatically updated.

Publish to NPM

First, you need to deploy module with a Tag on GitHub using the npm version patch command.

# Update module version (This command changes `package.json`)
npm version patch

# Push to GitHub
git push origin main
git push origin <VERSION> # <VERSION> = vX.X.X

Then Create and Publish a new release on GitHub.

After completing the above process, you will see the NPM module deploy to @npm-account-name/<PACKAGE_NAME> like this: