Semver-oriented TypeScript library skeleton.

typescript, library, skeleton, scaffold, javascript, nodejs, nodejs-framework, nodejs-library, npm-module, npm-package
npm install @oresoftware/line-stream-parser@0.0.102


Travis build status: Build Status

CircleCI build status: CircleCI

TSLS - TypeScript Library Skeleton

Your Project Readme Goes Here

This skeleton project is designed for Node.js libraries.

To do things the simple way:

Steps to making this project skeleton your own project base.

  1. Clone this repo:
    git clone https://github.com/ORESoftware/typescript-library-skeleton.git YOUR-PROJECT-NAME
  2. Update package.json so that name property matches <YOUR-PROJECT-NAME>.
  3. Update other package.json fields so that they are accurate.

To check to see if YOUR-PROJECT-NAME is available on NPM, uses this command at the command line:

$ npm view YOUR-PROJECT-NAME # will give you a 404 if the name is available.

Of course you can use Github or other hosting platforms instead of NPM to deliver your library.

This project skeleton uses:

  • the correct semver initial value (npm init defaults to 1.0.0 which is just wrong).
  • typescript version 3.4.5
  • nodejs version 12
  • travis/circleci (for automated testing of your library)
  • MIT license
  • good simple default settings for .gitignore / .npmignore / .editorconfig / .gitattributes
  • Transpiling from src to dist folders (by default; you can change it manually)

To transpile files in place, instead of tranpiling from 'src' to 'dist':

update tsconfig.json (remove the `outDir` line):
"compilerOptions": {
    "outDir": "dist"

For small projects with just one .ts/.js file, you can just get rid of the src/lib folder, and put your main.ts file in the root of the project. In that case, make sure to change the main property in package.json from 'lib/index.js' to 'index.js'. Same with the typings/types properties.

Power users

This project is used by: https://github.com/oresoftware/ts-project You can use ts-project to do things even more automatically.