https://github.com/juliusmarminge/good-defaults

A CLI tool to generate good defaults for your project
https://github.com/juliusmarminge/good-defaults

cli eslint github-actions prettier typescript vscode

Last synced: about 2 months ago
JSON representation

A CLI tool to generate good defaults for your project

• Host: GitHub
• URL: https://github.com/juliusmarminge/good-defaults
• Owner: juliusmarminge
• License: mit
• Created: 2022-08-30T14:08:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T20:11:36.000Z (about 1 year ago)
• Last Synced: 2024-10-23T14:07:44.084Z (2 months ago)
• Topics: cli, eslint, github-actions, prettier, typescript, vscode
• Language: TypeScript
• Homepage:
• Size: 152 KB
• Stars: 65
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Good Defaults

## ❓ What's this?

`Good Defaults` is a CLI tool that helps you set up your development environment for Typescript. It is a simple way to get started with a new project if you are unfamiliar with different configurations.

Just run the tool and you can get started with your new projects without having to worry about all the boring stuff!

> **Note:** I made this project to suit my own needs and the configurations provided might not suit your need.

## 🧩 What's included?

- ESLint + Prettier

- VSCode Settings & Extensions

- TSConfig

- GitHub Actions CI Workflow w/ Caching

## 🛠 How to use it?

1. Run the binary _(currently only works on pnpm)_:

```bash

pnpm dlx good-defaults

```

2. Select the configurations you would like to have.

3. Done 🚀

## 💖 Contributing

As mentioned above, I made this to suit my own needs. However, I am happy to be convinced for other configurations.

If you have something you'd like to add or modify, please open an issue or pull request.

## 📜 References

- A lot of the CLI tooling is based on [`create-t3-app`](https://github.com/t3-oss/create-t3-app).

- Thanks [@joshuakgoldberg](https://github.com/JoshuaKGoldberg) for inspiring on the [`.eslintrc`](./.eslintrc)