https://github.com/maxbeatty/style-guide
Style guide for TypeScript, ESLint, and Prettier
https://github.com/maxbeatty/style-guide
Last synced: over 1 year ago
JSON representation
Style guide for TypeScript, ESLint, and Prettier
- Host: GitHub
- URL: https://github.com/maxbeatty/style-guide
- Owner: maxbeatty
- License: mit
- Created: 2024-03-03T20:20:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T01:52:12.000Z (over 1 year ago)
- Last Synced: 2025-02-09T17:28:48.565Z (over 1 year ago)
- Language: JavaScript
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# style-guide
Style guide for TypeScript, ESLint, and Prettier
## Installation
All of the configurations are contained in one package: `@maxbeatty/style-guide`
```sh
npm install --save-dev @maxbeatty/style-guide
```
### Prettier
> Note: Prettier is a peer-dependency of this package, and should be installed
> at the root of your project.
>
> See:
To use the shared Prettier config, set the following in `package.json`.
```json
{
"prettier": "@maxbeatty/style-guide/prettier"
}
```
### ESLint
> Note: ESLint is a peer-dependency of this package, and should be installed
> at the root of your project.
>
> See:
This ESLint config is designed to be composable with the [newer flag configuration files](https://eslint.org/docs/latest/use/configure/configuration-files-new).
```js
import nodeConfig from "@maxbeatty/style-guide/eslint/node";
export default [
nodeConfig,
// other configuration objects...
];
```
## Contributing
Please read the [contributing](./CONTRIBUTING.md) guide.