Skip to content

Commit

Permalink
docs: replace gfm emoji with raw emoji (#290)
Browse files Browse the repository at this point in the history
  • Loading branch information
ota-meshi committed Dec 8, 2023
1 parent 19d7875 commit d4a834a
Show file tree
Hide file tree
Showing 60 changed files with 260 additions and 271 deletions.
49 changes: 23 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This plugin is in the **_experimental stages_** of development.

At least it works fine with a [withastro/docs](https://github.com/withastro/docs) repository.

## :name_badge: What is this plugin?
## πŸ“› What is this plugin?

[ESLint] plugin for [Astro components].

Expand All @@ -34,17 +34,16 @@ At least it works fine with a [withastro/docs](https://github.com/withastro/docs
[dynamic jsx expressions]: https://docs.astro.build/ja/core-concepts/astro-components/#dynamic-jsx-expressions
[client-side scripts]: https://docs.astro.build/ja/core-concepts/astro-components/#client-side-scripts
[directives]: https://docs.astro.build/ja/reference/directives-reference/
[astro-eslint-parser]: https://github.com/ota-meshi/astro-eslint-parser

<!--DOCS_IGNORE_START-->

## :book: Documentation
## πŸ“– Documentation

See [documents](https://ota-meshi.github.io/eslint-plugin-astro/).

<!--INSTALL_GUIDE_START-->

## :cd: Installation
## πŸ’Ώ Installation

```bash
npm install --save-dev eslint eslint-plugin-astro
Expand Down Expand Up @@ -74,7 +73,7 @@ npm install --save-dev eslint-plugin-jsx-a11y

<!--DOCS_IGNORE_END-->

## :book: Usage
## πŸ“– Usage

<!--USAGE_SECTION_START-->
<!--USAGE_GUIDE_START-->
Expand Down Expand Up @@ -204,7 +203,7 @@ eslint --ext .js,.astro src
eslint "src/**/*.{js,astro}"
```

## :computer: Editor Integrations
## πŸ’» Editor Integrations

### Visual Studio Code

Expand All @@ -229,12 +228,12 @@ Example **.vscode/settings.json**:
<!--USAGE_GUIDE_END-->
<!--USAGE_SECTION_END-->

## :white_check_mark: Rules
## βœ… Rules

<!--RULES_SECTION_START-->

The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) automatically fixes problems reported by rules which have a wrench :wrench: below.
The rules with the following star :star: are included in the `plugin:astro/recommended` configs.
The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) automatically fixes problems reported by rules which have a wrench πŸ”§ below.
The rules with the following star ⭐ are included in the `plugin:astro/recommended` configs.

> Doesn't the rule you want exist? [Share your idea of that rule with us](https://github.com/ota-meshi/eslint-plugin-astro/issues/new?template=new_rule_request.yml).
Expand All @@ -246,13 +245,13 @@ These rules relate to possible syntax or logic errors in Astro component code:

| Rule ID | Description | |
|:--------|:------------|:---|
| [astro/no-conflict-set-directives](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-conflict-set-directives/) | disallow conflicting set directives and child contents | :star: |
| [astro/no-deprecated-astro-canonicalurl](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-deprecated-astro-canonicalurl/) | disallow using deprecated `Astro.canonicalURL` | :star: |
| [astro/no-deprecated-astro-fetchcontent](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-deprecated-astro-fetchcontent/) | disallow using deprecated `Astro.fetchContent()` | :star::wrench: |
| [astro/no-deprecated-astro-resolve](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-deprecated-astro-resolve/) | disallow using deprecated `Astro.resolve()` | :star: |
| [astro/no-deprecated-getentrybyslug](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-deprecated-getentrybyslug/) | disallow using deprecated `getEntryBySlug()` | :star: |
| [astro/no-unused-define-vars-in-style](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-unused-define-vars-in-style/) | disallow unused `define:vars={...}` in `style` tag | :star: |
| [astro/valid-compile](https://ota-meshi.github.io/eslint-plugin-astro/rules/valid-compile/) | disallow warnings when compiling. | :star: |
| [astro/no-conflict-set-directives](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-conflict-set-directives/) | disallow conflicting set directives and child contents | ⭐ |
| [astro/no-deprecated-astro-canonicalurl](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-deprecated-astro-canonicalurl/) | disallow using deprecated `Astro.canonicalURL` | ⭐ |
| [astro/no-deprecated-astro-fetchcontent](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-deprecated-astro-fetchcontent/) | disallow using deprecated `Astro.fetchContent()` | β­πŸ”§ |
| [astro/no-deprecated-astro-resolve](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-deprecated-astro-resolve/) | disallow using deprecated `Astro.resolve()` | ⭐ |
| [astro/no-deprecated-getentrybyslug](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-deprecated-getentrybyslug/) | disallow using deprecated `getEntryBySlug()` | ⭐ |
| [astro/no-unused-define-vars-in-style](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-unused-define-vars-in-style/) | disallow unused `define:vars={...}` in `style` tag | ⭐ |
| [astro/valid-compile](https://ota-meshi.github.io/eslint-plugin-astro/rules/valid-compile/) | disallow warnings when compiling. | ⭐ |

## Security Vulnerability

Expand All @@ -268,7 +267,7 @@ These rules relate to better ways of doing things to help you avoid problems:

| Rule ID | Description | |
|:--------|:------------|:---|
| [astro/no-set-text-directive](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-set-text-directive/) | disallow use of `set:text` | :wrench: |
| [astro/no-set-text-directive](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-set-text-directive/) | disallow use of `set:text` | πŸ”§ |
| [astro/no-unused-css-selector](https://ota-meshi.github.io/eslint-plugin-astro/rules/no-unused-css-selector/) | disallow selectors defined in `style` tag that don't use in HTML | |

## Stylistic Issues
Expand All @@ -277,9 +276,9 @@ These rules relate to style guidelines, and are therefore quite subjective:

| Rule ID | Description | |
|:--------|:------------|:---|
| [astro/prefer-class-list-directive](https://ota-meshi.github.io/eslint-plugin-astro/rules/prefer-class-list-directive/) | require `class:list` directives instead of `class` with expressions | :wrench: |
| [astro/prefer-object-class-list](https://ota-meshi.github.io/eslint-plugin-astro/rules/prefer-object-class-list/) | require use object instead of ternary expression in `class:list` | :wrench: |
| [astro/prefer-split-class-list](https://ota-meshi.github.io/eslint-plugin-astro/rules/prefer-split-class-list/) | require use split array elements in `class:list` | :wrench: |
| [astro/prefer-class-list-directive](https://ota-meshi.github.io/eslint-plugin-astro/rules/prefer-class-list-directive/) | require `class:list` directives instead of `class` with expressions | πŸ”§ |
| [astro/prefer-object-class-list](https://ota-meshi.github.io/eslint-plugin-astro/rules/prefer-object-class-list/) | require use object instead of ternary expression in `class:list` | πŸ”§ |
| [astro/prefer-split-class-list](https://ota-meshi.github.io/eslint-plugin-astro/rules/prefer-split-class-list/) | require use split array elements in `class:list` | πŸ”§ |

## A11Y Extension Rules

Expand Down Expand Up @@ -331,14 +330,14 @@ These rules extend the rules provided by ESLint itself to work well in Astro com

| Rule ID | Description | |
|:--------|:------------|:---|
| [astro/semi](https://ota-meshi.github.io/eslint-plugin-astro/rules/semi/) | Require or disallow semicolons instead of ASI | :wrench: |
| [astro/semi](https://ota-meshi.github.io/eslint-plugin-astro/rules/semi/) | Require or disallow semicolons instead of ASI | πŸ”§ |

<!--RULES_TABLE_END-->
<!--RULES_SECTION_END-->

<!--DOCS_IGNORE_START-->

## :beers: Contributing
## 🍻 Contributing

Welcome contributing!

Expand All @@ -355,17 +354,15 @@ This plugin uses [astro-eslint-parser](https://github.com/ota-meshi/astro-eslint

<!--DOCS_IGNORE_END-->

## :heart: Supporting
## ❀️ Supporting

If you are willing to see that this package continues to be maintained, please consider sponsoring me.

[![sponsors](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/ota-meshi)

## :lock: License
## πŸ”’ License

See the [LICENSE](LICENSE) file for license rights and limitations (MIT).

[astro]: https://astro.build/
[eslint]: https://eslint.org/
[astro components]: https://docs.astro.build/en/core-concepts/astro-components/
[eslint-plugin-jsx-a11y]: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y
3 changes: 0 additions & 3 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { defineConfig } from "astro/config"
import svelte from "@astrojs/svelte"
import mdx from "@astrojs/mdx"
import emoji from "remark-emoji"
import gfm from "remark-gfm"
import replaceLink from "./docs-build/remark-replace-link.mjs"
import "./docs-build/setup-docs.mjs"
Expand All @@ -21,7 +20,6 @@ export default defineConfig({
svelte(),
mdx({
remarkPlugins: [
emoji,
gfm,
[
replaceLink,
Expand All @@ -35,7 +33,6 @@ export default defineConfig({
],
markdown: {
remarkPlugins: [
emoji,
gfm,
[
replaceLink,
Expand Down
13 changes: 5 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This plugin is in the **_experimental stages_** of development.

At least it works fine with a [withastro/docs](https://github.com/withastro/docs) repository.

## :name_badge: What is this plugin?
## πŸ“› What is this plugin?

[ESLint] plugin for [Astro components].

Expand All @@ -38,27 +38,24 @@ At least it works fine with a [withastro/docs](https://github.com/withastro/docs
[dynamic jsx expressions]: https://docs.astro.build/ja/core-concepts/astro-components/#dynamic-jsx-expressions
[client-side scripts]: https://docs.astro.build/ja/core-concepts/astro-components/#client-side-scripts
[directives]: https://docs.astro.build/ja/reference/directives-reference/
[astro-eslint-parser]: https://github.com/ota-meshi/astro-eslint-parser

## :book: Usage
## πŸ“– Usage

See [User Guide](./user-guide.md).

## :white_check_mark: Rules
## βœ… Rules

See [Available Rules](./rules.md).

## :heart: Supporting
## ❀️ Supporting

If you are willing to see that this package continues to be maintained, please consider sponsoring me.

[![sponsors](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/ota-meshi)

## :lock: License
## πŸ”’ License

See the [LICENSE](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/LICENSE) file for license rights and limitations (MIT).

[astro]: https://astro.build/
[eslint]: https://eslint.org/
[astro components]: https://docs.astro.build/en/core-concepts/astro-components/
[eslint-plugin-jsx-a11y]: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y
28 changes: 14 additions & 14 deletions docs/rules.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Available Rules

The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) automatically fixes problems reported by rules which have a wrench :wrench: below.
The rules with the following star :star: are included in the `plugin:astro/recommended` config.
The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) automatically fixes problems reported by rules which have a wrench πŸ”§ below.
The rules with the following star ⭐ are included in the `plugin:astro/recommended` config.

> Doesn't the rule you want exist? [Share your idea of that rule with us](https://github.com/ota-meshi/eslint-plugin-astro/issues/new?template=new_rule_request.yml).
Expand All @@ -13,13 +13,13 @@ These rules relate to possible syntax or logic errors in Astro component code:

| Rule ID | Description | |
|:--------|:------------|:---|
| [astro/no-conflict-set-directives](./rules/no-conflict-set-directives.md) | disallow conflicting set directives and child contents | :star: |
| [astro/no-deprecated-astro-canonicalurl](./rules/no-deprecated-astro-canonicalurl.md) | disallow using deprecated `Astro.canonicalURL` | :star: |
| [astro/no-deprecated-astro-fetchcontent](./rules/no-deprecated-astro-fetchcontent.md) | disallow using deprecated `Astro.fetchContent()` | :star::wrench: |
| [astro/no-deprecated-astro-resolve](./rules/no-deprecated-astro-resolve.md) | disallow using deprecated `Astro.resolve()` | :star: |
| [astro/no-deprecated-getentrybyslug](./rules/no-deprecated-getentrybyslug.md) | disallow using deprecated `getEntryBySlug()` | :star: |
| [astro/no-unused-define-vars-in-style](./rules/no-unused-define-vars-in-style.md) | disallow unused `define:vars={...}` in `style` tag | :star: |
| [astro/valid-compile](./rules/valid-compile.md) | disallow warnings when compiling. | :star: |
| [astro/no-conflict-set-directives](./rules/no-conflict-set-directives.md) | disallow conflicting set directives and child contents | ⭐ |
| [astro/no-deprecated-astro-canonicalurl](./rules/no-deprecated-astro-canonicalurl.md) | disallow using deprecated `Astro.canonicalURL` | ⭐ |
| [astro/no-deprecated-astro-fetchcontent](./rules/no-deprecated-astro-fetchcontent.md) | disallow using deprecated `Astro.fetchContent()` | β­πŸ”§ |
| [astro/no-deprecated-astro-resolve](./rules/no-deprecated-astro-resolve.md) | disallow using deprecated `Astro.resolve()` | ⭐ |
| [astro/no-deprecated-getentrybyslug](./rules/no-deprecated-getentrybyslug.md) | disallow using deprecated `getEntryBySlug()` | ⭐ |
| [astro/no-unused-define-vars-in-style](./rules/no-unused-define-vars-in-style.md) | disallow unused `define:vars={...}` in `style` tag | ⭐ |
| [astro/valid-compile](./rules/valid-compile.md) | disallow warnings when compiling. | ⭐ |

## Security Vulnerability

Expand All @@ -35,7 +35,7 @@ These rules relate to better ways of doing things to help you avoid problems:

| Rule ID | Description | |
|:--------|:------------|:---|
| [astro/no-set-text-directive](./rules/no-set-text-directive.md) | disallow use of `set:text` | :wrench: |
| [astro/no-set-text-directive](./rules/no-set-text-directive.md) | disallow use of `set:text` | πŸ”§ |
| [astro/no-unused-css-selector](./rules/no-unused-css-selector.md) | disallow selectors defined in `style` tag that don't use in HTML | |

## Stylistic Issues
Expand All @@ -44,9 +44,9 @@ These rules relate to style guidelines, and are therefore quite subjective:

| Rule ID | Description | |
|:--------|:------------|:---|
| [astro/prefer-class-list-directive](./rules/prefer-class-list-directive.md) | require `class:list` directives instead of `class` with expressions | :wrench: |
| [astro/prefer-object-class-list](./rules/prefer-object-class-list.md) | require use object instead of ternary expression in `class:list` | :wrench: |
| [astro/prefer-split-class-list](./rules/prefer-split-class-list.md) | require use split array elements in `class:list` | :wrench: |
| [astro/prefer-class-list-directive](./rules/prefer-class-list-directive.md) | require `class:list` directives instead of `class` with expressions | πŸ”§ |
| [astro/prefer-object-class-list](./rules/prefer-object-class-list.md) | require use object instead of ternary expression in `class:list` | πŸ”§ |
| [astro/prefer-split-class-list](./rules/prefer-split-class-list.md) | require use split array elements in `class:list` | πŸ”§ |

## A11Y Extension Rules

Expand Down Expand Up @@ -98,6 +98,6 @@ These rules extend the rules provided by ESLint itself to work well in Astro com

| Rule ID | Description | |
|:--------|:------------|:---|
| [astro/semi](./rules/semi.md) | Require or disallow semicolons instead of ASI | :wrench: |
| [astro/semi](./rules/semi.md) | Require or disallow semicolons instead of ASI | πŸ”§ |

[eslint-plugin-jsx-a11y]: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y
6 changes: 3 additions & 3 deletions docs/rules/jsx-a11y/alt-text.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ The following is a partial excerpt from the [jsx-a11y/alt-text] rule documentati

> Enforce that all elements that require alternative text have meaningful information to relay back to the end user. This is a critical component of accessibility for screen reader users in order for them to understand the content's purpose on the page. By default, this rule checks for alternative text on the following elements: `<img>`, `<area>`, `<input type="image">`, and `<object>`.
## :books: Further Reading
## πŸ“š Further Reading

- [jsx-a11y/alt-text]

## :rocket: Version
## πŸš€ Version

This rule was introduced in eslint-plugin-astro v0.11.0

## :mag: Implementation
## πŸ” Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/src/rules/jsx-a11y/alt-text.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/tests/src/rules/jsx-a11y/alt-text.ts)
Expand Down
6 changes: 3 additions & 3 deletions docs/rules/jsx-a11y/anchor-ambiguous-text.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ The following is a partial excerpt from the [jsx-a11y/anchor-ambiguous-text] rul

> Enforces `<a>` values are not exact matches for the phrases "click here", "here", "link", "a link", or "learn more". Screenreaders announce tags as links/interactive, but rely on values for context. Ambiguous anchor descriptions do not provide sufficient context for users.
## :books: Further Reading
## πŸ“š Further Reading

- [jsx-a11y/anchor-ambiguous-text]

## :rocket: Version
## πŸš€ Version

This rule was introduced in eslint-plugin-astro v0.22.0

## :mag: Implementation
## πŸ” Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/src/rules/jsx-a11y/anchor-ambiguous-text.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/tests/src/rules/jsx-a11y/anchor-ambiguous-text.ts)
Expand Down
6 changes: 3 additions & 3 deletions docs/rules/jsx-a11y/anchor-has-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ The following is a partial excerpt from the [jsx-a11y/anchor-has-content] rule d

> Enforce that anchors have content and that the content is accessible to screen readers. Accessible means that it is not hidden using the `aria-hidden` prop.
## :books: Further Reading
## πŸ“š Further Reading

- [jsx-a11y/anchor-has-content]

## :rocket: Version
## πŸš€ Version

This rule was introduced in eslint-plugin-astro v0.11.0

## :mag: Implementation
## πŸ” Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/src/rules/jsx-a11y/anchor-has-content.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/tests/src/rules/jsx-a11y/anchor-has-content.ts)
Expand Down
6 changes: 3 additions & 3 deletions docs/rules/jsx-a11y/anchor-is-valid.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ The following is a partial excerpt from the [jsx-a11y/anchor-is-valid] rule docu
>
> Whilst it is possible, for example, to turn the `<a>` element into a fully functional `<button>` element with ARIA, the native user agent implementations of HTML elements are to be preferred over custom ARIA solutions.
## :books: Further Reading
## πŸ“š Further Reading

- [jsx-a11y/anchor-is-valid]

## :rocket: Version
## πŸš€ Version

This rule was introduced in eslint-plugin-astro v0.11.0

## :mag: Implementation
## πŸ” Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/src/rules/jsx-a11y/anchor-is-valid.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/tests/src/rules/jsx-a11y/anchor-is-valid.ts)
Expand Down
6 changes: 3 additions & 3 deletions docs/rules/jsx-a11y/aria-activedescendant-has-tabindex.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ element.
have an inherent `tabIndex` of zero or declare a `tabIndex` of zero with the `tabIndex`
attribute.

## :books: Further Reading
## πŸ“š Further Reading

- [jsx-a11y/aria-activedescendant-has-tabindex]

## :rocket: Version
## πŸš€ Version

This rule was introduced in eslint-plugin-astro v0.11.0

## :mag: Implementation
## πŸ” Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/src/rules/jsx-a11y/aria-activedescendant-has-tabindex.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/tests/src/rules/jsx-a11y/aria-activedescendant-has-tabindex.ts)
Expand Down
6 changes: 3 additions & 3 deletions docs/rules/jsx-a11y/aria-props.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ The following is a partial excerpt from the [jsx-a11y/aria-props] rule documenta

> Elements cannot use an invalid ARIA attribute. This will fail if it finds an `aria-*` property that is not listed in [WAI-ARIA States and Properties spec](https://www.w3.org/WAI/PF/aria-1.1/states_and_properties).
## :books: Further Reading
## πŸ“š Further Reading

- [jsx-a11y/aria-props]

## :rocket: Version
## πŸš€ Version

This rule was introduced in eslint-plugin-astro v0.11.0

## :mag: Implementation
## πŸ” Implementation

- [Rule source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/src/rules/jsx-a11y/aria-props.ts)
- [Test source](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/tests/src/rules/jsx-a11y/aria-props.ts)
Expand Down
Loading

0 comments on commit d4a834a

Please sign in to comment.