https://github.com/gustarus/lovely-code
Collection of linters and best practices for the frontend
https://github.com/gustarus/lovely-code
codestyle frontend lint
Last synced: 11 months ago
JSON representation
Collection of linters and best practices for the frontend
- Host: GitHub
- URL: https://github.com/gustarus/lovely-code
- Owner: gustarus
- Created: 2018-04-12T14:38:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-13T16:52:38.000Z (almost 8 years ago)
- Last Synced: 2025-01-17T18:57:24.141Z (about 1 year ago)
- Topics: codestyle, frontend, lint
- Size: 24.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Lovely code  
^:shit:-code\\.(`js`|`styl`|`css`|`sass`)$ → :icecream:-code\.($1)
A collection of really useful tools to improve your code quality.
The conception of three "standards" is used in this collection to describe three different levels of code-quality.
## What is a conception of three standards?
This collection contains helpers and presents for the following standards: `bronze`, `silver`, `gold`.
The higher the standard, the more stringent rules.
This standards are applied where it's possible.
For example, for [linters](#use-code-quality-tools-(linters)) I can define configuration files for every standard.
But there is no reason to define [configuration files for ide](#use-editor-config) for each standard because the basic rules are the same.
Difference between each standard was described in each section of the collection (where it's possible).
### `Bronze` :star: standard :beginner:
**In case of code quality tools**
Used for projects that "needed to be done yesterday".
Usually repeats the configuration of an ide and no special more features.
Can be supported with `.editorconfig` and some settings in ide.
### `Silver` :star: :star: standard :guardsman:
**In case of code quality tools**
For "good" projects.
Nothing special.
### `Gold` :star: :star: :star: standard :godmode:
**In case of code quality tools**
Only for **gods-of-js**.
## What I'd suggest to use to improve code quality?
### Use editor config
You can easily support quality of your code with configuration files for your ide.
It is extremely useful with combination of code auto-reformatting.
:paperclip: [Read more about configuration file for ide](/docs/editor/readme.md).
### Use code quality tools (linters)
You can easily support quality of your code with this tools.
Just add them to your project and use configuration files from this collection.
:paperclip: [Read more about configuration files for linters in this collection](/docs/linters/readme.md).
## To be done
- [ ] **Silver standard (default)**
- - [x] Describe `javascript` linter: basic `.eslintrc`, how to use and examples.
- - [x] Describe `stylus` linter: basic `.stylintrc`, how to use and examples.
- - [ ] Describe `css` linter: basic `.csslintrc`, how to use and examples.
- - [ ] Describe `sass` linter: basic `.sasslintrc`, how to use and examples.
- - [ ] Describe `editorconfig`.
- [ ] **Bronze standard**
- [ ] **Gold standard**