Skip to content

Commit 21934ce

Browse files
JounQinJounQin
committed
docs: mention vscode-mdx in README
1 parent 4651931 commit 21934ce

File tree

7 files changed

+104
-68
lines changed

7 files changed

+104
-68
lines changed

‎.travis.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ before_deploy:
3131
- git checkout $TRAVIS_BRANCH
3232
- cp -f README.md packages/eslint-mdx
3333
- cp -f README.md packages/eslint-plugin-mdx
34-
- git add --all && git commit -m "docs:\ update README" || echo 'nothing changed to commit'
34+
- 'git add --all && git commit -m "docs: update README" || echo "nothing changed to commit"'
3535
- yarn run lerna-changelog
3636

3737
deploy:

‎README.md‎

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,26 @@
1313
[![Travis](https://img.shields.io/travis/com/rx-ts/eslint-mdx.svg)](https://travis-ci.com/rx-ts/eslint-mdx)
1414
[![Codecov](https://img.shields.io/codecov/c/gh/rx-ts/eslint-mdx)](https://codecov.io/gh/rx-ts/eslint-mdx)
1515
[![GitHub release](https://img.shields.io/github/release/rx-ts/eslint-mdx)](https://github.com/rx-ts/eslint-mdx/releases)
16+
[![David Dev](https://img.shields.io/david/dev/rx-ts/eslint-mdx.svg)](https://david-dm.org/rx-ts/eslint-mdx?type=dev)
1617
[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
1718
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
1819
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org)
1920

2021
> [ESLint] Parser/Plugin for [MDX], helps you lint all ES syntaxes excluding `code` block of course.
2122
> Work perfectly with `eslint-plugin-import`, `eslint-plugin-prettier` or any other eslint plugins.
2223
24+
## VSCode Extension [![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/JounQin.vscode-mdx)](https://marketplace.visualstudio.com/items?itemName=JounQin.vscode-mdx)
25+
26+
[VSCode MDX]: Integrates with [VSCode ESLint], syntaxes highlighting and error reporting.
27+
2328
## Packages
2429

25-
This repository is a monorepo managed by Lerna what means we actually publish several packages to npm from the same codebase, including:
30+
This repository is a monorepo managed by [Lerna] what means we actually publish several packages to npm from same codebase, including:
2631

27-
| Package | Version | Dependencies Status | Description |
28-
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
29-
| [`eslint-mdx`](/packages/eslint-mdx) | [![npm](https://img.shields.io/npm/v/eslint-mdx.svg)](https://www.npmjs.com/package/eslint-mdx) | [![David Peer](https://img.shields.io/david/peer/rx-ts/eslint-mdx.svg?path=packages/eslint-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-mdx&type=peer) [![David](https://img.shields.io/david/rx-ts/eslint-mdx.svg?path=packages/eslint-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-mdx) | ESLint Parser for MDX |
30-
| [`@rxts/eslint-plugin-mdx`](/packages/eslint-plugin-mdx) | [![npm](https://img.shields.io/npm/v/@rxts/eslint-plugin-mdx.svg)](https://www.npmjs.com/package/@rxts/eslint-plugin-mdx) | [![David Peer](https://img.shields.io/david/peer/rx-ts/eslint-mdx.svg?path=packages/eslint-plugin-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-plugin-mdx&type=peer) [![David](https://img.shields.io/david/rx-ts/eslint-mdx.svg?path=packages/eslint-plugin-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-plugin-mdx) | ESLint Plugin, Configuration and Rules for MDX |
32+
| Package | Description | Version | Peer Dependencies | Dependencies |
33+
| -------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34+
| [`eslint-mdx`](/packages/eslint-mdx) | ESLint Parser for MDX | [![npm](https://img.shields.io/npm/v/eslint-mdx.svg)](https://www.npmjs.com/package/eslint-mdx) | [![David Peer](https://img.shields.io/david/peer/rx-ts/eslint-mdx.svg?path=packages/eslint-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-mdx&type=peer) | [![David](https://img.shields.io/david/rx-ts/eslint-mdx.svg?path=packages/eslint-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-mdx) |
35+
| [`@rxts/eslint-plugin-mdx`](/packages/eslint-plugin-mdx) | ESLint Plugin, Configuration and Rules for MDX | [![npm](https://img.shields.io/npm/v/@rxts/eslint-plugin-mdx.svg)](https://www.npmjs.com/package/@rxts/eslint-plugin-mdx) | [![David Peer](https://img.shields.io/david/peer/rx-ts/eslint-mdx.svg?path=packages/eslint-plugin-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-plugin-mdx&type=peer) | [![David](https://img.shields.io/david/rx-ts/eslint-mdx.svg?path=packages/eslint-plugin-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-plugin-mdx) |
3136

3237
## Install
3338

@@ -57,7 +62,7 @@ npm i -D @rxts/eslint-plugin-mdx
5762
}
5863
```
5964

60-
2. If you're using `eslint@^5.0.0`, you need to enable this parse/plugin manually, because `eslint@5` does not support `extends` for `overrides` property in its configuration:
65+
2. If you're using `eslint@^5.0.0`, you need to enable this parser/plugin manually, because `eslint@5` does not support `extends` for `overrides` property in its configuration:
6166

6267
```json
6368
{
@@ -85,7 +90,7 @@ npm i -D @rxts/eslint-plugin-mdx
8590

8691
## Parser Options
8792

88-
1. `parser` (`string | ParserConfig | ParserFn`): Custom parser for ES syntax is supported, although `@typescript-eslint/parser` or `babel-eslint` will be detected automatically what means you actually do not need do this:
93+
1. `parser` (`string | ParserConfig | ParserFn`): Custom parser for ES syntax is supported, although `@typescript-eslint/parser` or `babel-eslint` will be detected automatically what means you actually do not need to do this:
8994

9095
```json
9196
{
@@ -114,21 +119,26 @@ Inline JSX like `Inline <Component />` is supported by [MDX], but rule `react/no
114119

115120
## Limitation
116121

117-
> This parser/plugin can only handle ES syntaxes for you, markdown related syntaxes will just be ignored, you can use [markdownlint] or [remake-lint] to lint that part.
122+
> This parser/plugin can only handle ES syntaxes for you, markdown related syntaxes will just be ignored, you can use [markdownlint] or [remark-lint] to lint that part.
118123
119-
I have a very preliminary idea to integrate with [remake-lint].
124+
I have a very preliminary idea to integrate with [remark-lint].
120125

121126
## Changelog
122127

123128
Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.md).
124129

125130
## License
126131

127-
[MIT]
132+
[MIT] © [JounQin]@[1stG]
128133

134+
[1stg]: https://www.1stg.me
129135
[eslint]: https://eslint.org
130136
[eslint-plugin-react]: https://github.com/yannickcr/eslint-plugin-react
137+
[jounqin]: https://GitHub.com/JounQin
138+
[lerna]: https://github.com/lerna/lerna
131139
[mdx]: https://github.com/mdx-js/mdx
132140
[mit]: http://opensource.org/licenses/MIT
133141
[markdownlint]: https://github.com/markdownlint/markdownlint
134-
[remake-lint]: https://github.com/remarkjs/remark-lint
142+
[remark-lint]: https://github.com/remarkjs/remark-lint
143+
[vscode eslint]: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
144+
[vscode mdx]: https://github.com/rx-ts/vscode-mdx

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"babel-eslint": "^10.0.2",
2626
"commitlint": "^8.1.0",
2727
"eslint": "^6.1.0",
28-
"eslint-config-1stg": "^5.6.9",
28+
"eslint-config-1stg": "^5.7.0",
2929
"eslint-formatter-friendly": "^7.0.0",
3030
"eslint-mdx": "link:packages/eslint-mdx/src",
3131
"eslint-plugin-jest": "^22.15.0",
@@ -35,7 +35,7 @@
3535
"lerna-changelog": "^0.8.2",
3636
"lint-staged": "^9.2.1",
3737
"prettier": "1.18.2",
38-
"prettier-config-1stg": "^0.1.0",
38+
"prettier-config-1stg": "^0.2.0",
3939
"react": "^16.9.0",
4040
"ts-jest": "^24.0.2",
4141
"ts-node": "^8.3.0",

‎packages/eslint-mdx/README.md‎

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,26 @@
1313
[![Travis](https://img.shields.io/travis/com/rx-ts/eslint-mdx.svg)](https://travis-ci.com/rx-ts/eslint-mdx)
1414
[![Codecov](https://img.shields.io/codecov/c/gh/rx-ts/eslint-mdx)](https://codecov.io/gh/rx-ts/eslint-mdx)
1515
[![GitHub release](https://img.shields.io/github/release/rx-ts/eslint-mdx)](https://github.com/rx-ts/eslint-mdx/releases)
16+
[![David Dev](https://img.shields.io/david/dev/rx-ts/eslint-mdx.svg)](https://david-dm.org/rx-ts/eslint-mdx?type=dev)
1617
[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
1718
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
1819
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org)
1920

2021
> [ESLint] Parser/Plugin for [MDX], helps you lint all ES syntaxes excluding `code` block of course.
2122
> Work perfectly with `eslint-plugin-import`, `eslint-plugin-prettier` or any other eslint plugins.
2223
24+
## VSCode Extension [![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/JounQin.vscode-mdx)](https://marketplace.visualstudio.com/items?itemName=JounQin.vscode-mdx)
25+
26+
[VSCode MDX]: Integrates with [VSCode ESLint], syntaxes highlighting and error reporting.
27+
2328
## Packages
2429

25-
This repository is a monorepo managed by Lerna what means we actually publish several packages to npm from the same codebase, including:
30+
This repository is a monorepo managed by [Lerna] what means we actually publish several packages to npm from same codebase, including:
2631

27-
| Package | Version | Dependencies Status | Description |
28-
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
29-
| [`eslint-mdx`](/packages/eslint-mdx) | [![npm](https://img.shields.io/npm/v/eslint-mdx.svg)](https://www.npmjs.com/package/eslint-mdx) | [![David Peer](https://img.shields.io/david/peer/rx-ts/eslint-mdx.svg?path=packages/eslint-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-mdx&type=peer) [![David](https://img.shields.io/david/rx-ts/eslint-mdx.svg?path=packages/eslint-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-mdx) | ESLint Parser for MDX |
30-
| [`@rxts/eslint-plugin-mdx`](/packages/eslint-plugin-mdx) | [![npm](https://img.shields.io/npm/v/@rxts/eslint-plugin-mdx.svg)](https://www.npmjs.com/package/@rxts/eslint-plugin-mdx) | [![David Peer](https://img.shields.io/david/peer/rx-ts/eslint-mdx.svg?path=packages/eslint-plugin-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-plugin-mdx&type=peer) [![David](https://img.shields.io/david/rx-ts/eslint-mdx.svg?path=packages/eslint-plugin-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-plugin-mdx) | ESLint Plugin, Configuration and Rules for MDX |
32+
| Package | Description | Version | Peer Dependencies | Dependencies |
33+
| -------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34+
| [`eslint-mdx`](/packages/eslint-mdx) | ESLint Parser for MDX | [![npm](https://img.shields.io/npm/v/eslint-mdx.svg)](https://www.npmjs.com/package/eslint-mdx) | [![David Peer](https://img.shields.io/david/peer/rx-ts/eslint-mdx.svg?path=packages/eslint-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-mdx&type=peer) | [![David](https://img.shields.io/david/rx-ts/eslint-mdx.svg?path=packages/eslint-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-mdx) |
35+
| [`@rxts/eslint-plugin-mdx`](/packages/eslint-plugin-mdx) | ESLint Plugin, Configuration and Rules for MDX | [![npm](https://img.shields.io/npm/v/@rxts/eslint-plugin-mdx.svg)](https://www.npmjs.com/package/@rxts/eslint-plugin-mdx) | [![David Peer](https://img.shields.io/david/peer/rx-ts/eslint-mdx.svg?path=packages/eslint-plugin-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-plugin-mdx&type=peer) | [![David](https://img.shields.io/david/rx-ts/eslint-mdx.svg?path=packages/eslint-plugin-mdx)](https://david-dm.org/rx-ts/eslint-mdx?path=packages/eslint-plugin-mdx) |
3136

3237
## Install
3338

@@ -57,7 +62,7 @@ npm i -D @rxts/eslint-plugin-mdx
5762
}
5863
```
5964

60-
2. If you're using `eslint@^5.0.0`, you need to enable this parse/plugin manually, because `eslint@5` does not support `extends` for `overrides` property in its configuration:
65+
2. If you're using `eslint@^5.0.0`, you need to enable this parser/plugin manually, because `eslint@5` does not support `extends` for `overrides` property in its configuration:
6166

6267
```json
6368
{
@@ -85,7 +90,7 @@ npm i -D @rxts/eslint-plugin-mdx
8590

8691
## Parser Options
8792

88-
1. `parser` (`string | ParserConfig | ParserFn`): Custom parser for ES syntax is supported, although `@typescript-eslint/parser` or `babel-eslint` will be detected automatically what means you actually do not need do this:
93+
1. `parser` (`string | ParserConfig | ParserFn`): Custom parser for ES syntax is supported, although `@typescript-eslint/parser` or `babel-eslint` will be detected automatically what means you actually do not need to do this:
8994

9095
```json
9196
{
@@ -114,21 +119,26 @@ Inline JSX like `Inline <Component />` is supported by [MDX], but rule `react/no
114119

115120
## Limitation
116121

117-
> This parser/plugin can only handle ES syntaxes for you, markdown related syntaxes will just be ignored, you can use [markdownlint] or [remake-lint] to lint that part.
122+
> This parser/plugin can only handle ES syntaxes for you, markdown related syntaxes will just be ignored, you can use [markdownlint] or [remark-lint] to lint that part.
118123
119-
I have a very preliminary idea to integrate with [remake-lint].
124+
I have a very preliminary idea to integrate with [remark-lint].
120125

121126
## Changelog
122127

123128
Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.md).
124129

125130
## License
126131

127-
[MIT]
132+
[MIT] © [JounQin]@[1stG]
128133

134+
[1stg]: https://www.1stg.me
129135
[eslint]: https://eslint.org
130136
[eslint-plugin-react]: https://github.com/yannickcr/eslint-plugin-react
137+
[jounqin]: https://GitHub.com/JounQin
138+
[lerna]: https://github.com/lerna/lerna
131139
[mdx]: https://github.com/mdx-js/mdx
132140
[mit]: http://opensource.org/licenses/MIT
133141
[markdownlint]: https://github.com/markdownlint/markdownlint
134-
[remake-lint]: https://github.com/remarkjs/remark-lint
142+
[remark-lint]: https://github.com/remarkjs/remark-lint
143+
[vscode eslint]: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
144+
[vscode mdx]: https://github.com/rx-ts/vscode-mdx

0 commit comments

Comments
 (0)