eslint-config-astrel

Custom, general-purpose ESLint rules by ASTRELION.

Rule Overview

See index.js for a list of all rules.

• Allman brace style
• Require semicolons
• Double quotes over single quotes
• 4 spaces over tabs
• No trailing spaces
• Require spaces before blocks
• Require consistent returns
• Require dangling commas for multiline statements

TypeScript Rules

• Warn against any types
• Require explicit return types
• No unused variables, unless prefixed with _
• Switch cases must be exhaustive

Usage

Add @astrelion/eslint-config-astrel to your dev dependencies. For example, with bun install -D @astrelion/eslint-config-astrel.

{
    "devDependencies": {
        "@astrelion/eslint-config-astrel": "^X.X.X",
    },
}

In your ESLint configuration file, import the package and add the config into your configuration. For example:

import pluginJs from "@eslint/js";
import tseslint from "typescript-eslint";
import { defineConfig } from "@eslint/config"
import astrel from "@astrelion/eslint-config-astrel"; // import here

export default defaultConfig(
    { files: ["**/*.{js,mjs,cjs,ts}"] },
    pluginJs.configs.recommended,
    tseslint.configs.recommended,
    astrel, // added to local config here
);

Done!

VSCode Autoformat

Add the following to your settings.json:

{
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": "always"
    }
}