-
Notifications
You must be signed in to change notification settings - Fork 4
Recommended Text Editor Settings
Below are a series of commands to download UCLA Radio's recommended plugins for your text editor. This will making developing and contributing your pull request much easier!
apm install linter-eslint prettier-atomLinters are cool little programs that find style errors and bugs in your code. In order keep your code clean, we highly recommend you install them and use them while coding, because we won’t accept your pull request unless it adheres to our style guidelines. Linters can be added in many different places in your workflow, but our recommendation is to integrate them directly into your text editor. Both Atom and Sublime have plugins for most linters.
Atom’s linter plugin is called linter. Easy to remember, right? It’s also easy to install: just paste apm install linter into your terminal. If you’re curious as to what languages are supported, check out this link.
For Sublime, there’s a plugin called SublimeLinter. Hopefully, you’re using Package Control (and if you aren’t, you should probably install it!). You can just search linter and SublimeLinter should come up. Install it and restart Sublime.
Most of what linters catch are stylistic. You may want to check out our style guide to get a feel for how we do things!
For HTML, we use a linter called HTMLHint. It's already installed as a dependency, but you’re going to need to install to corresponding HTMLHint plugin for your text editor. (Atom, Sublime) Be sure to read over their setup and installation docs.
And that's it! If you make an HTML no-no, you'll know! It’s configuration is stored in a file called .htmlhintrc.
The linter we use for these wonderful style sheet languages is stylelint. It, just like HTMLHint is already installed, but you need a plugin. (Atom, Sublime)
It’s configuration is stored in a file called .stylelint.js.
It’s called ESLint. Installed the same way. (Atom, Sublime)
Config is at .eslint.js