eslint-plugin-mdx
- Version 3.5.0
- Published
- 85.5 kB
- 10 dependencies
- MIT license
Install
npm i eslint-plugin-mdx
yarn add eslint-plugin-mdx
pnpm add eslint-plugin-mdx
Overview
ESLint Plugin for MDX
Index
Variables
Functions
Interfaces
Type Aliases
Variables
variable base
const base: Linter.LegacyConfig;
variable cjsRequire
const cjsRequire: CjsRequire;
variable codeBlocks
const codeBlocks: { parserOptions: { ecmaFeatures: { impliedStrict: true } }; rules: { 'eol-last': 'off'; 'no-undef': 'off'; 'no-unused-expressions': 'off'; 'no-unused-vars': 'off'; '@typescript-eslint/no-unused-vars': 'off'; 'padded-blocks': 'off'; strict: 'off'; 'unicode-bom': 'off'; };};
variable configs
const configs: { base: any; 'code-blocks': { parserOptions: { ecmaFeatures: { impliedStrict: true } }; rules: { 'eol-last': 'off'; 'no-undef': 'off'; 'no-unused-expressions': 'off'; 'no-unused-vars': 'off'; '@typescript-eslint/no-unused-vars': 'off'; 'padded-blocks': 'off'; strict: 'off'; 'unicode-bom': 'off'; }; }; codeBlocks: { parserOptions: { ecmaFeatures: { impliedStrict: true } }; rules: { 'eol-last': 'off'; 'no-undef': 'off'; 'no-unused-expressions': 'off'; 'no-unused-vars': 'off'; '@typescript-eslint/no-unused-vars': 'off'; 'padded-blocks': 'off'; strict: 'off'; 'unicode-bom': 'off'; }; }; flat: any; flatCodeBlocks: any; overrides: any; recommended: any;};
variable DEFAULT_LANGUAGE_MAPPER
const DEFAULT_LANGUAGE_MAPPER: { readonly ecmascript: 'js'; readonly javascript: 'js'; readonly javascriptreact: 'jsx'; readonly typescript: 'ts'; readonly typescriptreact: 'tsx'; readonly markdown: 'md'; readonly markdownjsx: 'mdx'; readonly markdownreact: 'mdx'; readonly mdown: 'md'; readonly mkdn: 'md';};
variable flat
const flat: Linter.FlatConfig;
variable flatCodeBlocks
const flatCodeBlocks: Linter.FlatConfig;
variable meta
const meta: { name: string; version: string };
variable overrides
const overrides: Linter.LegacyConfig;
variable processorOptions
const processorOptions: ProcessorOptions;
variable processors
const processors: { remark: any };
variable recommended
const recommended: Linter.LegacyConfig;
variable remark
const remark: Rule.RuleModule;
variable rules
const rules: { remark: any };
Functions
function createRemarkProcessor
createRemarkProcessor: (processorOptions?: any) => Linter.Processor;
function getGlobals
getGlobals: < T extends Record<string, unknown> | string[], G extends Record<string, boolean>, R extends G = G & Record<T extends (infer R_1)[] ? R_1 : keyof T, false>>( sources: T, initialGlobals?: G) => R;
function getShortLang
getShortLang: ( filename: string, languageMapper?: Record<string, string> | false) => string;
Interfaces
interface CodeBlock
interface CodeBlock extends Code {}
property baseIndentText
baseIndentText: string;
property comments
comments: string[];
property rangeMap
rangeMap: RangeMap[];
interface ESLintMdxSettings
interface ESLintMdxSettings {}
property 'mdx/code-blocks'
'mdx/code-blocks'?: boolean;
property 'mdx/language-mapper'
'mdx/language-mapper'?: Record<string, string> | false;
interface ExpressionStatementWithParent
interface ExpressionStatementWithParent extends ExpressionStatement, WithParent {}
interface LinterConfig
interface LinterConfig extends ESLint.Linter.LegacyConfig {}
method extractConfig
extractConfig: (filename?: string) => ESLint.Linter.LegacyConfig;
interface ProcessorOptions
interface ProcessorOptions {}
property languageMapper
languageMapper?: Record<string, string> | false;
property lintCodeBlocks
lintCodeBlocks: boolean;
interface RangeMap
interface RangeMap {}
interface RemarkLintMessage
interface RemarkLintMessage {}
interface WithParent
interface WithParent {}
property parent
parent: NodeWithParent;
Type Aliases
type NodeWithParent
type NodeWithParent = Node & WithParent;
Package Files (17)
- lib/configs/base.d.ts
- lib/configs/code-blocks.d.ts
- lib/configs/flat.d.ts
- lib/configs/index.d.ts
- lib/configs/overrides.d.ts
- lib/configs/recommended.d.ts
- lib/helpers.d.ts
- lib/index.d.ts
- lib/meta.d.ts
- lib/processors/helpers.d.ts
- lib/processors/index.d.ts
- lib/processors/options.d.ts
- lib/processors/remark.d.ts
- lib/processors/types.d.ts
- lib/rules/index.d.ts
- lib/rules/remark.d.ts
- lib/rules/types.d.ts
Dependencies (10)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (1)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/eslint-plugin-mdx
.
- Markdown[](https://www.jsdocs.io/package/eslint-plugin-mdx)
- HTML<a href="https://www.jsdocs.io/package/eslint-plugin-mdx"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2902 ms. - Missing or incorrect documentation? Open an issue for this package.