Skip to content

docs: Remove the $ prefix in terminal commands #15565

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

Jump to bottom
Merged
merged 5 commits into from Feb 4, 2022
Merged

docs: Remove the $ prefix in terminal commands #15565

merged 5 commits into from Feb 4, 2022

Conversation

ghost
Copy link

@ghost ghost commented Feb 2, 2022 •
edited by ghost
Loading

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)

I simply removed the use of $ as a prefix for shell commands without an output, since it is not used anywhere else than these few commands. I also modified the markdownlint config, so future $ prefixes will be removed when linting the markdown files. So to ensure consistency.

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

Nothing, really. It's a tiny change.

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Feb 2, 2022
@eslint-github-bot
Copy link

Hi @AndreasLewis!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

bmish
bmish suggested changes Feb 2, 2022
View reviewed changes
Copy link
Member

@bmish bmish left a comment •
edited
Loading

Choose a reason for hiding this comment

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

If we're going to make this change, which I support because it makes it easier to copy and paste, we should also stop disabling the MD014 markdownlint rule:

eslint/.markdownlint.yml

Line 10 in 6f940c3

MD014: false # Dollar signs used before commands without showing output

https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md014---dollar-signs-used-before-commands-without-showing-output

@nzakas
Copy link
Member

nzakas commented Feb 4, 2022

Sounds like a good idea. @AndreasLewis do you want to make that change?

@eslint-github-bot
Copy link

Hi @AndreasLewis!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.
  • The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@ghost ghost changed the title Remove the $ prefix in terminal commands docs: Remove the $ prefix in terminal commands Feb 4, 2022
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Feb 4, 2022
undefined added 2 commits February 4, 2022 08:30
docs: Remove $ prefix from all commands w/o output
782ed89
docs: Remove MD014 rule
632d91e 
To prevent the use of $ prefix in commands that doesnt show output
@ghost
Copy link
Author

ghost commented Feb 4, 2022

If we're going to make this change, which I support because it makes it easier to copy and paste, we should also stop disabling the MD014 markdownlint rule:

eslint/.markdownlint.yml

Line 10 in 6f940c3

MD014: false # Dollar signs used before commands without showing output

https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md014---dollar-signs-used-before-commands-without-showing-output

Good idea! I've added that change as well as linted all markdown files according to the removal of MD014.

snitin315
snitin315 approved these changes Feb 4, 2022
View reviewed changes
Copy link
Contributor

@snitin315 snitin315 left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you for contributing.

@snitin315 snitin315 added 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 Feb 4, 2022
@snitin315 snitin315 requested a review from bmish February 4, 2022 09:10
mdjermanovic
mdjermanovic approved these changes Feb 4, 2022
View reviewed changes
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!

@bmish
Copy link
Member

bmish commented Feb 4, 2022

Thanks!

@bmish bmish merged commit 417191d into eslint:main Feb 4, 2022
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Feb 17, 2022
Update dependency eslint to v8.9.0 (#1173)
3a90f88 
This PR contains the following updates:

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

---

### Release Notes

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

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

[Compare Source](eslint/eslint@v8.8.0...v8.9.0)

#### Features

-   [`68f64a9`](eslint/eslint@68f64a9) feat: update eslint-scope to ignore `"use strict"` directives in ES3 ([#&#8203;15595](eslint/eslint#15595)) (Milos Djermanovic)
-   [`db57639`](eslint/eslint@db57639) feat: add `es2016`, `es2018`, `es2019`, and `es2022` environments ([#&#8203;15587](eslint/eslint#15587)) (Milos Djermanovic)
-   [`2dc38aa`](eslint/eslint@2dc38aa) feat: fix bug with arrow function return types in function-paren-newline ([#&#8203;15541](eslint/eslint#15541)) (Milos Djermanovic)
-   [`6f940c3`](eslint/eslint@6f940c3) feat: Implement FlatRuleTester ([#&#8203;15519](eslint/eslint#15519)) (Nicholas C. Zakas)

#### Documentation

-   [`570a036`](eslint/eslint@570a036) docs: add `one-var` example with `for-loop` initializer ([#&#8203;15596](eslint/eslint#15596)) (Milos Djermanovic)
-   [`417191d`](eslint/eslint@417191d) docs: Remove the $ prefix in terminal commands ([#&#8203;15565](eslint/eslint#15565)) (Andreas Lewis)
-   [`389ff34`](eslint/eslint@389ff34) docs: add missing `Variable#scope` property in the scope manager docs ([#&#8203;15571](eslint/eslint#15571)) (Milos Djermanovic)
-   [`f63795d`](eslint/eslint@f63795d) docs: no-eval replace dead link with working one ([#&#8203;15568](eslint/eslint#15568)) (rasenplanscher)
-   [`0383591`](eslint/eslint@0383591) docs: Remove old Markdown issue template ([#&#8203;15556](eslint/eslint#15556)) (Brandon Mills)
-   [`a8dd5a2`](eslint/eslint@a8dd5a2) docs: add 'when not to use it' section in no-duplicate-case docs ([#&#8203;15563](eslint/eslint#15563)) (Milos Djermanovic)
-   [`1ad439e`](eslint/eslint@1ad439e) docs: add missed verb in docs ([#&#8203;15550](eslint/eslint#15550)) (Jeff Mosawy)

#### Chores

-   [`586d45c`](eslint/eslint@586d45c) chore: Upgrade to espree@9.3.1 ([#&#8203;15600](eslint/eslint#15600)) (Milos Djermanovic)
-   [`623e1e2`](eslint/eslint@623e1e2) chore: Upgrade to eslint-visitor-keys@3.3.0 ([#&#8203;15599](eslint/eslint#15599)) (Milos Djermanovic)
-   [`355b23d`](eslint/eslint@355b23d) chore: fix outdated link to Code of Conduct in PR template ([#&#8203;15578](eslint/eslint#15578)) (Rich Trott)
-   [`b10fef2`](eslint/eslint@b10fef2) ci: use Node 16 for browser test ([#&#8203;15569](eslint/eslint#15569)) (Milos Djermanovic)
-   [`92f89fb`](eslint/eslint@92f89fb) chore: suggest demo link in bug report template ([#&#8203;15557](eslint/eslint#15557)) (Brandon Mills)

</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/1173
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>
@sync-by-unito sync-by-unito bot mentioned this pull request Mar 1, 2022
Closed
@sync-by-unito sync-by-unito bot mentioned this pull request Mar 30, 2022
Closed
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Aug 4, 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 Aug 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
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
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nzakas @bmish @mdjermanovic @snitin315