# @obamafoundation/eslint-plugin-of-svelte

> ObamaFoundation ESLint Plugin

Latest version **1.0.18** (published 2023-08-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install @obamafoundation/eslint-plugin-of-svelte
pnpm add @obamafoundation/eslint-plugin-of-svelte
yarn add @obamafoundation/eslint-plugin-of-svelte
bun add @obamafoundation/eslint-plugin-of-svelte
```

## 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 | 1.0.18 |
| Published | 2023-08-31 |
| First published | 2023-08-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^14.17.0 \|\| ^16.0.0 \|\| >= 18.0.0 |
| Dependencies | 1 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jenniferworrall, ptserviceaccount |

## Links

- npm: https://www.npmjs.com/package/@obamafoundation/eslint-plugin-of-svelte
- Repository: https://github.com/ObamaFoundation/eslint-plugin-of
- Homepage: https://github.com/ObamaFoundation/eslint-plugin-of#readme
- Issues: https://github.com/ObamaFoundation/eslint-plugin-of/issues
- npm.io page: https://npm.io/package/@obamafoundation/eslint-plugin-of-svelte

## Dependencies (1)

- [requireindex](https://npm.io/package/requireindex.md) ^1.2.0

## Recent versions

- 1.0.18 (latest) — 2023-08-31
- 1.0.17 — 2023-08-31
- 1.0.16 — 2023-08-31
- 1.0.15 — 2023-08-31
- 1.0.14 — 2023-08-30
- 1.0.13 — 2023-08-30
- 1.0.12 — 2023-08-30
- 1.0.11 — 2023-08-30
- 1.0.10 — 2023-08-30
- 1.0.9 — 2023-08-30
- 1.0.0 — 2023-08-30

## README

# eslint-plugin-of-svelte

ObamaFoundation ESLint Plugin

## Installation

Make sure you've already installed [ESLint](https://eslint.org/) in the project where you intend to use this linter.

```sh
npm i eslint --save-dev
```

Next, install `@obamafoundation/eslint-plugin-of-svelte`:

```sh
npm install @obamafoundation/eslint-plugin-of-svelte --save-dev
```

## Usage

Add `@obamafoundation/eslint-plugin-of-svelte` to the plugins section of your `.eslintrc` configuration file:

```json
{
    "plugins": [
        "@obamafoundation/of-svelte",
    ]
}
```

Then configure the rules you want to use under the rules section.  You must use the "@obamafoundation/of-svelte" prefix for your rule.

```json
{
    "rules": {
        "@obamafoundation/of-svelte/no-placeholder-values": "error",
    }
}
```

## Rules

The writing of rules relies heavily on the [AST specification outlined by ESLint](https://eslint.org/docs/latest/extend/custom-parsers#the-ast-specification).  For details on the Svelte AST implementation, you can [visit the svelte AST guide](https://github.com/ota-meshi/svelte-eslint-parser/blob/main/docs/AST.md) for [svelte-eslint-parser](https://github.com/ota-meshi/svelte-eslint-parser). 
<!-- begin auto-generated rules list -->

| Name                                                         | Description                                |
| :----------------------------------------------------------- | :----------------------------------------- |
| [no-placeholder-values](docs/rules/no-placeholder-values.md) | Do not apply placeholder values to inputs. |

<!-- end auto-generated rules list -->


## Releasing to npm

Prior to merging with the main branch, first increment version in the PR branch:

```sh
npm version <version number>
```

Then push to create new Github tag:

```sh
git push --follow-tags
```

The workflow to push to npm will only run when merged to the main branch

---
_Source: https://npm.io/package/@obamafoundation/eslint-plugin-of-svelte · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
