feat: add `ruleCreationMethods` rule by kovsu · Pull Request #2301 · flint-fyi/flint

kovsu · 2026-02-10T01:40:09Z

PR Checklist

Addresses an existing open issue: fixes 🚀 Feature: Add Flint rule that plugins should define rule with RuleCreator #1747
That issue was marked as status: accepting prs
Steps in CONTRIBUTING.md were taken

Overview

changeset-bot · 2026-02-10T01:40:13Z

🦋 Changeset detected

Latest commit: 62e1a89

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2026-02-10T01:40:16Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
flint	Ready	Preview, Comment	Mar 1, 2026 4:10pm

michaelfaith · 2026-02-10T02:15:46Z

packages/plugin-flint/src/rules/ruleCreationMethods.ts

+				"RuleCreator adds the `docs` property and ensures consistent rule structure across plugins.",
+			],
+			suggestions: [
+				"Import RuleCreator and use `ruleCreator.createRule(language, { ... })` instead of `language.createRule({ ... })`.",


Should we tell them which package to import RuleCreator from? Without that, I'm not sure I'd know what to do to address the violation.

how about this?

suggestions: [ "Import RuleCreator from `@flint.fyi/core` and instantiate a ruleCreator (e.g. `const ruleCreator = new RuleCreator({ presets: [...] })`).", "Use `ruleCreator.createRule(language, { ... })` instead of `language.createRule({ ... })`.", ],

packages/plugin-flint/src/utils/ruleCreatorHelpers.ts

michaelfaith

Just a minor wording suggestion (for the suggestion 😅). Otherwise looks good! I'll mark as Approved and you can decide if you like the suggestion or not.

michaelfaith · 2026-02-10T11:04:53Z

packages/plugin-flint/src/rules/ruleCreationMethods.ts

 			suggestions: [
-				"Import RuleCreator and use `ruleCreator.createRule(language, { ... })` instead of `language.createRule({ ... })`.",
+				"Import RuleCreator from `@flint.fyi/core` and instantiate a ruleCreator (e.g. `const ruleCreator = new RuleCreator({ presets: [...] })`).",
+				"Use `ruleCreator.createRule(language, { ... })` instead of `language.createRule({ ... })`.",


Minor suggestion to read a bit more smoothly between the two lines

Suggested change

"Use `ruleCreator.createRule(language, { ... })` instead of `language.createRule({ ... })`.",

"Create an instance of RuleCreator from `@flint.fyi/core` (e.g. `const ruleCreator = new RuleCreator({ presets: [...] })`).",

"And then use `ruleCreator.createRule(language, { ... })` instead of `language.createRule({ ... })`.",

(apparently you can't provide suggestions across multiple lines, but you get the idea 😅)

Oh you have to select multiple lines. Which... GitHub sometimes breaks in the UI 🙃

michaelfaith · 2026-02-10T11:11:11Z

packages/plugin-flint/src/utils/ruleCreatorHelpers.ts

-	const propertyAccess = node.expression as AST.PropertyAccessExpression;
-	const type = typeChecker.getTypeAtLocation(propertyAccess.expression);
+	if (
+		node.expression.kind === SyntaxKind.PropertyAccessExpression &&


Oh, I was suggesting something like this

const isPropertyAccessExpression = (node: : AST.CallExpression): node is PropertyAccessExpression { return node.expression.kind === SyntaxKind.PropertyAccessExpression; } const isCreateRuleCall = (node: : AST.CallExpression): boolean { return isPropertyAccessExpression(node) && node.expression.name.text === "createRule"; }

But this works fine too. 👍

JoshuaKGoldberg

The implementation looks great - I love how clean this is with the shared isLanguageCreateRule helper! 🙌

Just requesting that an .mdx file be added.

packages/plugin-flint/src/rules/ruleCreationMethods.test.ts

JoshuaKGoldberg · 2026-02-10T16:24:06Z

packages/plugin-flint/src/rules/ruleCreationMethods.ts

 			suggestions: [
-				"Import RuleCreator and use `ruleCreator.createRule(language, { ... })` instead of `language.createRule({ ... })`.",
+				"Import RuleCreator from `@flint.fyi/core` and instantiate a ruleCreator (e.g. `const ruleCreator = new RuleCreator({ presets: [...] })`).",
+				"Use `ruleCreator.createRule(language, { ... })` instead of `language.createRule({ ... })`.",


Oh you have to select multiple lines. Which... GitHub sometimes breaks in the UI 🙃

packages/plugin-flint/src/rules/ruleCreationMethods.ts

JoshuaKGoldberg

(wrong button)

.changeset/crisp-foxes-join.md

lishaduck

Looks good, just a few very minor comments!

lishaduck · 2026-02-18T03:59:56Z

packages/core/src/rules/RuleCreator.ts

+		// Use RuleCreator.createRule instead of Language.createRule
+		// But this is the original implementation


I just wanna say this is 🔥 lol.

Actually, TBH maybe we should ignore this rule for the core package specifically, because ~~it shouldn't be defining any rules?~~ No, that depends on how we structure #2181. Though, having said that, we probably should structure it out-of-core. Ehh, who cares?

packages/plugin-flint/src/utils/ruleCreatorHelpers.ts

packages/site/src/content/docs/rules/flint/ruleCreationMethods.mdx

lishaduck

Looks fine by me :)

packages/site/src/content/docs/rules/flint/ruleCreationMethods.mdx

….mdx Co-authored-by: Eli <88557639+lishaduck@users.noreply.github.com>

vercel · 2026-02-21T06:24:21Z

Deployment failed with the following error:

The provided GitHub repository does not contain the requested branch or commit reference. Please ensure the repository is not empty.

JoshuaKGoldberg

I don't know what's going on with the deployment, but this is great. Thanks @kovsu! 🙌

vercel bot deployed to Preview February 10, 2026 01:42 View deployment

michaelfaith reviewed Feb 10, 2026

View reviewed changes

vercel bot deployed to Preview February 10, 2026 03:12 View deployment

michaelfaith approved these changes Feb 10, 2026

View reviewed changes

michaelfaith added the 1 approval One team member approved; we're now waiting for a second approval or for 2 business days to pass. label Feb 10, 2026

JoshuaKGoldberg approved these changes Feb 10, 2026

View reviewed changes

JoshuaKGoldberg added status: waiting for author Needs an action taken by the original poster and removed 1 approval One team member approved; we're now waiting for a second approval or for 2 business days to pass. labels Feb 10, 2026

JoshuaKGoldberg requested changes Feb 10, 2026

View reviewed changes

vercel bot deployed to Preview February 14, 2026 15:58 View deployment

kovsu requested a review from JoshuaKGoldberg February 14, 2026 16:00

github-actions bot removed the status: waiting for author Needs an action taken by the original poster label Feb 14, 2026

michaelfaith reviewed Feb 15, 2026

View reviewed changes

.changeset/crisp-foxes-join.md Outdated Show resolved Hide resolved

vercel bot deployed to Preview February 17, 2026 14:58 View deployment

JoshuaKGoldberg mentioned this pull request Feb 17, 2026

Discussion: Should RuleCreator and/or pluginId be required for creating rules? #2326

Open

lishaduck requested changes Feb 18, 2026

View reviewed changes

vercel bot deployed to Preview February 20, 2026 16:30 View deployment

kovsu added 5 commits February 21, 2026 00:38

feat: add ruleCreationMethods rule

21f5fc5

apply suggestions

0e28a93

combine suggestions to one line & add .mdx file

5d444e7

update changeset

2e3b85a

apply suggestion

722b750

kovsu force-pushed the fix-#1747 branch from a124810 to 722b750 Compare February 20, 2026 16:38

vercel bot deployed to Preview February 20, 2026 16:40 View deployment

fix

56636e4

vercel bot deployed to Preview February 20, 2026 16:50 View deployment

lishaduck approved these changes Feb 20, 2026

View reviewed changes

packages/site/src/content/docs/rules/flint/ruleCreationMethods.mdx Outdated Show resolved Hide resolved

Update packages/site/src/content/docs/rules/flint/ruleCreationMethods…

9723ad2

….mdx Co-authored-by: Eli <88557639+lishaduck@users.noreply.github.com>

JoshuaKGoldberg approved these changes Mar 1, 2026

View reviewed changes

Merge branch 'main' into fix-flint-fyi#1747

62e1a89

vercel bot deployed to Preview March 1, 2026 16:10 View deployment

JoshuaKGoldberg merged commit efe6df5 into flint-fyi:main Mar 1, 2026
8 checks passed

kovsu deleted the fix-#1747 branch March 2, 2026 00:29

	"Use `ruleCreator.createRule(language, { ... })` instead of `language.createRule({ ... })`.",
	"Create an instance of RuleCreator from `@flint.fyi/core` (e.g. `const ruleCreator = new RuleCreator({ presets: [...] })`).",
	"And then use `ruleCreator.createRule(language, { ... })` instead of `language.createRule({ ... })`.",

		// Use RuleCreator.createRule instead of Language.createRule
		// But this is the original implementation

Conversation

kovsu commented Feb 10, 2026

PR Checklist

Overview

Uh oh!

changeset-bot bot commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

michaelfaith Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

kovsu Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

michaelfaith left a comment

Choose a reason for hiding this comment

Uh oh!

michaelfaith Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

michaelfaith Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

michaelfaith Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JoshuaKGoldberg Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lishaduck left a comment

Choose a reason for hiding this comment

Uh oh!

lishaduck Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lishaduck left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vercel bot commented Feb 21, 2026

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Feb 10, 2026 •

edited

Loading

vercel bot commented Feb 10, 2026 •

edited

Loading

lishaduck Feb 18, 2026 •

edited

Loading