# @equitysim/code-style

> EquitySim's code style and coding standards

Latest version **0.0.15** (published 2020-08-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install @equitysim/code-style
pnpm add @equitysim/code-style
yarn add @equitysim/code-style
bun add @equitysim/code-style
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.15 |
| Published | 2020-08-13 |
| First published | 2017-09-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 19.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | equitysim-admin |
| Maintainers | akimalunar, bgk-, equitysim-admin, pjwiebe, tonydinh |
| Keywords | linter |

## Links

- npm: https://www.npmjs.com/package/@equitysim/code-style
- Repository: https://github.com/equitysim/code-style
- Homepage: https://github.com/equitysim/code-style#readme
- Issues: https://github.com/equitysim/code-style/issues
- npm.io page: https://npm.io/package/@equitysim/code-style

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.0.15 (latest) — 2020-08-13
- 0.0.14 — 2020-08-07
- 0.0.13 — 2020-05-14
- 0.0.12 — 2020-05-14
- 0.0.11 — 2019-11-19
- 0.0.10 — 2019-11-19
- 0.0.9 — 2018-04-18
- 0.0.8 — 2018-04-14
- 0.0.7 — 2018-04-13
- 0.0.6 — 2018-04-13
- 0.0.5 — 2018-04-10
- 0.0.4 — 2018-04-06
- 0.0.3 — 2018-01-25
- 0.0.2 — 2017-09-11
- 0.0.1 — 2017-09-05

## README

# EquitySim Code Style

A repo to document code standards for different languages and provide tools for
linting EquitySim projects.

## ES6/JSX

We use [ESLint](http://eslint.org/) to lint ES6 and React/JSX code. If ESLint is
installed in a project, we can use the configuration from this module by
creating a file in the project root named `.eslintrc.yml`. If the project does
not use JSX, the file contents should be

```yaml
extends:
  - './node_modules/code-style/es6/es6.yml'
```

and for a React/JSX project:

```yaml
extends:
  - './node_modules/code-style/es6/es6-react.yml'
```

or for a backend project:

```yaml
extends:
  - './node_modules/code-style/backend/backend.yml`
```

If using a custom Webpack configuration, add the lines:
```yaml
settings:
  import/resolver:
    webpack:
      config: '<path-to-webpack-config>'
```
to the `.eslintrc.yml`

Make sure to install the following NPM modules:
- `eslint` > 3.0
- `eslint-plugin-import`
- `eslint-import-resolver-webpack`
- `eslint-plugin-react` (for React/JSX linting only)

## ESLint and Atom

Find out how to integrate [ESLint and Atom Text](./javascript/atom.md).

---
_Source: https://npm.io/package/@equitysim/code-style · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._