Ross Esmond

Code, Prose, and Mathematics.

portrait of myself, Ross Esmond
Written — Last Updated

Repository Checklist

General

Scaffold the project to save time.

  • Add .gitignore from GitHub
  • Add readme.md
    • Add various badges to readme

npm

  • Add .npmignore

TypeScript

See this guide

  • Add some linting, like eslint
    • Add TypeScript plugins
    • Add TypeDoc plugins
  • Add some formatter, like Prettier
  • Write TypeDocs
  • Add source files to .npmignore; keep output

npm package.json

  • Set "sideEffects": false docs
  • Optionally add browserlist

npm Library

Follow this guide

HOWEVER,

  • Don’t do the bundled version.
  • Don’t worry about the exports setting.