Skip to content

fix!: move certain types to import them from @eslint/markdown/types #446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,7 @@ import rules from "./build/rules.js";

/**
* @import { Linter } from "eslint";
* @import * as Types from "./types.js";
* @typedef {Linter.RulesRecord} RulesRecord
* @typedef {Types.MarkdownRuleDefinition} RuleModule
* @typedef {Types.MarkdownRuleVisitor} MarkdownRuleVisitor
* @typedef {Types.MarkdownRuleDefinitionTypeOptions} MarkdownRuleDefinitionTypeOptions
*/

/**
* @typedef {Types.MarkdownRuleDefinition<Options>} MarkdownRuleDefinition<Options>
* @template {Partial<MarkdownRuleDefinitionTypeOptions>} [Options={}]
*/

//-----------------------------------------------------------------------------
Expand Down
27 changes: 11 additions & 16 deletions tests/types/types.test.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import markdown, {
MarkdownSourceCode,
import markdown, { MarkdownSourceCode } from "@eslint/markdown";
import type { SourceLocation, SourceRange } from "@eslint/core";
import type {
MarkdownRuleDefinition,
MarkdownRuleVisitor,
type RuleModule,
} from "@eslint/markdown";
import type { SourceLocation, SourceRange } from "@eslint/core";
import type { Toml, Json } from "@eslint/markdown/types";
Toml,
Json,
} from "@eslint/markdown/types";
import { ESLint, Linter } from "eslint";
import type {
// Nodes (abstract)
Expand Down Expand Up @@ -77,7 +77,7 @@ typeof processorPlugins satisfies {};
null as AssertAllNamesIn<RecommendedRuleName, RuleName>;
}

(): RuleModule => ({
(): MarkdownRuleDefinition => ({
create({ sourceCode }): MarkdownRuleVisitor {
sourceCode satisfies MarkdownSourceCode;
sourceCode.ast satisfies Root;
Expand Down Expand Up @@ -172,16 +172,11 @@ typeof processorPlugins satisfies {};
},
});

// All options optional - MarkdownRuleDefinition, MarkdownRuleDefinition<{}> and RuleModule
// All options optional - MarkdownRuleDefinition and MarkdownRuleDefinition<{}>
// should be the same type.
(
rule1: MarkdownRuleDefinition,
rule2: MarkdownRuleDefinition<{}>,
rule3: RuleModule,
) => {
rule1 satisfies typeof rule2 satisfies typeof rule3;
rule2 satisfies typeof rule1 satisfies typeof rule3;
rule3 satisfies typeof rule1 satisfies typeof rule2;
(rule1: MarkdownRuleDefinition, rule2: MarkdownRuleDefinition<{}>) => {
rule1 satisfies typeof rule2;
rule2 satisfies typeof rule1;
};

// Type restrictions should be enforced
Expand Down