Skip to content

Coding style chapter #374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iliakan merged 3 commits into from
Mar 3, 2018
Merged

Coding style chapter #374

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8361374
Curly braces section improvement
brentguf Jan 19, 2018
1fa9833
npm clarification
brentguf Jan 19, 2018
31bc534
evade -> avoid
brentguf Jan 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions 1-js/03-code-quality/02-coding-style/article.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ Now let's discuss the rules and reasons for them in detail.

Nothing is "carved in stone" here. Everything is optional and can be changed: these are coding rules, not religious dogmas.

### Figure brackets
### Curly braces

In most JavaScript projects figure brackets are written on the same line, not on the new line. A so-called "egyptian" style. There's also a space before an opening bracket.
In most JavaScript projects curly braces are written on the same line as the corresponding keyword, not on the new line, a so-called "Egyptian" style. There's also a space before an opening bracket.

Like this:

Expand Down Expand Up @@ -295,7 +295,7 @@ Most linters are integrated with editors: just enable the plugin in the editor a
For instance, for ESLint you should do the following:

1. Install [Node.JS](https://nodejs.org/).
2. Install ESLint with the command `npm install -g eslint` (npm is Node.JS package installer).
2. Install ESLint with the command `npm install -g eslint` (npm is a JavaScript package installer).
3. Create a config file named `.eslintrc` in the root of your JavaScript project (in the folder that contains all your files).

Here's an example of `.eslintrc`:
Expand Down Expand Up @@ -331,6 +331,6 @@ Also certain IDEs support built-in linting, that also may be good, but not so tu

All syntax rules from this chapter and the style guides aim to increase readability, so all of them are debatable.

When we think about "how to write better?", the sole criterion is "what makes the code more readable and easier to understand? what helps to evade errors?" That's the main thing to keep in mind when choosing the style or discussing which one is better.
When we think about "how to write better?", the sole criterion is "what makes the code more readable and easier to understand? what helps to avoid errors?" That's the main thing to keep in mind when choosing the style or discussing which one is better.

Read style guides to see the latest ideas about that and follow those that you find the best.