Skip to content

project template w/ Typescript, ESLint, Prettier, Jest, ESBuild & automated dependency updates

License

Notifications You must be signed in to change notification settings

permafrost-dev/typescript-project-skeleton-esbuild-jest

Repository files navigation

package-skeleton


template logo

Description

This repository is a starter template for NodeJS projects using the latest versions of TypeScript, ESBuild, ESLint, Prettier, and Jest. Use it to create NPM packages, CLI applications, and more.

It also optionally uses Madge to visualize connections between classes and files within your project.

Want to use .env files in your project? This will configure it automatically, if you want it to.

Want to use a configuration file in your project? This will configure it automatically, too, if you ask it to.

Template Setup

To configure, run:

node configure-package.js

The configure script will ask you a series of questions that will customize the template with values such as your name, GitHub username, email address, use of optional packages, and more.

Some of the default values are automatically determined based on your git configuration, but you may change any of the values when prompted.

{{package.description}}

Setup

npm install

npm run dev

Testing

package-skeleton uses Jest for unit tests. To run the test suite:

npm run test


Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.