https://github.com/bchiang7/lint-me

A script to install Upstatement ESLint & Prettier linting configs to your project
https://github.com/bchiang7/lint-me

Last synced: 7 days ago
JSON representation

A script to install Upstatement ESLint & Prettier linting configs to your project

• Host: GitHub
• URL: https://github.com/bchiang7/lint-me
• Owner: bchiang7
• Created: 2019-03-24T21:57:20.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-01-03T15:17:32.000Z (about 5 years ago)
• Last Synced: 2024-12-21T21:09:36.530Z (2 months ago)
• Language: Shell
• Homepage:
• Size: 35.2 KB
• Stars: 4
• Watchers: 2
• 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`