Contents

• About
• Features
• Installation
• Documentation
  • Tree
  • Import
  • Methods
  • Recommended use
  • Types
• Links
  • Discord
  • Telegram
  • Twitter
  • GitHub
• License

About

Strict ESLint presets for modern TypeScript projects.

Features

• Enforces type safety
• Prohibits potentially unsafe patterns
• Encourages modern syntax
• Encourages the use of arrow functions
• Encourages the use of try/catch
• Bans var and warns about proper use of const and let
• Disallows interfaces, using only types
• Requires explicit readonly and accessibility modifiers in classes
• ...and much more!

Installation

You can install it as follows.

# NPM
npm add neatlint

# PNPM
pnpm add neatlint

# Yarn
yarn add neatlint

# Bun
bun add neatlint

# Deno
deno add neatlint

Documentation

Tree

Briefly as follows.

Neatlint
│
├── Neatlint(options?)
│
└── type NeatlintOptions

Import

Briefly as follows.

📁 ./eslint.config.ts

import { Neatlint } from 'neatlint';

export default Neatlint();

Methods

Neatlint(options?)

Get the ESLint configuration generated by Neatlint.

| Parameter | Type | Default | Description | | --------- | ----------------- | ------------------------ | ----------------- | | options? | NeatlintOptions | NeatlintOptionsDefault | Neatlint options. |

returns ESLintConfig[]

Example:

export default Neatlint();

Recommended use

Suggested uses are as follows. We recommend using Prettier.

📁 ./eslint.config.ts

import { Neatlint } from 'neatlint';

export default Neatlint();

📁 ./tsconfig.json

{
  "compilerOptions": {
    "strict": true,
    "esModuleInterop": true,

    "target": "ESNext",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "lib": ["DOM", "ESNext"],

    "typeRoots": ["./types", "./node_modules/@types"]
  }
}

📁 ./.prettierrc.json

{
  "semi": true,
  "singleQuote": true,

  "printWidth": 9999,
  "tabWidth": 2,

  "trailingComma": "none"
}

Types

| Type | | ----------------- | | ESLintConfig | | NeatlintOptions |

Links

• Discord
• Telegram
• Twitter
• GitHub

License

MIT License

Copyright (c) 2025 Keift

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.