Skip to content

Commit

Permalink
feat: Add Markdown languages (#268)
Browse files Browse the repository at this point in the history
* chore: Add type checking

* feat: Add type checking

* feat: Add language

* feat: Add Markdown language

* Update prepare script

* Update src/language/markdown-source-code.js

Co-authored-by: Francesco Trotta <github@fasttime.org>

* Update src/rules/fenced-code-language.js

Co-authored-by: Francesco Trotta <github@fasttime.org>

* Update src/rules/no-html.js

Co-authored-by: Francesco Trotta <github@fasttime.org>

* Update docs/processors/markdown.md

Co-authored-by: Francesco Trotta <github@fasttime.org>

* Update docs/processors/markdown.md

Co-authored-by: Francesco Trotta <github@fasttime.org>

* Update docs/processors/markdown.md

Co-authored-by: Francesco Trotta <github@fasttime.org>

* Fix link

* fix no-html

* Fix no-missing-label-refs

* Add no-invalid-label-ref; add util

* Fix linting error

* Fix no-invalid-label-ref

* Fix bugs in no-invalid-label-refs

* fix no-missing-label-refs locations

* Update comment

---------

Co-authored-by: Francesco Trotta <github@fasttime.org>
  • Loading branch information
nzakas and fasttime authored Aug 21, 2024
1 parent 0503748 commit d79c42b
Show file tree
Hide file tree
Showing 43 changed files with 2,951 additions and 203 deletions.
81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: "\U0001F41E Report a problem"
description: "Report something that isn't working the way you expected."
title: "Bug: (fill in)"
labels:
- bug
- "repro:needed"
body:
- type: markdown
attributes:
value: By opening an issue, you agree to abide by the [OpenJS Foundation Code of Conduct](https://eslint.org/conduct).
- type: textarea
attributes:
label: Environment
description: |
Please tell us about how you're running ESLint (Run `npx eslint --env-info`.)
value: |
ESLint version:
@eslint/markdown version:
Node version:
npm version:
Operating System:
validations:
required: true
- type: dropdown
attributes:
label: Which language are you using?
description: |
Just tell us which language mode you're using.
options:
- commonmark
- gfm
validations:
required: true
- type: textarea
attributes:
label: What did you do?
description: |
Please include a *minimal* reproduction case.
value: |
<details>
<summary>Configuration</summary>
```
<!-- Paste your configuration here -->
```
</details>
```js
<!-- Paste your code here -->
```
validations:
required: true
- type: textarea
attributes:
label: What did you expect to happen?
validations:
required: true
- type: textarea
attributes:
label: What actually happened?
description: |
Please copy-paste the actual ESLint output.
validations:
required: true
- type: input
attributes:
label: Link to Minimal Reproducible Example
description: "Link to a [StackBlitz](https://stackblitz.com) or GitHub repo with a minimal reproduction of the problem. **A minimal reproduction is required** so that others can help debug your issue. If a report is vague (e.g. just a generic error message) and has no reproduction, it may be auto-closed."
placeholder: "https://stackblitz.com/abcd1234"
validations:
required: true
- type: checkboxes
attributes:
label: Participation
options:
- label: I am willing to submit a pull request for this issue.
required: false
- type: textarea
attributes:
label: Additional comments
description: Is there anything else that's important for the team to know?
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: "\U0001F680 Request a change (not rule-related)"
description: "Request a change that is not a bug fix, rule change, or new rule"
title: "Change Request: (fill in)"
labels:
- enhancement
- core
body:
- type: markdown
attributes:
value: By opening an issue, you agree to abide by the [OpenJS Foundation Code of Conduct](https://eslint.org/conduct).
- type: textarea
attributes:
label: Environment
description: |
Please tell us about how you're running ESLint (Run `npx eslint --env-info`.)
value: |
ESLint version:
@eslint/markdown version:
Node version:
npm version:
Operating System:
validations:
required: true
- type: textarea
attributes:
label: What problem do you want to solve?
description: |
Please explain your use case in as much detail as possible.
placeholder: |
The Markdown plugin currently...
validations:
required: true
- type: textarea
attributes:
label: What do you think is the correct solution?
description: |
Please explain how you'd like to change the Markdown plugin to address the problem.
placeholder: |
I'd like the Markdown plugin to...
validations:
required: true
- type: checkboxes
attributes:
label: Participation
options:
- label: I am willing to submit a pull request for this change.
required: false
- type: textarea
attributes:
label: Additional comments
description: Is there anything else that's important for the team to know?
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: 🐛 Report a Parsing Error
url: https://github.com/syntax-tree/mdast-util-from-markdown/issues/new/choose
about: File an issue with the parser that this plugin uses
- name: 🗣 Ask a Question, Discuss
url: https://github.com/eslint/markdown/discussions
about: Get help using this plugin
- name: Discord Server
url: https://eslint.org/chat
about: Talk with the team
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: "\U0001F4DD Docs"
description: "Request an improvement to documentation"
title: "Docs: (fill in)"
labels:
- documentation
body:
- type: markdown
attributes:
value: By opening an issue, you agree to abide by the [OpenJS Foundation Code of Conduct](https://eslint.org/conduct).
- type: textarea
attributes:
label: Docs page(s)
description: |
What page(s) are you suggesting be changed or created?
placeholder: |
e.g. https://eslint.org/docs/latest/use/getting-started
validations:
required: true
- type: textarea
attributes:
label: What documentation issue do you want to solve?
description: |
Please explain your issue in as much detail as possible.
placeholder: |
The docs currently...
validations:
required: true
- type: textarea
attributes:
label: What do you think is the correct solution?
description: |
Please explain how you'd like to change the docs to address the problem.
placeholder: |
I'd like the docs to...
validations:
required: true
- type: checkboxes
attributes:
label: Participation
options:
- label: I am willing to submit a pull request for this change.
required: false
- type: textarea
attributes:
label: Additional comments
description: Is there anything else that's important for the team to know?
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/new-rule.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: "\U0001F680 Propose a new rule"
description: "Propose a new rule to be added to the plugin"
title: "New Rule: (fill in)"
labels:
- rule
- feature
body:
- type: markdown
attributes:
value: By opening an issue, you agree to abide by the [OpenJS Foundation Code of Conduct](https://eslint.org/conduct).
- type: input
attributes:
label: Rule details
description: What should the new rule do?
validations:
required: true
- type: dropdown
attributes:
label: What type of rule is this?
options:
- Warns about a potential problem
- Suggests an alternate way of doing something
validations:
required: true
- type: textarea
attributes:
label: Example code
description: Please provide some example code that this rule will warn about.
render: markdown
validations:
required: true
- type: checkboxes
attributes:
label: Participation
options:
- label: I am willing to submit a pull request to implement this rule.
required: false
- type: textarea
attributes:
label: Additional comments
description: Is there anything else that's important for the team to know?
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/rule-change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: "\U0001F4DD Request a rule change"
description: "Request a change to an existing rule"
title: "Rule Change: (fill in)"
labels:
- enhancement
- rule
body:
- type: markdown
attributes:
value: By opening an issue, you agree to abide by the [OpenJS Foundation Code of Conduct](https://eslint.org/conduct).
- type: input
attributes:
label: What rule do you want to change?
validations:
required: true
- type: dropdown
attributes:
label: What change do you want to make?
options:
- Generate more warnings
- Generate fewer warnings
- Implement autofix
- Implement suggestions
validations:
required: true
- type: dropdown
attributes:
label: How do you think the change should be implemented?
options:
- A new option
- A new default behavior
- Other
validations:
required: true
- type: textarea
attributes:
label: Example code
description: Please provide some example code that this change will affect.
render: markdown
validations:
required: true
- type: textarea
attributes:
label: What does the rule currently do for this code?
validations:
required: true
- type: textarea
attributes:
label: What will the rule do after it's changed?
validations:
required: true
- type: checkboxes
attributes:
label: Participation
options:
- label: I am willing to submit a pull request to implement this change.
required: false
- type: textarea
attributes:
label: Additional comments
description: Is there anything else that's important for the team to know?
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ yarn.lock
package-lock.json
pnpm-lock.yaml
dist
src/build
Loading

0 comments on commit d79c42b

Please sign in to comment.