https://github.com/upstatement/lint-me
A script to install Upstatement linting configs to your project
https://github.com/upstatement/lint-me
Last synced: 8 months ago
JSON representation
A script to install Upstatement linting configs to your project
- Host: GitHub
- URL: https://github.com/upstatement/lint-me
- Owner: Upstatement
- Created: 2019-03-20T21:23:48.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2021-05-14T17:53:18.000Z (almost 5 years ago)
- Last Synced: 2025-03-12T07:22:45.380Z (12 months ago)
- Language: Shell
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Lint Me
> A script to install Upstatement linting configs ([ESLint](https://www.npmjs.com/package/@upstatement/eslint-config) & [Prettier](https://www.npmjs.com/package/@upstatement/prettier-config)) to your project
## Installation
1. Clone this repo
2. In your terminal config (i.e. `.zshrc`, `.bash_rc`, etc.) add an alias for running the install script
```sh
alias lintme="sh ~//install.sh"
```
3. Now you should be able to run `lintme` at the root of any project to automatically install Upstatement's ESLint & Prettier linting configs
## Usage
At the root of any project, simply run
```sh
lintme
```
### Default
```sh
lintme
```
### Four Spaces
```sh
lintme four
```
### React
```sh
lintme react
```
### Vue
```sh
lintme vue
```
You should end up with the following files at the root of your project
- `.editorconfig`
- `.eslintrc`
- `package-lock.json`
- `package.json`
- `prettier.config.js`