# fs-default-project-config

> Repo containing commons fox sports project linting configs and editor settings

Latest version **9.0.0** (published 2018-07-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install fs-default-project-config
pnpm add fs-default-project-config
yarn add fs-default-project-config
bun add fs-default-project-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 9.0.0 |
| Published | 2018-07-05 |
| First published | 2017-04-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 61.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | FOXSPORTS Australia |
| Maintainers | darren.nolan, seankoji, slmt |

## Links

- npm: https://www.npmjs.com/package/fs-default-project-config
- Repository: https://github.com/FoxSportsAustralia/fs-default-project-config
- Homepage: https://github.com/FoxSportsAustralia/fs-default-project-config#readme
- Issues: https://github.com/FoxSportsAustralia/fs-default-project-config/issues
- npm.io page: https://npm.io/package/fs-default-project-config

## Dependencies (7)

- [eslint](https://npm.io/package/eslint.md) ^4.9.0
- [sass-lint](https://npm.io/package/sass-lint.md) ^1.10.2
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.4.0
- [eslint-plugin-compat](https://npm.io/package/eslint-plugin-compat.md) ^2.0.1
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.8.0
- [eslint-plugin-jsx-a11y](https://npm.io/package/eslint-plugin-jsx-a11y.md) ^6.0.2
- [eslint-plugin-filenames](https://npm.io/package/eslint-plugin-filenames.md) ^1.1.0

## Recent versions

- 9.0.0 (latest) — 2018-07-05
- 7.0.0 — 2018-02-02
- 6.1.3 — 2017-11-06
- 6.1.2 — 2017-10-30
- 6.1.1 — 2017-10-30
- 5.0.0 — 2017-10-04
- 4.0.1 — 2017-09-11
- 4.0.0 — 2017-09-11
- 3.1.2 — 2017-08-03
- 3.1.1 — 2017-08-03
- 3.1.0 — 2017-08-03
- 3.0.0 — 2017-08-02
- 2.0.0 — 2017-04-07

## README

# fs-default-project-config
Repo containing commons fox sports project configs

## Usage

### eslint

#### Installing
1. Install as a dev dependency in your repo.
2. Set up your `.eslintrc.js` file to extend `./node_modules/fs-default-project-config/resources/.eslintrc.js`

    For all rules (standards & react specific):

    ```
    module.exports = {
        "extends": [
            "./node_modules/fs-default-project-config/resources/.eslintrc.js"
        ]
    };
    ```

    Excluding react specific rules:

    ```
    module.exports = {
        "extends": [
            "./node_modules/fs-default-project-config/resources/.eslintrc-files.js"
            "./node_modules/fs-default-project-config/resources/.eslintrc-standards.js"
        ]
    };
    ```

If using eslint/compat, ensure that you copy `.browserslistrc` to your project root, or set up a [browserslist config](https://github.com/ai/browserslist#config-file)

```
    "browserslist": [
        "last 2 versions",
        "Safari >= 8",
        "Explorer >= 11"
    ],
```

#### Updating Rules
As eslint is constantly having rules added or tweaked, pay attention to the relevant eslint or plugin version defined in `package.json`
to determine which ruleset is being applied.

If you want to update the rules, look at eslint's / the plugin's changelog since the last release and ensure all new rules have a definition, deprecated rules are removed etc.

Remember any rules capable of breaking a CI build should be SEMVER versioned a breaking change. That means adding a new rule or even making a current rule stricter.

### sass-lint
1. Install as a dev dependency in your repo.
2. Set up your `.sass-lint.yml` file to extend `./node_modules/fs-default-project-config/resources/.sass-lint.yml`

    ```
    options:
        config-file: ./node_modules/fs-default-project-config/resources/.sass-lint.yml
    ```

### All Others
1. Copy desired contents from `./node_modules/fs-default-project-config/resources/`

## Dependencies
In addition to `eslint` itself, the following eslint plugin npm packages are required for these rules (if you exclude some rules you won't need all of these)

* `eslint-plugin-jsx-a11y`
* `eslint-plugin-react`
* `eslint-plugin-filenames`

---
_Source: https://npm.io/package/fs-default-project-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._