Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix(experimental-utils): export RuleCreator interfaces #4199

Merged
merged 1 commit into from Nov 23, 2021
Merged

fix(experimental-utils): export RuleCreator interfaces #4199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 8 additions & 10 deletions packages/experimental-utils/src/eslint-utils/RuleCreator.ts
View file
Open in desktop
Expand Up @@ -8,12 +8,12 @@ import {
import { applyDefault } from './applyDefault';

// we automatically add the url
type NamedCreateRuleMetaDocs = Omit<RuleMetaDataDocs, 'url'>;
type NamedCreateRuleMeta<TMessageIds extends string> = {
export type NamedCreateRuleMetaDocs = Omit<RuleMetaDataDocs, 'url'>;
export type NamedCreateRuleMeta<TMessageIds extends string> = {
docs: NamedCreateRuleMetaDocs;
} & Omit<RuleMetaData<TMessageIds>, 'docs'>;

interface CreateAndOptions<
export interface RuleCreateAndOptions<
TOptions extends readonly unknown[],
TMessageIds extends string,
TRuleListener extends RuleListener,
Expand All @@ -25,19 +25,19 @@ interface CreateAndOptions<
defaultOptions: Readonly<TOptions>;
}

interface RuleWithMeta<
export interface RuleWithMeta<
TOptions extends readonly unknown[],
TMessageIds extends string,
TRuleListener extends RuleListener,
> extends CreateAndOptions<TOptions, TMessageIds, TRuleListener> {
> extends RuleCreateAndOptions<TOptions, TMessageIds, TRuleListener> {
meta: RuleMetaData<TMessageIds>;
}

interface RuleWithMetaAndName<
export interface RuleWithMetaAndName<
TOptions extends readonly unknown[],
TMessageIds extends string,
TRuleListener extends RuleListener,
> extends CreateAndOptions<TOptions, TMessageIds, TRuleListener> {
> extends RuleCreateAndOptions<TOptions, TMessageIds, TRuleListener> {
meta: NamedCreateRuleMeta<TMessageIds>;
name: string;
}
Expand All @@ -48,7 +48,7 @@ interface RuleWithMetaAndName<
* @param urlCreator Creates a documentation URL for a given rule name.
* @returns Function to create a rule with the docs URL format.
*/
function RuleCreator(urlCreator: (ruleName: string) => string) {
export function RuleCreator(urlCreator: (ruleName: string) => string) {
// This function will get much easier to call when this is merged https://github.com/Microsoft/TypeScript/pull/26349
// TODO - when the above PR lands; add type checking for the context.report `data` property
return function createNamedRule<
Expand Down Expand Up @@ -106,5 +106,3 @@ function createRule<
}

RuleCreator.withoutDocs = createRule;

export { RuleCreator };