Pkg
Stats

npm package discovery and stats viewer.

Discover Tips

General search
[free text search, go nuts!]
Package details
pkg:[package-name]
User packages
@[username]

Sponsor

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.

Twitter
@PkgStats
GitHub
pkgstats
Twitter
@ryanhefner
GitHub
ryanhefner
Site
ryanhefner.com

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 🙏

Framework
react / react-dom
Server
next / express / next-routes
Data Store
redux / react-redux / next-redux-wrapper / redux-thunk / redux-logger
Caching
lru-cache
CSS / Styling
next-page-transitions / styled-components
Typeface
@ibm/plex
Avatars
gravatar
Data Viz
chart.js / react-sparklines
Date formatting
dayjs
Infinite scrolling
react-scroll-trigger
Markdown rendering
react-markdown
Repository url parsing
hosted-git-info
User data
npm-user
Compiling
babel-plugin-module-resolver / babel-plugin-styled-components
Types
prop-types
Odds & Ends
es6-promise / isomorphic-fetch

© 2024 – Pkg Stats / Ryan Hefner

@gyng/ts-library-quickstart

v1.6.4

Published

a year ago

Quickstart for esbuild library projects.

Downloads

11

0High
0Medium
0Low

ts-library-quickstart

Quickstart for esbuild library projects.

Example API documentation

Typescript
Testing with jest
Linting with prettier, eslint
CI and skeleton CD with GitHub Actions
Dockerfiles for build and test
Publish to NPM and GitHub Packages by creating releases

Usage

See scripts in package.json for more scripts.

npm run d watch and build
npm run t:watch watch and test
npm run lint
npm run build

Build targets are set in esbuild.mjs.

Publish

Setup

Get an automation token from npm under settings

https://www.npmjs.com/settings/$YOUR_USERNAME/tokens/

Add the token to your repository secrets.
```
https://github.com/$YOUR_USERNAME/$YOUR_REPO_NAME/settings/secrets/actions/new
```
- Name: NPM_TOKEN
- Value: The automation token you got from the previous step
Update the scope key in ./github/workflows/publish.yml to your GitHub (organisation) name
Configure GitHub Pages
```
https://github.com/gyng/esbuild-quickstart/settings/pages
```
- Source: gh-pages branch
- Directory: / (root)

Run

Bump your version number in package.json before this. Run npm i to update package-lock.json. Publishing will fail if the version already exists.
Create a new release.
```
https://github.com/$YOUR_USERNAME/$YOUR_REPO_NAME/releases
```
The workflow at ./github/workflows/publish.yml should run and publish your packages to both NPM and GitHub Packages.
Also, API documentation will be published to your GitHub pages via the gh-pages branch. It will be viewable at https://$YOUR_NAME.github.io/$YOUR_REPO/.