Registry / testing / eslint-config-collaborne

eslint-config-collaborne

library5.5.6jsnpmunverified

ESLint shareable config used by Collaborne for their TypeScript and JavaScript projects. Current version 5.5.6 supports ESLint 8+ and requires multiple peer plugins. Release cadence is irregular, aligned with Collaborne's internal needs. Differentiates by bundling a specific set of opinionated rules (Prettier, import, promise, node, disable) and supporting multiple major versions of ESLint plugins via range peer dependencies. Active maintenance by Collaborne team.

testing

npm install eslint-config-collaborne

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-CONFIG-COLL

eslint-config-collaborne

testingjavascriptv5.5.6

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.

config

✓ // In .eslintrc.json: { "extends": "collaborne" }

✗ import config from 'eslint-config-collaborne'; // Not meant to be imported as JS module

This is a shareable config; use it via the extends field in ESLint config files, not via import.

typescript

✓ // In .eslintrc.json: { "extends": "collaborne", "rules": { ... } }

✗ require('eslint-config-collaborne'); // not a Node require; use extends

No JavaScript module is exported; the package simply provides an ESLint config.

Node.js require

✓ /* No require() needed; use extends in config file */

✗ const config = require('eslint-config-collaborne'); // does not work

The package does not export anything programmatically; it is purely a shareable config.

Shows full setup: install peer deps, configure Prettier and ESLint, add lint script, and run the linter.

// 1. Install dependencies npm install --save-dev \ eslint-config-collaborne \ eslint@8 \ @typescript-eslint/eslint-plugin@^7.0.0 \ @typescript-eslint/parser@^7.0.0 \ eslint-plugin-disable@^2.0.3 \ eslint-plugin-import@^2.26.0 \ eslint-plugin-node@^11.1.0 \ eslint-plugin-prettier@^5.0.0 \ eslint-plugin-promise@^7.0.0 \ prettier@^3.0.0 // 2. Create .prettierrc { "singleQuote": true, "semi": true, "tabWidth": 2, "useTabs": true, "trailingComma": "all" } // 3. Create .eslintrc.json { "extends": "collaborne" } // 4. Add scripts to package.json "scripts": { "lint": "eslint src/" } // 5. Run lint npm run lint

Debug

Known issues

breakingVersion 3.0.0 dropped support for ESLint 6 and earlier, requiring ESLint >= 8.

fix

Upgrade ESLint to version 8 or later if you are on ESLint 6/7.

affects: >=3.0.0 <4.0.0

breakingPeer dependencies changed between major versions: ensure @typescript-eslint/*, eslint-plugin-prettier, eslint-plugin-promise versions match the ranges in package.json.

fix

Use the specific peer dependency ranges listed in the latest package.json.

affects: >=5.0.0

deprecatedThe package may ship with deprecated ESLint rules or configurations as ESLint and plugins evolve; review config after upgrading ESLint.

fix

After upgrading ESLint or plugins, run `eslint --rulesdir` to check for deprecated rules and update config accordingly.

affects: *

gotchaThe config expects .prettierrc to be present; missing it can cause unexpected formatting errors.

fix

Create a .prettierrc file as shown in the quickstart.

affects: *

gotchaeslint-plugin-disable is a peer dependency; it is not officially published on npm? Actually it exists, but may be uncommon. Ensure it is installed.

fix

Install eslint-plugin-disable explicitly: `npm install --save-dev eslint-plugin-disable@2.0.3`

affects: *

gotchaThe config uses `extends: 'collaborne'` which assumes the package is named 'eslint-config-collaborne'; if you rename it, the extends value changes.

fix

Do not rename the package; always use `extends: 'collaborne'`.

affects: *

gotchaThe config presumes a TypeScript project with tsconfig.json; if not using TypeScript, you must override certain rules.

fix

Use overrides in .eslintrc.json to disable TypeScript-specific rules for .js files.

affects: *

Errors

Common errors & fixes

ESLint couldn't find the config "collaborne"

eslint-config-collaborne package not installed or not in node_modules.

fix

Run `npm install --save-dev eslint-config-collaborne` and ensure it is in package.json.

Failed to load plugin '@typescript-eslint': Cannot find module 'eslint-plugin-disable'

Missing peer dependency eslint-plugin-disable.

fix

Install it: `npm install --save-dev eslint-plugin-disable@^2.0.3`

Error: Cannot find module 'eslint-plugin-prettier' or 'prettier'

eslint-plugin-prettier or prettier not installed.

fix

Install both: `npm install --save-dev eslint-plugin-prettier@^5.0.0 prettier@^3.0.0`

Configuration for rule "import/no-unresolved" is invalid

The config assumes certain parser options or settings that may conflict with your project.

fix

Override the rule in your .eslintrc.json if needed, e.g., `"import/no-unresolved": "off"`.

Upgrade

Version history

5.5.6latest on npm

Audit

Dependencies

@typescript-eslint/eslint-pluginrequiredPeer dependency; provides TypeScript-specific lint rules.

@typescript-eslint/parserrequiredPeer dependency; parses TypeScript code for ESLint.

eslintrequiredPeer dependency; core linting framework.

eslint-plugin-disablerequiredPeer dependency; used to disable rules inline.

eslint-plugin-importrequiredPeer dependency; enforces import/export rules.

eslint-plugin-noderequiredPeer dependency; adds Node.js specific rules.

eslint-plugin-prettierrequiredPeer dependency; runs Prettier as ESLint rule.

eslint-plugin-promiserequiredPeer dependency; enforces Promise best practices.

prettierrequiredPeer dependency; code formatter used by eslint-plugin-prettier.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/Collaborne/eslint-config-collaborne ↗

packagehttps://www.npmjs.com/package/eslint-config-collaborne ↗