Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.61 KB

README.md

File metadata and controls

31 lines (19 loc) · 1.61 KB

Introduction

A repository where I can upload various libraries or configurations that I often find myself duplicating across my own projects.

Configurations

  • @putstack/eslint-config-typescript - A strict configuration for ESLint to be used in TypeScript projects.
    • It comes with a recommended and base configuration that can be used. The base configuration is less strict than the recommended, so it might be easier to integrate into existing projects.
  • @putstack/prettier-config - A prettier configuration that has sensible defaults, that should never require adjustment.

Libraries

  • @putstack/utils - A collection of utility functions that I often find myself needing in various projects.

Getting Started

Clone the repository, and run pnpm i to install the dependencies - then you're good to go! The project will lint and prettier itself as a pre-commit hook, so you will automatically adhere to all our style conventions!

Contribute

Feel free to contribute to this repository if you think there's a bug, a rule is missing or misconfigured, or anything else! If you're unsure how to fix it, feel free to open an issue.

Remember to add a changeset, you can do that by running pnpm changeset and following the instructions. An example of a changeset could be:

- Turn on `@typescript-eslint/default-param-last` to better match expectations from certain SonarQube setups. Rule documentation can be found [here](https://typescript-eslint.io/rules/default-param-last). This also turns off the standard `default-param-last` as described in the documentation.

Roadmap