Skip to content

Update README file - Extend explanations, fix formatting mistakes and expand examples#2938

Draft
bstashchuk wants to merge 13 commits intoairbnb:masterfrom
bstashchuk:update-readme
Draft

Update README file - Extend explanations, fix formatting mistakes and expand examples#2938
bstashchuk wants to merge 13 commits intoairbnb:masterfrom
bstashchuk:update-readme

Conversation

@bstashchuk
Copy link
Copy Markdown

I am author of few JavaScript courses on Udemy.
While recording new JavaScript course I used AirBnb Style Guide in one of the sections and noticed few ways for improvements.

  • Expanded examples
  • Fixed some formatting mistakes
  • Extended explanations

Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
@ljharb ljharb marked this pull request as draft March 7, 2024 19:31
Copy link
Copy Markdown
Author

@bstashchuk bstashchuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick feedback @ljharb
I hope we will be able to incorporate few of my changes.

Comment thread README.md
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
@bstashchuk bstashchuk requested a review from ljharb March 8, 2024 10:05
Comment thread README.md
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
@bstashchuk bstashchuk requested a review from ljharb March 9, 2024 10:46
@bstashchuk
Copy link
Copy Markdown
Author

@ljharb I am still thinking about 19.6

There are actually general ESLint rules regarding method chains formatting but for some reason all examples are about jQuery and DOM manipulation.

No pure JS examples of methods chaining for arrays or some objects manipulation.

May I reduce quantity of the jQuery examples (or make them less confusing due to the long chains of method calls with different indents) and add some additional examples with bad/good formatting?

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@bstashchuk bstashchuk requested a review from ljharb March 11, 2024 21:25
@bstashchuk bstashchuk marked this pull request as ready for review March 18, 2024 13:40
@bstashchuk
Copy link
Copy Markdown
Author

Hi @ljharb ,
let me know if something else is needed to change in this PR.
It seems all questions were resolved.
Bogdan

@bstashchuk bstashchuk force-pushed the update-readme branch 2 times, most recently from 352c3db to 891cff2 Compare April 12, 2024 10:31
Comment thread README.md
@ljharb ljharb marked this pull request as draft September 30, 2024 00:38
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
bstashchuk and others added 4 commits March 12, 2025 22:23
@bstashchuk bstashchuk marked this pull request as ready for review March 12, 2025 22:30
@bstashchuk bstashchuk requested a review from ljharb March 12, 2025 22:30
Comment thread README.md
Comment on lines +1503 to +1514
sum === 15; // true

// good
let sum = 0;
numbers.forEach((num) => {
sum += num;
});
sum === 15;
sum === 15; // true

// best (use the functional force)
const sum = numbers.reduce((total, num) => total + num, 0);
sum === 15;
sum === 15; // true
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these are implicit.

Comment thread README.md

// bad
function foo() {
bar = 10; // bar will appear in the global scope
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only in sloppy mode; worth calling out.

Comment thread README.md
- [ExploringJS](https://exploringjs.com/)
- [ES6 Compatibility Table](https://compat-table.github.io/compat-table/es6/)
- [Comprehensive Overview of ES6 Features](https://web.archive.org/web/20240404212626/http://es6-features.org/)
- [Comprehensive Overview of ES6 Features](http://es6-features.org/)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please revert this; http://es6-features.org is now some kind of russian ad site.

@ljharb ljharb marked this pull request as draft April 16, 2026 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants