https://github.com/0xtheprodev/js-configs

Common Configurations relating to NodeJS and Web Projects
https://github.com/0xtheprodev/js-configs

configurations-files eslint-config hacktoberfest javascript prettier-config tsconfig tsup-config typescript

Last synced: 5 months ago
JSON representation

Common Configurations relating to NodeJS and Web Projects

• Host: GitHub
• URL: https://github.com/0xtheprodev/js-configs
• Owner: 0xTheProDev
• License: mit
• Created: 2024-07-24T08:00:31.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-18T10:24:21.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T17:23:17.290Z (over 1 year ago)
• Topics: configurations-files, eslint-config, hacktoberfest, javascript, prettier-config, tsconfig, tsup-config, typescript
• Language: JavaScript
• Homepage:
• Size: 229 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

          


# JavaScript Configurations

[![Sponsor](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#white)](https://github.com/sponsors/0xTheProDev)

[![Open Issues](https://img.shields.io/github/issues-raw/0xTheProDev/js-configs?style=for-the-badge)](https://github.com/0xTheProDev/js-configs/issues)

[![Closed Issues](https://img.shields.io/github/issues-closed-raw/0xTheProDev/js-configs?style=for-the-badge)](https://github.com/0xTheProDev/js-configs/issues?q=is%3Aissue+is%3Aclosed)

[![Open Pulls](https://img.shields.io/github/issues-pr-raw/0xTheProDev/js-configs?style=for-the-badge)](https://github.com/0xTheProDev/js-configs/pulls)

[![Closed Pulls](https://img.shields.io/github/issues-pr-closed-raw/0xTheProDev/js-configs?style=for-the-badge)](https://github.com/0xTheProDev/js-configs/pulls?q=is%3Apr+is%3Aclosed)

[![Contributors](https://img.shields.io/github/contributors/0xTheProDev/js-configs?style=for-the-badge)](https://github.com/0xTheProDev/js-configs/graphs/contributors)

[![Activity](https://img.shields.io/github/last-commit/0xTheProDev/js-configs?style=for-the-badge&label=most%20recent%20activity)](https://github.com/0xTheProDev/js-configs/pulse)

## Description

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

  

    

      Package

      Version

      Downloads

    

  

  

    

      ESLint Configurations

      

        

      

      

        

      

    

    

      Prettier Configurations

      

        

      

      

        

      

    

    

      TypeScript Configurations

      

        

      

      

        

      

    

    

      TSup Configurations

      

        

      

      

        

      

    

  

## Installation

### Pre-requisite

This project uses [Bun](https://bun.sh) as Package Manager. Please install appropriate [Bun Version](.bun-version) to set this repository up.

Install all the project dependencies as follows:

```sh

bun install

```

## Testing

This project uses [Vitest](htttps://vitest.dev) for Test Suites and Runner.

- To run all the unit test suites, run the following after all the dependencies have been installed:

```sh

yarn test

```

- To collect coverage on the tested files, execute the following command:

```sh

yarn test:cov

```

## Reporting a Bug

Head on to [**Discussion**](https://github.com/0xTheProDev/js-configs/discussions) 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](https://github.com/0xTheProDev/js-configs/blob/main/CHANGELOG.md) for more details on what has been changed in the latest release.

## Contributing

See [Contributing Guidelines](https://github.com/0xTheProDev/js-configs/blob/main/.github/CONTRIBUTING.md).

## License

This project is licensed under the terms of the MIT license, see [LICENSE](https://github.com/0xTheProDev/js-configs/blob/main/LICENSE) for more details.