ko-lint-config

library2.2.22jsnpmunverified

A shared lint configuration package from DTStack that bundles ESLint, Stylelint, and Prettier rules into a single dependency. Version 2.2.22 requires Node >=14 and ships TypeScript types. It enforces a specific code style (4-space indent, single quotes, no forced semicolons, optional trailing commas) designed for team consistency. Releases follow the ko monorepo's cadence. Differentiators: no configuration overhead, automatic formatting via pnpm lint-fix, and pre-defined rules that discourage overriding to maintain group style guide compliance.

testing

npm install ko-lint-config

github ↗package ↗

INSTALL

IMPORT

SIG · KO-LINT-CONFIG

ko-lint-config

testingjavascriptv2.2.22

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ko-lint-config (ESLint config)

✓ module.exports = { extends: [require.resolve('ko-lint-config')] }

✗ module.exports = { extends: ['ko-lint-config'] }

Use require.resolve to find the config file; string literal may resolve incorrectly in some environments.

Prettier config

✓ const prettier = require('ko-lint-config/.prettierrc'); module.exports = { ...prettier }

✗ module.exports = { extends: [require.resolve('ko-lint-config/.prettierrc')] }

The .prettierrc file is a plain JS object, not a config with extends; spread it into your config.

Stylelint config

✓ module.exports = { extends: [require.resolve('ko-lint-config/.stylelintrc')] }

✗ module.exports = { extends: ['ko-lint-config/.stylelintrc'] }

Same as ESLint: use require.resolve to ensure correct path resolution.

Install ko-lint-config, configure ESLint and Prettier via require.resolve, and add lint scripts.

pnpm add ko-lint-config -D // .eslintrc.js module.exports = { extends: [require.resolve('ko-lint-config')], } // .prettierrc.js const prettier = require('ko-lint-config/.prettierrc') module.exports = { ...prettier } // package.json "scripts" { "lint": "npx eslint './src/**/*.ts' './src/**/*.tsx'", "lint-fix": "npx eslint './src/**/*.ts' './src/**/*.tsx' --fix", "lint-css": "npx stylelint './src/**/*.scss' './src/**/*.css'", "lint-css-fix": "npx stylelint './src/**/*.scss' './src/**/*.css' --fix" } // Then run pnpm lint-fix

Debug

Known issues

gotchaDo not use string literal 'ko-lint-config' in extends; use require.resolve() to avoid module resolution failures.

fix

Use require.resolve('ko-lint-config') in extends array.

affects: all

deprecatedThe package expects ESLint <9 (flat config not supported). If you use ESLint 9+, this config will not work.

fix

Stick with ESLint 8 or migrate to a flat config manually.

affects: >=2.0.0

breakingMajor version bumps may change lint rules significantly without warning. Always review changelog before upgrading.

fix

Pin version and test lint output after upgrade.

affects: >=1.0.0

gotchaPrettier config is spread, not extended. Using extends will cause errors.

fix

Use const prettier = require('ko-lint-config/.prettierrc'); module.exports = { ...prettier }

affects: all

Errors

Common errors & fixes

Error: Cannot find module 'ko-lint-config'

ko-lint-config not installed or require.resolve used without installing.

fix

Run `npm install ko-lint-config --save-dev` and ensure node_modules contains it.

ESLint: Configuration for rule "indent" is invalid

Overriding rules from ko-lint-config can cause incompatibility.

fix

Remove custom rule overrides and rely solely on ko-lint-config's defaults.

Error: No configuration provided for stylelint

Stylelint config not loaded; missing require.resolve for .stylelintrc.

fix

Add `extends: [require.resolve('ko-lint-config/.stylelintrc')]` to your .stylelintrc.js

Error: Could not resolve 'ko-lint-config/.prettierrc'

Using require.resolve on .prettierrc file when it's not a valid module export.

fix

Use `const prettier = require('ko-lint-config/.prettierrc')` without require.resolve.

Upgrade

Version history

2.2.22latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/DTStack/ko ↗

packagehttps://www.npmjs.com/package/ko-lint-config ↗