Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/travishorn/eslint-prettier-boilerplate
Starter repository for a JS project using Prettier formatting.
https://github.com/travishorn/eslint-prettier-boilerplate
Last synced: 30 days ago
JSON representation
Starter repository for a JS project using Prettier formatting.
- Host: GitHub
- URL: https://github.com/travishorn/eslint-prettier-boilerplate
- Owner: travishorn
- Created: 2019-03-22T16:34:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T04:33:57.000Z (over 1 year ago)
- Last Synced: 2024-08-09T05:51:15.126Z (5 months ago)
- Language: JavaScript
- Size: 96.7 KB
- Stars: 0
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ESLint Prettier Boilerplate
Starter repository for a JS project using ESLint and Prettier recommended rules
and styles.
## Installation
### Via GitHub
Click the green **Use this template** button above.
Give your repository a name and click **Create repository from
template**.
Clone your new repository.
```
git clone https://github.com/[your username]/[your repo name].git
```
Change into the project directory.
```
cd [your repo name]
```
Install the dependencies.
```
npm install
```
### Manual (without using this repository)
Follow this instructions in this Gist:
https://gist.github.com/travishorn/67d66ad896f31274c1c4c727c74992ea
## Usage
Start developing.
Any files with extension `.js` can be linted against ESLint and Prettier
recommended rules.
```
npm run lint
```
You can automatically fix some problems.
```
npm run lint:fix
```
## Editor Setup
If you're using Visual Studio Code, you can install the ESLint extension, which
will automatically highlight warnings and errors using this boilerplate.
1. Press **Ctrl + Shift + X** or click the **Extensions** button
2. Search for **ESLint**
3. Click the **Install** button next to the **ESLint** search result
With this extension, you can also choose to automatically fix/format your code
when you save. Add the following to your Visual Studio Code settings.
```
"eslint.autoFixOnSave": true
```
This setting only takes effect if `files.autoSave` is set to `off`,
`onFocusChange`, or `onWindowChange`.
## License
Copyright 2021 Travis Horn
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.