Kb-generator-ts NPM

template-typescript-lib

Project template for Node libraries. Features:

Hybrid ESM/CJS
Types: TypeScript
Tests: Vitest
Linting: ESLint
Formatting: Prettier
Publishing: Dripip
CI: GitHub Actions
Dependency Management: Renovate
Community: Issue Templates

Quick Start

The following will get you a ready to go new repository on GitHub based on this one.

Run:

corepack enable && \
gh repo clone jasonkuhrt/template-typescript-lib <directory> && \
cd <directory> && \
pnpm install && \
pnpm ts-node scripts/bootstrap.ts

Setup a repo secret called NPM_TOKEN containing an npm token for CI package publishing.

Details

TypeScript for Type Safety & Productivity

Optimal settings for the safety of your implementation using @tsconfig/node16-strictest
.tsbuildinfo cache setup, output discretely into node_modules/.cache
Base tsconfig.json shared across tests, src, and ts-node.
Optimal output setup for your users
1. declaration so your users can power their intellisense with your packages typings.
2. declarationMap enabled to make your published source code be navigated to when your users use "go to definition".
3. package.json typeVersions used to emit only one set of declaration files shared by both CJS and ESM builds.
4. sourceMap enabled to allow your users' tools to base off the source for e.g. stack traces instead of the less informative derived built JS.
5. Publish src with build files so that jump-to-definition tools work optimally for users.
ts-node for running TypeScript scripts/modules.
1. Setup to use SWC for maximum speed.

ESLint For Linting

TypeScript integration
TS type-checker powered eslint checks enabled
Prettier integration using just eslint-config-prettier. eslint-plugin-prettier is not used to avoid lint noise and slower run time. Prettier is expected to be run by your IDE and your CI and if really needed you manually via pnpm format.
Setup as a CI check for PRs
Always display as warning to keep IDE error feedback for TypeScript (CI enforces warnings).
Auto-fixable import sorting

Vitest for Testing

Just Works :)

Dripip for Releasing

Simple succinct friendly low-barrier issue templates

Emojis ✈️
Feature / bug / docs / something-else
Config to display discussions link right in new issue type listing UI

Prettier for code formatting

Prisma Labs config preset, 110 line width
Setup as a CI check for PRs
VSCode extension in recommended extensions list so that when collaborators open the project they'll get prompted to install it if they haven't already.
npm script

npm scripts for development lifecycle

clean to remove cache and build files
build that runs clean beforehand
prepublishOnly that runs build beforehand
format to quickly run prettier over whole codebase
lint to quickly run eslint over whole codebase

CI with GitHub Actions

Separate trunk and pull-request (PR) workflows.
Dependency install cache enabled.
On PR:
1. Prettier Check
2. Lint Check
3. Type Check
4. Tests across matrix of mac/linux/windows for Node 14/16
On trunk:
1. Tests across matrix of mac/linux/windows for Node 14/16
2. Automated canary release

Renovate configuration

JSON Schema setup for optimal intellisense
Group all non-major devDependency updates into single PR (which "chore" conventional commit type)
Group all major devDependency updates into single PR (with "chore" conventional commit type)
Group all non-major dependency updates into single PR (with "deps" conventional commit type)
Each major dependency update in own PR (with "deps" conventional commit type)

PnPM for package management

Using Corepack. This means the PnPM specified in package.json will be used. And note this is a PnPM binary shipped with Node now. In a future version of Node you will not need to even opt-in into Corepack. Make sure you've done corepack enable at least once.

CJS+ESM Hybrid package build

An actually working hybrid CJS/ESM build.

VSCode Settings

Optimize project search by recursively (ready for monorepo) ignoring build/*, snapshots, lock files, and more.
On-Save actions for optimal editing experience (e.g. ESLint auto-fix to organize imports automatically)
List of VSCode extensions that users who open the project will be prompted to install if they don't already.
Enable typescript.enablePromptUseWorkspaceTsdk so that oneself and collaborators will get prompted to use the workspace version of TypeScript instead of the one in the editor.