Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.3 KB

README.md

File metadata and controls

38 lines (26 loc) · 1.3 KB
Raw

Documentation

I wrote this documentation for anyone that happens to run across my site and wonder how it works. It also serves the purpose of reminding myself how my own code works 😊

Tooling

I use two sets of linters to keep my code clean and, hopefully, readable!

ESLint

I use ESLint for my TypeScript files (**/*.ts and **/*.tsx). ESLint has really fantastic functionality for linting JavaScript code so naturally I picked it to lint my logic.

Notable Linter Rules:

  • no-console: dont litter 🗑
  • single quotes: uniformity is key
  • 2 space indentation: I like skinny, readable code
  • max line length 120: 👍

See the documented .eslintrc.js file for more info.

Note: I dont run yarn lint on build or dev. This means you can avoid linter rules during development (console logging 👀), and clean up your code on pull request, or in some case, never 😊

StyleLint

I use StyleLint for the styled components (**/*.css and **/*.scss). I use the recommended sass linter rules. However, if you have any recommendations on code style for styled components, please drop me an issue and I would be happy to look into it!

See our .stylelintrc.json file for more info.