Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/socialgouv/linters
The SocialGouv linters
https://github.com/socialgouv/linters
eslint linter linters react tslint
Last synced: 13 days ago
JSON representation
The SocialGouv linters
- Host: GitHub
- URL: https://github.com/socialgouv/linters
- Owner: SocialGouv
- License: apache-2.0
- Created: 2018-10-11T08:32:58.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T19:26:44.000Z (6 months ago)
- Last Synced: 2024-05-22T20:36:44.301Z (6 months ago)
- Topics: eslint, linter, linters, react, tslint
- Language: TypeScript
- Homepage:
- Size: 5.36 MB
- Stars: 1
- Watchers: 3
- Forks: 5
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Linters
🧹The Social Gouv linters✨
## Packages
| Project | Package | Version | Links |
| ----------------------------- | ---------------------------------------------------------- | ---------------------------------------------- | -------------------------------------------- |
| **eslint-config-react** | [`@socialgouv/eslint-config-react`][link-npm-react] | [![latest][img-npm-react]][link-npm-react] | [![README][img-readme]][link-readme-react] |
| **eslint-config-recommended** | [`@socialgouv/eslint-config-reco`][link-npm-reco] | [![latest][img-npm-reco]][link-npm-reco] | [![README][img-readme]][link-readme-reco] |
| **eslint-config-typescript** | [`@socialgouv/eslint-config-typescript`][link-npm-ts-reco] | [![latest][img-npm-ts-reco]][link-npm-ts-reco] | [![README][img-readme]][link-readme-ts-reco] |
## Usage
Each linter has its own REAME _(see links above)_.
As described in [`eslint-config-recommended` README](https://github.com/SocialGouv/linters/blob/master/packages/eslint-config-recommended/README.md#usage), you can install the config with :
```sh
$ npm install -D @socialgouv/eslint-config-recommended eslint prettier
# or
$ yarn add -D @socialgouv/eslint-config-recommended eslint prettier
```
You can either:
- add this to your `.eslintrc.yml` file:
```yaml
extends:
- "@socialgouv/eslint-config-recommended"
```
- or add this to your `.eslintrc.json` file:
```json
{
"extends": ["@socialgouv/eslint-config-recommended"]
}
```
- or add this to your `package.json` file:
```json
{
"eslintConfig": {
"extends": ["@socialgouv/eslint-config-recommended"]
}
}
```
And enjoy it!
## Release policy
### Auto
Trigger a custom build on [Travis](https://travis-ci.com/SocialGouv/linters) (in the "More options" right menu) on the `master` branch with a custom config:
```yml
env:
global:
- RELEASE=true
```
### Manual
You need an [Github token](https://github.com/settings/tokens/new) to release.
```sh
#
# Bump, push to git and publish to npm
$ yarn lerna publish
#
# Publish the tag change log on the Github Release
$ CONVENTIONAL_GITHUB_RELEASER_TOKEN==************ npx conventional-github-releaser -p angular
#
# You might want to add a Gif to your release to make it groovy ;)
```
---
[img-npm-react]: https://img.shields.io/npm/v/@socialgouv/eslint-config-react/latest.svg
[img-npm-reco]: https://img.shields.io/npm/v/@socialgouv/eslint-config-recommended/latest.svg
[img-npm-ts-reco]: https://img.shields.io/npm/v/@socialgouv/eslint-config-typescript/latest.svg
[img-readme]: https://img.shields.io/badge/README--green.svg
[link-npm-react]: https://npmjs.com/package/@socialgouv/eslint-config-react
[link-npm-reco]: https://npmjs.com/package/@socialgouv/eslint-config-recommended
[link-npm-ts-reco]: https://npmjs.com/package/@socialgouv/eslint-config-typescript
[link-readme-react]: https://github.com/SocialGouv/linters/blob/master/packages/eslint-config-react/README.md
[link-readme-reco]: https://github.com/SocialGouv/linters/blob/master/packages/eslint-config-recommended/README.md
[link-readme-ts-reco]: https://github.com/SocialGouv/linters/blob/master/packages/eslint-config-typescript/README.md