eslint-config-cityssm

eslint-config-cityssm

ESLint rules used in the City of Sault Ste. Marie's TypeScript projects.

Now testing support for ESLint's CSS, JSON, and Markdown parsers!

Installation

npm install --save-dev eslint-config-cityssm

Simple Usage

For web applications, export the default export.

export { default } from 'eslint-config-cityssm'

For simpler packages, export the packageConfig.

export { default } from 'eslint-config-cityssm/packageConfig'

Advanced Usage (TypeScript)

import configWebApp {
  type ConfigObject,
  defineConfig
} from 'eslint-config-cityssm'
import { cspellWords } from 'eslint-config-cityssm/exports'

export const config: ConfigObject[] = defineConfig(configWebApp, {
  files: ['**/*.ts'],
  languageOptions: {
    parserOptions: {
      project: ['./tsconfig.json', './public/javascripts/tsconfig.json']
    }
  },
  rules: {
    '@cspell/spellchecker': [
      'warn',
      {
        cspell: {
          words: [...cspellWords, 'autoincrement', 'fontawesome']
        }
      }
    ],
    '@typescript-eslint/no-unsafe-type-assertion': 'off'
  }
})

export default config

Included Plugins

Thanks to all of the developers who help make the City of Sault Ste. Marie's code awesome! 😎

• typescript-eslint
• eslint-config-love
• @cspell/eslint-plugin
• @eslint-community/eslint-plugin-eslint-comments
• eslint-plugin-import
• eslint-plugin-jsdoc
• eslint-plugin-n
• eslint-plugin-no-secrets
• eslint-plugin-no-unsanitized
• eslint-plugin-package-json
• eslint-plugin-perfectionist
• eslint-plugin-promise
• eslint-plugin-regexp
• eslint-plugin-security
• eslint-plugin-sonarjs
• eslint-plugin-unicorn
• eslint-plugin-woke
• eslint-plugin-write-good-comments
• html-eslint

Projects Using eslint-config-cityssm

Used in 70+ projects, including:

• EMILE (Energy Monitoring in Less Effort)

• Attendance Tracking

• General Licence Manager

Related Projects

prettier-config-cityssm
Prettier configuration for the City of Sault Ste. Marie's projects.