# @atlassian/eslint-plugin-onready-checks

> ESLint rules for checking various DomContentLoaded event handler usage.

Latest version **2.1.0** (published 2024-03-12) · SEE LICENSE IN LICENSE.txt license · 0 weekly downloads

## Install

```sh
npm install @atlassian/eslint-plugin-onready-checks
pnpm add @atlassian/eslint-plugin-onready-checks
yarn add @atlassian/eslint-plugin-onready-checks
bun add @atlassian/eslint-plugin-onready-checks
```

## 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 | 2.1.0 |
| Published | 2024-03-12 |
| First published | 2024-03-12 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE.txt |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 13.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian Pty Ltd |
| Maintainers | kbielaski, dwalker, atlassian-aui, jvdl, mdejongh, mszczepanski, cdarroch, macku, dboyd, dmorrow, mstaas, cwhittington, doklovic, 1999-atlassian, amcculloch, wyasvoin, jmoynihan, xqiu, gleal-atlassian, mszpyra, bcytrowski, plai1, sraj, tilwin_atlassian, mrzymski, media-build-bot, akishore, timse, mkem114, tsebastian, sfp-release-bot |
| Keywords | eslint, eslintplugin |

## Links

- npm: https://www.npmjs.com/package/@atlassian/eslint-plugin-onready-checks
- Repository: https://stash.atlassian.com/scm/fe/eslint-plugin-onready-checks
- npm.io page: https://npm.io/package/@atlassian/eslint-plugin-onready-checks

## 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
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 2.1.0 (latest) — 2024-03-12
- 0.0.1-alpha (deprecated) — 2024-12-10

## README

# Document onReady checks ESLint plugin

Several rules to discover direct and indirect usages of the DOMContentLoaded event.

## Installation

You'll first need to install [ESLint](http://eslint.org):

```
$ npm i eslint --save-dev
```

Next, install `@atlassian/eslint-plugin-onready-checks`:

```
$ npm install @atlassian/eslint-plugin-onready-checks --save-dev
```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `@atlassian/eslint-plugin-onready-checks` globally.

## Usage

Add `onready-checks` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json
{
    "plugins": ["@atlassian/onready-checks"]
}
```

Then configure the rules you want to use under the rules section.

```json
{
    "rules": {
        "onready-checks/rule-name": 2
    }
}
```

## Supported Rules

-   `no-ajs-toinit` - Checks for use of the `AJS.toInit` function
-   `no-domcontentloaded-handlers` - Checks for direct use of the `DOMContentLoaded` event
-   `no-jquery-onready` - Checks for use of the `DOMContentLoaded` event via jQuery's onReady handling

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