https://github.com/dolmios/eslint-config-dolmios

A simple ESLint setup using @typescript-eslint.
https://github.com/dolmios/eslint-config-dolmios

core-web-vitals eslint nextjs prettier react typescript

Last synced: 7 days ago
JSON representation

A simple ESLint setup using @typescript-eslint.

• Host: GitHub
• URL: https://github.com/dolmios/eslint-config-dolmios
• Owner: dolmios
• Created: 2022-04-14T06:29:01.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-13T21:44:33.000Z (about 1 month ago)
• Last Synced: 2024-11-07T02:45:16.327Z (9 days ago)
• Topics: core-web-vitals, eslint, nextjs, prettier, react, typescript
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/eslint-config-dolmios
• Size: 483 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# eslint-config-dolmios

> A simple ESLint setup using [@typescript-eslint](https://typescript-eslint.io), with Prettier and a couple TSConfig setups.

## Install

```sh

pnpm add eslint-config-dolmios

```

## Usage

Populate `.eslintrc` with the following, and code away.

```

"extends": ["dolmios"]

```

Alternatively, you can use `eslintConfig` in `package.json`.

```

"eslintConfig": {

  "extends": ["dolmios"]

}

```

### Usage with Prettier

Prettier is configured to work nicely with this config, though is an optional inclusion. If you'd like to include the config, you can add it to `package.json`.

```

"prettier": "eslint-config-dolmios/configs/prettier"

```

#### Extending Prettier

> The above method does **not** offer a way to _extend_ the configuration to overwrite some properties from the shared configuration. If you need to do that, import the file in a `.prettierrc.js` file and export the modifications.

> [https://prettier.io/docs/en/](https://prettier.io/docs/en/configuration.html#sharing-configurations)

```

module.exports = {

...require("eslint-config-dolmios/configs/prettier"),

parser: "babel",

};

```

### Usage with TSConfig

This config also exports two TSConfig setups, `base` and `lib` respectively. The _base_ config is generally suitable. To include either, extend your `tsconfig.json`.

```

"extends": "eslint-config-dolmios/configs/tsconfig"

```

## Configurations

You can view the ESLint configuration in the reference notes: [reference.txt](./reference.txt).

## Contributing

Feel free to get in touch with feedback, advice or suggestions. See [Conventional Commits](https://gist.github.com/dolmios/0e33c579a500d87fc6f44df6cde97259) for new contributors.

## Acknowledgments

- [eslint-plugin-typescript-sort-keys](https://github.com/infctr/eslint-plugin-typescript-sort-keys#readme)