Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cityssm/eslint-config-cityssm

ESLint rules used in the City of Sault Ste. Marie's TypeScript projects.
https://github.com/cityssm/eslint-config-cityssm

cspell eslint eslint-config eslint-plugin eslint-plugin-eslint-comments eslint-plugin-import eslint-plugin-jsdoc eslint-plugin-n eslint-plugin-no-secrets eslint-plugin-no-unsanitized eslint-plugin-promise eslint-plugin-regexp eslint-plugin-security eslint-plugin-sonarjs eslint-plugin-unicorn eslint-plugin-woke eslint-plugin-write-good-comments typescript-eslint

Last synced: 19 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/cityssm/eslint-config-cityssm
Owner: cityssm
License: unlicense
Created: 2023-07-13T18:03:11.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-10-29T17:53:28.000Z (about 2 months ago)
Last Synced: 2024-10-29T21:11:19.280Z (about 2 months ago)
Topics: cspell, eslint, eslint-config, eslint-plugin, eslint-plugin-eslint-comments, eslint-plugin-import, eslint-plugin-jsdoc, eslint-plugin-n, eslint-plugin-no-secrets, eslint-plugin-no-unsanitized, eslint-plugin-promise, eslint-plugin-regexp, eslint-plugin-security, eslint-plugin-sonarjs, eslint-plugin-unicorn, eslint-plugin-woke, eslint-plugin-write-good-comments, typescript-eslint
Language: TypeScript
Homepage: https://www.npmjs.com/package/eslint-config-cityssm
Size: 708 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # eslint-config-cityssm

[![DeepSource](https://app.deepsource.com/gh/cityssm/eslint-config-cityssm.svg/?label=active+issues&show_trend=true&token=2x51pzQmdmBmD3LNk4XgOTZC)](https://app.deepsource.com/gh/cityssm/eslint-config-cityssm/)

[![Maintainability](https://api.codeclimate.com/v1/badges/789e61c09874b68eb06a/maintainability)](https://codeclimate.com/github/cityssm/eslint-config-cityssm/maintainability)

![Code Scanning Banner](banner.png)

[ESLint](https://eslint.org/) rules used in the

[City of Sault Ste. Marie's TypeScript projects](https://github.com/search?q=org%3Acityssm++language%3ATypeScript&type=repositories).

## Installation

```sh

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

```

## Simple Usage

In the project's `eslint.config.js` file,

it's as easy as one line.

```javascript

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

```

For web applications, export `configWebApp` instead.

```javascript

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

```

## Advanced Usage

In the project's `eslint.config.js` file.

```javascript

import eslintConfigCityssm from 'eslint-config-cityssm'

export default [...eslintConfigCityssm]

```

## Included Plugins

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

- [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint)

- [eslint-config-love](https://www.npmjs.com/package/eslint-config-love)

- [@cspell/eslint-plugin](https://www.npmjs.com/package/@cspell/eslint-plugin)

- [@eslint-community/eslint-plugin-eslint-comments](https://www.npmjs.com/package/@eslint-community/eslint-plugin-eslint-comments)

- [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import)

- [eslint-plugin-jsdoc](https://www.npmjs.com/package/eslint-plugin-jsdoc)

- [eslint-plugin-n](https://www.npmjs.com/package/eslint-plugin-n)

- [eslint-plugin-no-secrets](https://www.npmjs.com/package/eslint-plugin-no-secrets)

- [eslint-plugin-no-unsanitized](https://www.npmjs.com/package/eslint-plugin-no-unsanitized)

- [eslint-plugin-promise](https://www.npmjs.com/package/eslint-plugin-promise)

- [eslint-plugin-regexp](https://www.npmjs.com/package/eslint-plugin-regexp)

- [eslint-plugin-security](https://www.npmjs.com/package/eslint-plugin-security)

- [eslint-plugin-sonarjs](https://www.npmjs.com/package/eslint-plugin-sonarjs)

- [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn)

- [eslint-plugin-woke](https://www.npmjs.com/package/eslint-plugin-woke)

- [eslint-plugin-write-good-comments](https://www.npmjs.com/package/eslint-plugin-write-good-comments)

## Projects Using eslint-config-cityssm

[**Used in 50+ projects**](https://github.com/search?q=eslint-config-cityssm+path%3A**%2Fpackage.json&type=code), including:

- [EMILE (Energy Monitoring in Less Effort)](https://github.com/cityssm/EMILE)

- [Attendance Tracking](https://github.com/cityssm/attendance-tracking)

- [General Licence Manager](https://github.com/cityssm/general-licence-manager)

## Related Projects

**[prettier-config-cityssm](https://github.com/cityssm/prettier-config-cityssm)**


Prettier configuration for the City of Sault Ste. Marie's projects.