eslint-config-byungi

0.14.3 verified Fri May 01 auth: no javascript maintenance

An ESLint shareable config by SKT T1 Byungi, providing a collection of JavaScript lint rules. The current stable version is 0.14.3. The package is intended for personal or team use and is not actively maintained; it serves as a snapshot of Byungi's preferred rules. It offers subsets for legacy (old), React, Hyperapp, TypeScript, and TypeScript+React environments. Notable dependencies include ESLint ^7, and it is scoped to that major version.

Common errors

error Failed to load config "byungi" to extend from. ↓

cause eslint-config-byungi package not installed or ESLint can't find it.

fix

Ensure eslint-config-byungi is installed: npm install --save-dev eslint eslint-config-byungi

error ESLint: Error: .eslintrc: { "extends": "byungi/react" } fails if peer dependency eslint-plugin-react is missing. ↓

cause The 'react' subset requires eslint-plugin-react, but it's not listed as a peer dependency.

fix

Install eslint-plugin-react manually: npm install --save-dev eslint-plugin-react

error ESLint: Error: .eslintrc: { "extends": "byungi/typescript" } fails if @typescript-eslint/parser is missing. ↓

cause The 'typescript' subset requires @typescript-eslint/parser and @typescript-eslint/eslint-plugin.

fix

Install required packages: npm install --save-dev @typescript-eslint/parser @typescript-eslint/eslint-plugin

Warnings

breaking ESLint peer dependency is ^7. ESLint 8+ may break. ↓

fix Use ESLint 7.x or check compatibility with newer versions. Consider migrating to a maintained config.

gotcha The package has not been updated since 2021. Rules may be outdated. ↓

fix Review and update rules manually if used in modern projects.

deprecated The package is mostly unmaintained; no releases in 3+ years. ↓

fix Switch to an actively maintained config like eslint-config-airbnb or eslint-config-standard.

Install

npm install eslint-config-byungi

yarn add eslint-config-byungi

pnpm add eslint-config-byungi

Imports

default config (extends)

wrong

require('eslint-config-byungi') in a JavaScript config file (ESLint's extends field handles strings)

correct

In .eslintrc: { "extends": "byungi" }

Use the string 'byungi' in the 'extends' array of your ESLint config file.

TypeScript config (extends)

wrong

{ "extends": "byungi/ts" } (wrong path)

correct

In .eslintrc: { "extends": "byungi/typescript" }

Use 'byungi/typescript' not 'byungi/ts'.

React config (extends)
wrong
```
N/A
```
correct
```
In .eslintrc: { "extends": "byungi/react" }
```
Use 'byungi/react' for React projects.
Old/legacy config (extends)
wrong
```
N/A
```
correct
```
In .eslintrc: { "extends": "byungi/old" }
```
The 'old' subset provides legacy rules.
Hyperapp config (extends)
wrong
```
N/A
```
correct
```
In .eslintrc: { "extends": "byungi/hyperapp" }
```
The 'hyperapp' subset is for Hyperapp framework projects.

TypeScript+React config (extends)

wrong

{ "extends": "byungi/typescript-react" } (hyphen vs no hyphen)

correct

In .eslintrc: { "extends": "byungi/typescriptreact" }

The correct string is 'byungi/typescriptreact' without a hyphen.

Quickstart

Quick setup: install peer dependency, add extends to ESLint config, and run linter.

// Install the package with ESLint
// npm install --save-dev eslint eslint-config-byungi

// Create .eslintrc.json (or add to package.json "eslintConfig")
{
  "extends": "byungi"
}

// Lint your files
// npx eslint .