VMS Sync ESLint Config

1.0.12 verified Sat Apr 25 auth: no javascript

eslint-config-vmss is an ESLint shareable config package by VMS Sync, current version 1.0.12. It extends eslint-config-airbnb-base and eslint-config-airbnb-typescript, with @typescript-eslint/eslint-plugin for TypeScript support. The config provides a base preset for JavaScript projects ("vmss") and a TypeScript variant ("vmss/typescript"). Dependencies are installed via npx install-peerdeps. Released as a shared config for internal consistency; not actively maintained? Updates are infrequent. Differentiator: Opinionated Airbnb-based rules tailored for VMS Sync projects.

Common errors

error Error: Cannot find module 'eslint-config-vmss' ↓

cause Package not installed or missing from node_modules.

fix

Run: npx install-peerdeps --dev eslint-config-vmss

error ESLint couldn't find the config "vmss" to extend from. ↓

cause Typo or incorrect extends value; should be 'vmss' not 'eslint-config-vmss'.

fix

Use "extends": [ "vmss" ]

error Failed to load plugin '@typescript-eslint' declared in 'vmss/typescript' ↓

cause Missing @typescript-eslint/eslint-plugin peer dependency.

fix

Run: npm install --save-dev @typescript-eslint/eslint-plugin@^5.41.0

Warnings

deprecated eslint-config-airbnb-typescript v17 may require specific @typescript-eslint/eslint-plugin v5.x versions; check compatibility. ↓

fix Ensure @typescript-eslint/eslint-plugin is version ^5.41.0 as specified in peer deps.

gotcha If using npm <7, peer dependencies are not auto-installed; you must install them manually. ↓

fix Use install-peerdeps or npm >=7

gotcha The config extends airbnb-base, which may conflict with other style guides you use. ↓

fix Override rules in your .eslintrc to resolve conflicts.

Install

npm install eslint-config-vmss

yarn add eslint-config-vmss

pnpm add eslint-config-vmss

Imports

extends
wrong
```
{
  "extends": "vmss"
}
```
correct
```
{
  "extends": [ "vmss" ]
}
```
In .eslintrc, use array form for 'extends' to allow multiple configs.
extends (TypeScript)
wrong
```
{
  "extends": [ "vmss" ]
}
```
correct
```
{
  "extends": [ "vmss/typescript" ]
}
```
TypeScript projects must use 'vmss/typescript' not 'vmss' to get TypeScript rules.
plugin import
wrong
```
npm install --save-dev eslint-config-vmss
```
correct
```
npx install-peerdeps --dev eslint-config-vmss
```
The package has peer dependencies; install-peerdeps installs them automatically. Manual npm install will miss peer deps.

Quickstart

Shows how to install and configure eslint-config-vmss for JS and TypeScript projects.

// Install dependencies
npx install-peerdeps --dev eslint-config-vmss

// Create .eslintrc with:
{
  "extends": [ "vmss" ]
}

// For TypeScript:
{
  "extends": [ "vmss/typescript" ]
}

// Or if using package.json:
"eslintConfig": {
  "extends": [ "vmss/typescript" ]
}