Skip to content

Common Configurations relating to NodeJS and Web Projects

License

Notifications You must be signed in to change notification settings

0xTheProDev/js-configs

Repository files navigation

JavaScript Configurations

Sponsor Open Issues Closed Issues Open Pulls Closed Pulls Contributors Activity

Description

Set of configurations to work with JavaScript or TypeScript projects across platforms.

Package Version Downloads
ESLint Configurations Npm Version Weekly Downloads
Prettier Configurations Npm Version Weekly Downloads
TypeScript Configurations Npm Version Weekly Downloads
TSup Configurations Npm Version Weekly Downloads

Installation

Pre-requisite

This project uses Bun as Package Manager. Please install appropriate Bun Version to set this repository up.

Install all the project dependencies as follows:

bun install

Testing

This project uses Vitest for Test Suites and Runner.

  • To run all the unit test suites, run the following after all the dependencies have been installed:
yarn test
  • To collect coverage on the tested files, execute the following command:
yarn test:cov

Reporting a Bug

Head on to Discussion section to report a bug or to ask for any feature. Feel to add your queries about using this library as well under Q & A section of it. Remember, do not create any Issues by yourself, maintainers of this repository will open one if deemed necessary.

Changelog

See CHANGELOG for more details on what has been changed in the latest release.

Contributing

See Contributing Guidelines.

License

This project is licensed under the terms of the MIT license, see LICENSE for more details.