Create NPM Repo

We are going to create an Enterprise Grade NPM Starter. Do not let the word NPM fool you. While this was built to be packaged as a single source js file, that can be published as an NPM package, this starter also include tsconfigs, eslinting and jest configs, so can be used as a typescript playground for anything you want.

The Value Of This Starter

NPM allows developers to easily install, share, and manage packages or modules of code written in JavaScript. This is common place knowledge for any Javascript developer that uses npm.

This starter has all the configs needed so you can build you Npm package at an Enterprise level.

Jest

This starter includes a jest config as well so we can run unit testing within our npm repo. This will allow us to run tests locally as well as run Jest within our Github Action Runner.

Typescript

Typescript is included as an npm package as well as separate npm configs for different builds for CJS and ESM(Article on CJS vs ESM ).

This makes so that we can use Typescript for our local development, to build our javascript, as well as have it in CJS and ESM for use across different platforms.

Prettier

This build also includes Prettier which is used to automatically format code.

Eslint

This repo also includes a minimal Eslint configuration. Intentionally kept more or less blank so does not impede initial creation of npm repo and optionally add on later as so choose.

Everything Included(nothing needed from your side)

Everything that's included will work out of the box with no extra effort from your side. This is build so can simply run npm install and npm start to get everything up and running.

Github Actions - Unit Testing and Publishing

This npm starter also includes Github Actions out of the box.

Automatically unit test on pull request

When a pull request is made it will automatically trigger Github Actions to run all unit tests for your repo.

Automatically deploy to NPM when a release is made

When use the Github interface to release an npm package via choosing a particular tag, will automatically trigger the github action to deploy an Npm package.

How To Run A File as a Standalone

npm install;
npm install ts-node -g
ts-node <path-to-file>

Using ts-node can run a file as a standalone and also use this npm starter as a way of creating a playground for testing 3rd party APIs, such as OpenAI or Github.