Node.js Plugin

Rules for code that runs in Node.js and other server runtimes that include Node.js-like APIs.
This plugin is provided in a standalone @flint.fyi/plugin-node npm package.

npm

npm install @flint.fyi/plugin-node

pnpm

pnpm install @flint.fyi/plugin-node

yarn

yarn install @flint.fyi/plugin-node

Presets

Flint’s Node.js plugin provides the following presets:

Preset	Recommended	Description
logical	✅ Always	Common rules for finding bugs and enforcing good logical practices in Markdown files.
stylistic	✅ Always	Common rules for consistent styling and best stylistic practices in Markdown files.
stylisticStrict	☑️ When Ready	Additional rules for consistent styling and best stylistic practices in Markdown files.

If you are just getting started with linting, Flint recommends using the logical and stylistic presets:

flint.config.ts

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

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

If you are experienced with both Markdown and linting, Flint recommends additionally using the stylisticStrict preset:

flint.config.ts

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

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

Note

Coming soon: more expansive documentation on choosing and combining plugins & presets with Flint.

logical

Rules that find bugs and enforce good Node.js and general server-side best practices for most-to-all JavaScript and TypeScript files.

flint.config.ts

import { defineConfig, node } from "flint";

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

stylistic

Rules that enforce consistent styling and best stylistic practices for most-to-all JavaScript and TypeScript files dealing with Node.js APIs.

flint.config.ts

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

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

stylisticStrict

Additional stylistic 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 Node.js and using a linter.

flint.config.ts

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

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

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

Rules

Implemented: 11 of 18 (61.1%)

Flint Rule	Preset
assertStrictPrefer strict assertion mode from Node.js for better error messages and behavior.	logical
bufferAllocatorsPrefer modern Buffer allocation methods over the deprecated Buffer constructor.	logical
exportsAssignmentsPrevent assignment to the exports variable in CommonJS modules.	logical
hashbangs	logical
nodeProtocolsPrefer the node: protocol prefix for Node.js built-in modules for clarity and consistency.	logical
processExitsPrevent direct use of process.exit() for better error handling and testing.	logical
unpublishedBins	logical
unpublishedImports	logical
unsupportedGlobals	logical
unsupportedNodeAPIs	logical
unsupportedSyntax	logical
eventClassesPrefer EventTarget over EventEmitter for cross-platform compatibility.	logical (strict)
assertStylesPrefer assert.ok() over assert() for explicit intent and better readability.	stylistic
blobReadingMethodsPrefer direct Blob reading methods over wrapping in Response for simpler code.	stylistic
consoleSpacesDisallow leading or trailing spaces in console method string arguments.	stylistic (strict)
filePathsFromImportMetaPrefer import.meta.dirname and import.meta.filename over legacy file path techniques.	stylistic (strict)
fileReadJSONBuffersPrefer reading JSON files as buffers when using JSON.parse for better performance.	stylistic (strict)
importFileExtensions	(none)