Skip to content

Commit

Permalink
What is changed?
Browse files Browse the repository at this point in the history
* Added prettier function
* Added eslint
* Added vsCode default set
* Added Vscode set desc
  • Loading branch information
juuuuuuun committed Nov 6, 2021
1 parent 0ea0916 commit b532d8c
Show file tree
Hide file tree
Showing 13 changed files with 1,034 additions and 431 deletions.
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#Ignore artifacts
dist
node_modules
Sherlock-Holmes-Selected-Stories
13 changes: 13 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"env": {
"commonjs": true,
"es2021": true,
"node": true
},
"extends": "eslint:recommended",
"parserOptions": {
"ecmaVersion": "latest"
},
"rules": {
}
}
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#Ignore artifacts
dist
node_modules
Sherlock-Holmes-Selected-Stories
11 changes: 11 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"trailingComma": "es5",
"tabWidth": 2,
"semi": true,
"singleQuote": true,
"bracketSpacing": true,
"bracketSameLine": true,
"endOfLine": "crlf",
"printWidth": 80,
"useTabs": false
}
6 changes: 6 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"recommendations": [
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode"
]
}
34 changes: 34 additions & 0 deletions CONTRIBUTTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
![header](https://capsule-render.vercel.app/api?type=waving&color=gradient&height=400&section=header&text=Prettier&animation=fadeIn&fontSize=90)

# PRETTIER

## Usage

Formatting:
- `npm run prettier`: Format files by Prettier.
- `npm run prettier-check`: Check the files are formatted or not.

## Setting

- You can change Prettier setting in `.prettierrc.json`

# ESLINT

## Usage

Running:
- `npm run eslint`: Show the errors from the files by Eslint.
- `npm run eslint-fix`: Fix the errors from the files by Eslint.

## Setting

- You can change Prettier setting in `.eslintrc.json`

# Vscode

- Prettier: `esbenp.prettier-vscode`
- ESLint: `dbaeumer.vscode-eslint`

- It will automatically set the Prettier and ESLint as a default option to your Vscode.

![footer](https://capsule-render.vercel.app/api?type=waving&color=auto&height=500&section=footer&text=Jun%20Song&desc=Student%20of%20Seneca%20College&animation=fadeIn&fontSize=70)
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can dowload and run the repository files
node src/app.js
```

or
or
can run by npm

```
Expand Down Expand Up @@ -81,4 +81,4 @@ When you are done all steps and running this API the output will be like this

MIT

![footer](https://capsule-render.vercel.app/api?type=waving&color=auto&height=500&section=footer&text=Jun%20Song&desc=Student%20of%20Seneca%20College&animation=fadeIn&fontSize=70)
![footer](https://capsule-render.vercel.app/api?type=waving&color=auto&height=500&section=footer&text=Jun%20Song&desc=Student%20of%20Seneca%20College&animation=fadeIn&fontSize=70)
Loading

0 comments on commit b532d8c

Please sign in to comment.