Skip to content
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.

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

docs: add more examples for prefer-object-spread #15831

Merged
merged 2 commits into from May 2, 2022

Conversation

coderaiser
Copy link
Contributor

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Updated docs related to prefer-spread rule according to tests cases. Added missing examples of spread syntax.

Is there anything you'd like reviewers to focus on?

@eslint-github-bot eslint-github-bot bot added triage An ESLint team member will look at this issue soon documentation Relates to ESLint's documentation labels May 2, 2022
@mdjermanovic mdjermanovic added rule Relates to ESLint's core rules accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels May 2, 2022
Copy link
Member

@mdjermanovic mdjermanovic 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 PR! I agree that documentation for this rule lacks examples with object spread, which is the point of this rule.


// Any Object.assign call without an object literal as the first argument
Copy link
Member

Choose a reason for hiding this comment

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

Can we keep this comment somewhere?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure! Just updated.

@mdjermanovic mdjermanovic changed the title docs: prefer-object-spread: update docs according to tests docs: add more examples for prefer-object-spread May 2, 2022
Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for contributing!

@mdjermanovic mdjermanovic merged commit 810adda into eslint:main May 2, 2022
@coderaiser coderaiser deleted the patch-1 branch May 3, 2022 06:49
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request May 13, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.14.0` -> `8.15.0`](https://renovatebot.com/diffs/npm/eslint/8.14.0/8.15.0) |

---

### Release Notes

<details>
<summary>eslint/eslint</summary>

### [`v8.15.0`](https://github.com/eslint/eslint/releases/v8.15.0)

[Compare Source](eslint/eslint@v8.14.0...v8.15.0)

#### Features

-   [`ab37d3b`](eslint/eslint@ab37d3b) feat: add `enforceInClassFields` option to no-underscore-dangle ([#&#8203;15818](eslint/eslint#15818)) (Roberto Cestari)

#### Bug Fixes

-   [`8bf9440`](eslint/eslint@8bf9440) fix: "use strict" should not trigger strict mode in ES3 ([#&#8203;15846](eslint/eslint#15846)) (Milos Djermanovic)

#### Documentation

-   [`28116cc`](eslint/eslint@28116cc) docs: update AST node names link in no-restricted-syntax ([#&#8203;15843](eslint/eslint#15843)) (Milos Djermanovic)
-   [`272965f`](eslint/eslint@272965f) docs: fix h1 heading on formatters page ([#&#8203;15834](eslint/eslint#15834)) (Milos Djermanovic)
-   [`a798166`](eslint/eslint@a798166) docs: update example for running individual rule tests ([#&#8203;15833](eslint/eslint#15833)) (Milos Djermanovic)
-   [`57e732b`](eslint/eslint@57e732b) docs: mark `SourceCode#getJSDocComment` deprecated in working-with-rules ([#&#8203;15829](eslint/eslint#15829)) (Milos Djermanovic)
-   [`9a90abf`](eslint/eslint@9a90abf) docs: update docs directory in working-with-rules ([#&#8203;15830](eslint/eslint#15830)) (Milos Djermanovic)
-   [`810adda`](eslint/eslint@810adda) docs: add more examples for prefer-object-spread ([#&#8203;15831](eslint/eslint#15831)) (coderaiser)
-   [`06b1edb`](eslint/eslint@06b1edb) docs: clarify no-control-regex rule ([#&#8203;15808](eslint/eslint#15808)) (Milos Djermanovic)
-   [`9ecd42f`](eslint/eslint@9ecd42f) docs: Fixed typo in code comment ([#&#8203;15812](eslint/eslint#15812)) (Addison G)
-   [`de992b7`](eslint/eslint@de992b7) docs: remove links to 2fa document ([#&#8203;15804](eslint/eslint#15804)) (Milos Djermanovic)
-   [`5222659`](eslint/eslint@5222659) docs: fix 'Related Rules' heading in no-constant-binary-expression ([#&#8203;15799](eslint/eslint#15799)) (Milos Djermanovic)
-   [`e70ae81`](eslint/eslint@e70ae81) docs: Update README team and sponsors (ESLint Jenkins)

#### Chores

-   [`1ba6a92`](eslint/eslint@1ba6a92) chore: upgrade [@&#8203;eslint/eslintrc](https://github.com/eslint/eslintrc)[@&#8203;1](https://github.com/1).2.3 ([#&#8203;15847](eslint/eslint#15847)) (Milos Djermanovic)
-   [`8167aa7`](eslint/eslint@8167aa7) chore: bump version of minimatch due to security issue PRISMA-2022-0039 ([#&#8203;15774](eslint/eslint#15774)) (Jan Opravil)
-   [`b8995a4`](eslint/eslint@b8995a4) chore: Implement docs site ([#&#8203;15815](eslint/eslint#15815)) (Nicholas C. Zakas)
-   [`6494e3e`](eslint/eslint@6494e3e) chore: update link in `codeql-analysis.yml` ([#&#8203;15817](eslint/eslint#15817)) (Milos Djermanovic)
-   [`36503ec`](eslint/eslint@36503ec) chore: enable no-constant-binary-expression in eslint-config-eslint ([#&#8203;15807](eslint/eslint#15807)) (唯然)

</details>

---

### Configuration

📅 **Schedule**: At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1343
Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
srijan-deepsource pushed a commit to DeepSourceCorp/eslint that referenced this pull request May 30, 2022
* docs: prefer-object-spread: update docs according to tests

* Update docs/src/rules/prefer-object-spread.md
srijan-deepsource added a commit to DeepSourceCorp/eslint that referenced this pull request May 30, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Oct 30, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Oct 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants