Linting

Some bot mistakes compile cleanly and only fail when a user clicks. A handler without its route decorator never answers, and a builder with a name Discord rejects fails when you deploy. The seedcord and discord.js lint rules report both in your editor, before the bot ever starts.

The scaffold writes eslint.config.ts for you, plus two scripts that run ESLint over your src folder.

pnpm run lint

lint:fix runs the same rules and writes back the fixes it can apply.

Setting up typescript-eslint, import ordering, and several more plugins by hand takes a long config file that you then maintain. The scaffold's file is one call instead.

import createConfig from '@seedcord/eslint-config';

export default createConfig({
    tsconfigRootDir: import.meta.dirname,
    registerDiscordjsPlugin: true,
    registerSeedcordPlugin: true,
    generalIgnores: ['**/seedcord-gen.d.ts']
});

createConfig returns a flat config array, so ESLint reads it directly. By default it turns on the typescript-eslint presets, import ordering, TSDoc syntax checking, unicorn, the security plugin, and prettier compatibility. tsconfigRootDir points the type-aware rules at your tsconfig.json. import.meta.dirname is the folder holding eslint.config.ts. That value is right whenever your tsconfig.json is in the same folder as eslint.config.ts.

registerDiscordjsPlugin and registerSeedcordPlugin add the rules written for bots. If you leave either one out, its rules never run. The next two sections list what each one brings in.

These read your handlers, commands, events, and subscribers. Some catch a class that never registers. The rest catch a call that bypasses the framework.

Builders get their own set. Most of these rules stop a payload Discord would reject, or one discord.js refuses to build.

prefer-ephemeral-flag and prefer-v2-component report as warnings, since both describe a preference. Every other rule on this page reports as an error.

Sometimes a rule fits most of your bot and not one folder, like old code you haven't moved to v2 components yet. The seedcord rules carry a @seedcord/ prefix, and the discord.js rules carry discordjs/. The rule tables leave those prefixes out, so write the full name when you change a rule.

userConfigs goes in last, so anything you put there overrides the blocks above it. This one turns prefer-v2-component off for src/legacy only.

export default createConfig({
    tsconfigRootDir: import.meta.dirname,
    registerDiscordjsPlugin: true,
    registerSeedcordPlugin: true,
    userConfigs: [
        {
            files: ['src/legacy/**/*.ts'],
            rules: { 'discordjs/prefer-v2-component': 'off' }
        }
    ]
});

Every one of these is optional. The defaults suit a normal bot. For the full set, including the Tailwind and MDX keys a web project would set, see SeedcordConfigOptions.

Prettier formats your code and reads its own config file. The scaffold points that file at the shared prettier config, so formatting matches across seedcord projects.

import { createPrettierConfig } from '@seedcord/eslint-config/prettier';

export default createPrettierConfig();

createPrettierConfig also takes per-glob overrides, and a tailwind option for web projects that sort Tailwind classes.

export default createPrettierConfig({
    overrides: [{ files: '*.md', options: { proseWrap: 'always' } }]
});

createConfig already applies eslint-config-prettier, which switches off every ESLint rule that overlaps prettier's formatting. You don't install it or add it to userConfigs.

pnpm add -D @seedcord/eslint-config eslint jiti typescript

@seedcord/eslint-config brings the seedcord and discord.js rule plugins with it, so that one line installs everything. ESLint loads a TypeScript config file through jiti. Add the eslint.config.ts from the top of this page along with the two scripts.

{
    "scripts": {
        "lint": "eslint 'src/**/*.ts' --cache",
        "lint:fix": "eslint 'src/**/*.ts' --fix --cache"
    }
}