npmpackage.info

Gathering detailed insights and metrics for eslint-mdx

eslint-mdx

ESLint Parser/Plugin for MDX

3.1.5

267

MIT

TypeScript

22.90 kB

28,534,572 3.8

Installations

npm install eslint-mdx

Pull Requests

Open

11

Total

433

Closed

99

Merged

323

Issues

Open

17

Total

116

Closed

99

Releases

129

eslint-mdx@2.3.4

Published on 14 Jan 2024

eslint-plugin-mdx@2.3.4

Published on 14 Jan 2024

v2.3.5

Published on 14 Jan 2024

eslint-plugin-mdx@3.1.5

Published on 14 Jan 2024

eslint-mdx@3.1.5

Published on 14 Jan 2024

v3.1.5

Published on 14 Jan 2024

View all 129 releases

Developer

mdx-js

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=18.0.0

Typescript Support

Yes

Node Version

20.10.0

NPM Version

10.2.3 Statistics

267 Stars

406 Commits

32 Forks

8 Watching

13 Branches

26 Contributors

Updated on 21 Nov 2024

Bundle Size

70.10 kB

Minified

22.90 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (98.61%)

JavaScript (1.39%)

Total Downloads

Cumulative downloads

Total Downloads

28,534,572

Last day

-4.9%

55,753

Compared to previous day

Last week

1.7%

302,138

Compared to previous week

Last month

5.9%

1,284,958

Compared to previous month

Last year

78.1%

13,097,938

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

acorn acorn-jsx espree estree-util-visit remark-mdx remark-parse remark-stringify synckit tslib unified unified-engine unist-util-visit uvu vfile

Peer Dependencies

eslint

Versions

ESLint Parser/Plugin for MDX, helps you lint all ES syntaxes. Linting code blocks can be enabled with mdx/code-blocks setting too! Work perfectly with eslint-plugin-import, eslint-plugin-prettier or any other eslint plugins. And also can be integrated with remark-lint plugins to lint markdown syntaxes.

VSCode Extension

VSCode MDX: Integrates with VSCode ESLint, syntaxes highlighting and error reporting.

Packages

This repository is a monorepo managed by changesets what means we actually publish several packages to npm from same codebase, including:

Package	Description	Version
`eslint-mdx`	ESLint Parser for MDX
`eslint-plugin-mdx`	ESLint Plugin, Configuration and Rules for MDX

Install

1# yarn
2yarn add -D eslint-plugin-mdx
3
4# npm
5npm i -D eslint-plugin-mdx

Notice

If you're using multi languages, js/jsx/ts/tsx/vue, etc for example, you'd better to always use overrides feature of ESLint, because configs may be overridden by following configs.

See #251 for more details.

Usage

Classic

.eslintrc file:

1{
2  "extends": ["plugin:mdx/recommended"],
3  // optional, if you want to lint code blocks at the same time
4  "settings": {
5    "mdx/code-blocks": true,
6    // optional, if you want to disable language mapper, set it to `false`
7    // if you want to override the default language mapper inside, you can provide your own
8    "mdx/language-mapper": {}
9  }
10}

Flat Config

eslint.config.js file:

1import * as mdx from 'eslint-plugin-mdx'
2
3export default [
4  {
5    ...mdx.flat,
6    // optional, if you want to lint code blocks at the same
7    processor: mdx.createRemarkProcessor({
8      lintCodeBlocks: true,
9      // optional, if you want to disable language mapper, set it to `false`
10      // if you want to override the default language mapper inside, you can provide your own
11      languageMapper: {},
12    }),
13  },
14  {
15    ...mdx.flatCodeBlocks,
16    rules: {
17      ...mdx.flatCodeBlocks.rules,
18      // if you want to override some rules for code blocks
19      'no-var': 'error',
20      'prefer-const': 'error',
21    },
22  },
23]

Then, make sure ESLint knows to run on .md or .mdx files:

1eslint . --ext js,md,mdx

Parser Options

extensions (string | string[]): eslint-mdx will only resolve .mdx files by default, if you want to resolve other extensions as like .mdx, you can use this option.
markdownExtensions (string | string[]): eslint-mdx will only treat .md files as plain markdown by default, and will lint them via remark plugins. If you want to resolve other extensions as like .md, you can use this option.
ignoreRemarkConfig (boolean): Ignore the remark configuration defined in the project.

Parser API

`MDXCode`

A new MDXCode estree node type is exported from eslint-mdx which represents code blocks in mdx like the following:

1<div>
2  ```js
3  export function foo() {
4    return 'bar'
5  }
6  ```
7</div>

`MDXHeading`

A new MDXHeading estree node type is exported from eslint-mdx which represents markdown heading in mdx like the following:

1<div>
2# Here's a text gradient short code!
3</div>

Typings

1import type { BaseNode } from 'estree'
2import type { JSXElement } from 'estree-jsx'
3
4export interface MDXCode extends BaseNode {
5  type: 'MDXCode'
6  value: string
7  lang?: string | null
8  meta?: string | null
9}
10
11export type HeadingDepth = 1 | 2 | 3 | 4 | 5 | 6
12
13export interface MDXHeading extends BaseNode {
14  type: 'MDXHeading'
15  depth: HeadingDepth
16  children: JSXElement['children']
17}

Rules

mdx/remark

possible fixable depends on your remark plugins:

Integration with remark-lint plugins, it will read remark's configuration automatically via unified-engine. But .remarkignore will not be respected, you should use .eslintignore instead.

If you want to disable or change severity of some related rules, it won't work by setting rules in eslint config like 'remark-lint-no-duplicate-headings': 0, you should change your remark config instead like following:

1{
2  "plugins": [
3    "@1stg/remark-config",
4    // change to error severity, notice `[]` is required
5    ["lint-no-duplicate-headings", [2]],
6    // disable following plugin
7    [
8      "lint-no-multiple-toplevel-headings",
9      [0] // or false
10    ]
11  ]
12}

Prettier Integration

If you're using remark-lint feature with Prettier both together, you can try remark-preset-prettier which helps you to turn off all rules that are unnecessary or might conflict with Prettier.

1{
2  "plugins": [
3    "preset-lint-consistent",
4    "preset-lint-recommended",
5    "preset-lint-markdown-style-guide",
6    "preset-prettier"
7  ]
8}

Backers

1stG	RxTS	UnTS

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

9

SAST

Determines if the project uses static code analysis.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pkg-size.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/pkg-size.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pkg-size.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/pkg-size.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pkg-size.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/pkg-size.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/eslint-mdx/release.yml/master?enable=pin
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 third-party GitHubAction dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

3.8

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

eslint-mdx

Installations

Pull Requests

11

433

99

323

Issues

17

116

99

Releases

Developer

Developer Guide

CommonJS

>=18.0.0

Yes

20.10.0

10.2.3

Statistics

Bundle Size

70.10 kB

22.90 kB

Languages

Total Downloads

28,534,572

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

TOC

VSCode Extension

Packages

Install

Notice

Usage

Classic

Flat Config

Parser Options

Parser API

MDXCode

MDXHeading

Typings

Rules

mdx/remark

Prettier Integration

Sponsors

Backers

Changelog

License

10

10

10

10

9

1

0

0

0

0

0

0

0

3.8

/10

`MDXCode`

`MDXHeading`