Flint Plugin

Rules for writing third-party Flint plugins and custom rules. Meta!
This plugin is provided in a standalone @flint.fyi/plugin-flint npm package.

npm

npm install @flint.fyi/plugin-flint

pnpm

pnpm install @flint.fyi/plugin-flint

yarn

yarn install @flint.fyi/plugin-flint

Presets

logical

Rules that find bugs and enforce good practices for Flint plugins and rules.

flint.config.ts

import { flint } from "@flint.fyi/plugin-flint";
import { defineConfig, ts } from "flint";

export default defineConfig({
  use: [
    {
      files: ts.files.all,
      rules: flint.presets.logical,
    },
  ],
});

logicalStrict

Additional logical rules that enforce best practices which are not always straightforward to implement. These rules are recommended for projects where a majority of developers are experienced with both JavaScript/TypeScript and writing plugins for a linter.

flint.config.ts

import { flint } from "@flint.fyi/plugin-flint";
import { defineConfig, ts } from "flint";

export default defineConfig({
  use: [
    {
      files: ts.files.all,
      rules: flint.presets.logicalStrict,
    },
  ],
});

This preset’s rules are a superset of those in logical.

stylistic

Rules that enforce consistent styling and best stylistic practices for most-to-all Flint plugins.

flint.config.ts

import { flint } from "@flint.fyi/plugin-flint";
import { defineConfig, ts } from "flint";

export default defineConfig({
  use: [
    {
      files: ts.files.all,
      rules: flint.presets.stylistic,
    },
  ],
});

Rules

Implemented: 2 of 12 (16.6%)

Flint Rule	Preset
invalidCodeLinesReports cases for invalid code that isn't formatted across lines.	logical
missingPlaceholders	logical
nodePropertyInChecks	logical
ruleDescriptions	logical
rulePresets	logical
ruleURLs	logical
testCaseDuplicatesReports test cases that are identical to previous test cases.	logical
testCaseOnlies	logical
unusedMessageIds	logical
unusedPlaceholders	logical
messagePhrases	logical (strict)
testShorthands	stylistic