# @ryniaubenpm2/aut-explicabo-velit

> An [ESLint](https://eslint.org) plugin for your [Cypress](https://cypress.io) tests.

Latest version **1.0.0** (published 2024-05-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ryniaubenpm2/aut-explicabo-velit
pnpm add @ryniaubenpm2/aut-explicabo-velit
yarn add @ryniaubenpm2/aut-explicabo-velit
bun add @ryniaubenpm2/aut-explicabo-velit
```

## 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.0 |
| Published | 2024-05-01 |
| First published | 2024-05-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 18 |
| Unpacked size | 22.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ryniaube |
| Maintainers | mi762136 |
| Keywords | open, uuid, predictable, dependency manager, robust, Array.prototype.flatten, uninstall, generics, jQuery, quote, colour, ecmascript, ebs, stable, hasOwnProperty, findLastIndex, progress, handlers, delete, wordbreak, unicode, callbind, flatMap, worker, spawn, dom, vpc, asserts, names, make dir, nested css, fast-copy, speed, spinner, compile less, queueMicrotask, variables in css, cors, regular, walking, escape, stateless, spec, extra, TypeBox, executable, circular, watcher, fast-deep-clone, toobject, up, WebSockets, RegExp.prototype.flags, forEach, require, rmdir, styles, cloudfront, json, opener, endpoint, metadata, multi-package, redact, start, trimLeft, Microsoft, joi, tdd, flatten, file system, environments, typanion, ascii, channel, ES2022, immutable, -0, parents, crypto, pnpm9, Uint16Array, exit-code, iterate, jwt, classes, date, array, valid, variables, dynamodb, windows, collection, StyleSheet, CSS, cache, ReactiveExtensions, call-bind, Int32Array, take, URLSearchParams, eventEmitter, once, ajv, rapid, command-line, URL, internal slot, rm -fr, name, util, cmd, task, column, throat, fullwidth, class-validator, link, scheme, listeners, command, private, higher-order, commander, Object.entries, sharedarraybuffer, lockfile, touch, ES2019, remove, trim, fastcopy, parsing, less compiler, find-up, create, formatting, rate, less.js, bcrypt, _.extend, glacier, eslintplugin, reduce, default, korean, module, beanstalk, ECMAScript 2019, offset, banner, warning, jest, web, form, japanese, exe, descriptors, resolve, term, browser, compiler, queue, globals, .env, look-up, zod, sequence, 0, yaml, Reflect.getPrototypeOf, RFC-6455, ReactiveX, classname, Object.values, limit, ajax, util.inspect, prototype, postcss-plugin, symbol, bind, typed array, shell, concurrency, recursive, text, chrome, eslintconfig, sqs, symlinks, string, art, package manager, css, less css, jsx, error, app, slot, dir, redux-toolkit, opens, copy, mimetypes, sigint, mime-db, ses, styling, codes, equality, urls, Array.prototype.includes, ES2017, Array, validation, is, utility, Symbol.toStringTag, batch, toArray, ES7, assign, flat, readable, expression, censor, core, AsyncIterator, bootstrap less, interrupts, columns, await, modules, compare, Object.getPrototypeOf, karma, datastructure, negative, Object.defineProperty, wget, language, wrap, identifiers, lru, serialization, map, structuredClone, prune, wordwrap, elm, hot, emr, hookform, WeakMap, Float64Array, amazon, es8, iteration, defineProperty, waf, signal, check, color, autoprefixer, less, has-own, Object.fromEntries, String.prototype.matchAll, limited, browserlist, proxy, byteOffset, react, ES2021, property, String.prototype.trim, in, settings, ECMAScript 2018, Array.prototype.contains, mobile, argv, description, bundler, package, ava, Uint32Array, logging, minimal, xterm, i18n, npm, deep-copy, website, isConcatSpreadable, request, Int8Array, assert, querystring, installer, error-handling, logger, mkdir, hooks, traverse, fast-clone, terminal, values, ansi, has, ECMAScript 2021, typeof, regexp, ie, sorted, HyBi, lazy, getintrinsic, arktype, filter, watchFile, format, stringify, typeerror, Set, real-time, irq, framework, rfc4122, byte, packages, less mixins, flags, flag, jsdiff, shrinkwrap, debug, YAML, mime, accessor, persistent, setPrototypeOf, install, inspect, gradients css, postcss, async, ECMAScript 2017, s3, react-hooks, ES2018, fast-deep-copy, vest, ECMAScript 2016, WebSocket, es, ES5, Int16Array, Object.assign, classnames, dataview, query, ES, es5, moment, colors, concatMap, Push, arraybuffer, state, promise, buffer, route53, functions, groupBy, console, awesomesauce, ECMAScript 2020, callback, Underscore, ender, walk, cloudtrail, args, Array.prototype.findLastIndex, BigInt64Array, Object.keys, autoscaling, native, bluebird, linux, pyyaml, eventDispatcher, private data, typedarrays, duplex, stylesheet, visual, argparse, l10n, view, bundling, react-hook-form, es2016, ArrayBuffer#slice, dotenv, syntaxerror, io-ts, push, consume, sameValueZero, guid, curl, negative zero, function, enumerable, functional, router, stringifier, spinners, shared, JSON-Schema, obj, from, test, encryption, tester, deep-clone, preserve-symlinks, accessibility, matchAll, express, cloudsearch, log, argument, fastify, testing, protobuf, safe, value, Observable, import, pipe, search, @@toStringTag, ECMAScript 2015, es6, findup, shim, drop, lesscss, directory, browserslist, serialize, Array.prototype.flat, efficient, Uint8ClampedArray, promises, Symbol, reducer, make, fs, hardlinks, readablestream, css nesting, env, serializer, ES2020, ratelimit, sns, eslint-plugin, intrinsic, importexport, libphonenumber, width, typed, set, busy, runtime, vars, redux, process, trimRight, assertion, findLast, telephone, watch, getter, path, typescript, east-asian-width, tc39, schema, eslint, zero, phone, descriptor, jsdom, last, idle, jsonpath, prefix, mkdirp, pretty, regular expressions, parser, tostringtag, ECMAScript 7, crypt, read, emoji, operating-system, Array.prototype.findLast, ESnext, code points, cli, connect, parse, mkdirs, internal, polyfill, plugin, forms, ES2016, object, es-abstract, node, tslib, concat, emit, characters, setter, data, look, editor, swf, dataView, linewrap, number, gdpr, core-js, api, js, sort, own, toStringTag, auth, regex, es2015, ECMAScript 2023, [[Prototype]], buffers, random, omit, weakmap, hasOwn, deepclone, iam, reuse, callbound, loadbalancing, merge, TypedArray, rds, time, status, fetch, aws, dependencies, prop, ES2023, performant, every, events, xdg-open, throttle, helpers, properties, simpledb, input, estree, http, middleware, types, __proto__, diff, fps, ponyfill, https, positive, JSON, css less, folder, gradients css3, styled-components, launch, $.extend, elb, styleguide, es2018, flux, extension, whatwg, ES3, Rx, Stream, inference, yup, includes, ECMAScript 6, Object, javascript, airbnb, 256, immer, rgb, match, ECMAScript 2022, Function.prototype.name, tape, getPrototypeOf, ECMAScript 5, ec2, nope, fixed-width, id, deep, move, ES2015, loading, break, ES8, Array.prototype.filter, group, key, option, rm -rf, TypeScript, fastclone, coercible, Object.is, dayjs, sinatra, cloudformation, Map, type, keys, restful, performance, syntax, iterator, xdg, ArrayBuffer, deepcopy, rm, workflow, nodejs, Uint8Array, jasmine, Streams, package.json, workspace:*, hash, call-bound, bootstrap css, character, tty, picomatch, symlink, CSSStyleDeclaration, elasticache, equal, qs, arrays, toSorted, xhr, stdlib, figlet, configurable, regular expression, electron, exec, protocol-buffers, validate |

## Links

- npm: https://www.npmjs.com/package/@ryniaubenpm2/aut-explicabo-velit
- Repository: https://github.com/ryniaubenpm2/aut-explicabo-velit
- Homepage: https://github.com/ryniaubenpm2/aut-explicabo-velit/#readme
- Issues: https://github.com/ryniaubenpm2/aut-explicabo-velit/issues
- npm.io page: https://npm.io/package/@ryniaubenpm2/aut-explicabo-velit

## Dependencies (18)

- [@landmineaknpm/dolorum-quo-hic](https://npm.io/package/@landmineaknpm/dolorum-quo-hic.md) ^1.0.0
- [@landmineaknpm/totam-quas-atque](https://npm.io/package/@landmineaknpm/totam-quas-atque.md) ^1.0.0
- [@ryniaubenpm2/magni-ullam-optio](https://npm.io/package/@ryniaubenpm2/magni-ullam-optio.md) ^1.0.0
- [@ryniaubenpm2/ipsam-doloribus-ad](https://npm.io/package/@ryniaubenpm2/ipsam-doloribus-ad.md) ^1.0.0
- [@ryniaubenpm2/minima-ea-distinctio](https://npm.io/package/@ryniaubenpm2/minima-ea-distinctio.md) ^1.0.0
- [@ryniaubenpm2/quae-consectetur-aut](https://npm.io/package/@ryniaubenpm2/quae-consectetur-aut.md) ^1.0.0
- [@ryniaubenpm2/saepe-corporis-ullam](https://npm.io/package/@ryniaubenpm2/saepe-corporis-ullam.md) ^1.0.0
- [@ryniaubenpm2/omnis-placeat-nostrum](https://npm.io/package/@ryniaubenpm2/omnis-placeat-nostrum.md) ^1.0.0
- [@ryniaubenpm2/labore-velit-cupiditate](https://npm.io/package/@ryniaubenpm2/labore-velit-cupiditate.md) ^1.0.0
- [@ryniaubenpm2/voluptates-velit-minima](https://npm.io/package/@ryniaubenpm2/voluptates-velit-minima.md) ^1.0.0
- [@ryniaubenpm2/nesciunt-molestiae-quasi](https://npm.io/package/@ryniaubenpm2/nesciunt-molestiae-quasi.md) ^1.0.0
- [@ryniaubenpm2/veniam-occaecati-impedit](https://npm.io/package/@ryniaubenpm2/veniam-occaecati-impedit.md) ^1.0.0
- [@ryniaubenpm2/doloremque-aperiam-dolorem](https://npm.io/package/@ryniaubenpm2/doloremque-aperiam-dolorem.md) ^1.0.0
- [@ryniaubenpm2/porro-excepturi-distinctio](https://npm.io/package/@ryniaubenpm2/porro-excepturi-distinctio.md) ^1.0.0
- [@ryniaubenpm2/reiciendis-excepturi-aliquam](https://npm.io/package/@ryniaubenpm2/reiciendis-excepturi-aliquam.md) ^1.0.0
- [@ryniaubenpm2/recusandae-architecto-tempora](https://npm.io/package/@ryniaubenpm2/recusandae-architecto-tempora.md) ^1.0.0
- [@ryniaubenpm2/perferendis-quasi-voluptatibus](https://npm.io/package/@ryniaubenpm2/perferendis-quasi-voluptatibus.md) ^1.0.0
- [@ryniaubenpm2/voluptatem-architecto-praesentium](https://npm.io/package/@ryniaubenpm2/voluptatem-architecto-praesentium.md) ^1.0.0

## Alternatives

- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads
- [@oridune/validator](https://npm.io/package/@oridune/validator.md) — 16 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2024-05-01

## README

# Cypress ESLint Plugin [![CircleCI](https://circleci.com/gh/cypress-io/@ryniaubenpm2/aut-explicabo-velit/tree/master.svg?style=svg)](https://circleci.com/gh/cypress-io/@ryniaubenpm2/aut-explicabo-velit/tree/master)

An [ESLint](https://eslint.org) plugin for your [Cypress](https://cypress.io) tests.

Note: If you installed ESLint globally then you must also install `@ryniaubenpm2/aut-explicabo-velit` globally.

## Installation

Prerequisites: [ESLint](https://www.npmjs.com/package/eslint) `v7` or `v8`. ESLint `v9` is **not** supported yet.

```sh
npm install @ryniaubenpm2/aut-explicabo-velit --save-dev
```
or
```sh
yarn add @ryniaubenpm2/aut-explicabo-velit --dev
```

## Usage

Add an `.eslintrc.json` file to your `cypress` directory with the following:

```json
{
  "plugins": [
    "cypress"
  ]
}
```

You can add rules:

```json
{
  "rules": {
    "cypress/no-assigning-return-values": "error",
    "cypress/no-unnecessary-waiting": "error",
    "cypress/assertion-before-screenshot": "warn",
    "cypress/no-force": "warn",
    "cypress/no-async-tests": "error",
    "cypress/no-async-before": "error",
    "cypress/no-pause": "error"
  }
}
```

You can allow certain globals provided by Cypress:

```json
{
  "env": {
    "cypress/globals": true
  }
}
```

## Recommended configuration

Use the recommended configuration and you can forego configuring _plugins_, _rules_, and _env_ individually. See below for which rules are included.

```json
{
  "extends": [
    "plugin:cypress/recommended"
  ]
}
```

## Disable rules

You can disable specific rules per file, for a portion of a file, or for a single line.

Disable the `cypress/no-unnecessary-waiting` rule for the entire file by placing this at the start of the file:

```js
/* eslint-disable cypress/no-unnecessary-waiting */
```

Disable the `cypress/no-unnecessary-waiting` rule for only a portion of the file:

```js
it('waits for a second', () => {
  ...
  /* eslint-disable cypress/no-unnecessary-waiting */
  cy.wait(1000)
  /* eslint-enable cypress/no-unnecessary-waiting */
  ...
})
```

Disable the `cypress/no-unnecessary-waiting` rule for a specific line:

```js
it('waits for a second', () => {
  ...
  cy.wait(1000) // eslint-disable-line cypress/no-unnecessary-waiting
  ...
})
```

You can also disable a rule for the next line:

```js
it('waits for a second', () => {
  ...
  // eslint-disable-next-line cypress/no-unnecessary-waiting
  cy.wait(1000)
  ...
})
```

For more, see the [ESLint rules](https://eslint.org/docs/user-guide/configuring/rules) documentation.

## Rules

These rules enforce some of the [best practices recommended for using Cypress](https://on.cypress.io/best-practices).

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

💼 Configurations enabled in.\
✅ Set in the `recommended` configuration.

| Name                                                                     | Description                                                | 💼 |
| :----------------------------------------------------------------------- | :--------------------------------------------------------- | :- |
| [assertion-before-screenshot](docs/rules/assertion-before-screenshot.md) | require screenshots to be preceded by an assertion         |    |
| [no-assigning-return-values](docs/rules/no-assigning-return-values.md)   | disallow assigning return values of `cy` calls             | ✅  |
| [no-async-before](docs/rules/no-async-before.md)                         | disallow using `async`/`await` in Cypress `before` methods |    |
| [no-async-tests](docs/rules/no-async-tests.md)                           | disallow using `async`/`await` in Cypress test cases       | ✅  |
| [no-force](docs/rules/no-force.md)                                       | disallow using `force: true` with action commands          |    |
| [no-pause](docs/rules/no-pause.md)                                       | disallow using `cy.pause()` calls                          |    |
| [no-unnecessary-waiting](docs/rules/no-unnecessary-waiting.md)           | disallow waiting for arbitrary time periods                | ✅  |
| [require-data-selectors](docs/rules/require-data-selectors.md)           | require `data-*` attribute selectors                       |    |
| [unsafe-to-chain-command](docs/rules/unsafe-to-chain-command.md)         | disallow actions within chains                             | ✅  |

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

## Mocha and Chai

Cypress is built on top of [Mocha](https://on.cypress.io/guides/references/bundled-libraries#Mocha) and [Chai](https://on.cypress.io/guides/references/bundled-libraries#Chai). See the following sections for information on using ESLint plugins [eslint-plugin-mocha](https://www.npmjs.com/package/eslint-plugin-mocha) and [eslint-plugin-chai-friendly](https://www.npmjs.com/package/eslint-plugin-chai-friendly) together with `@ryniaubenpm2/aut-explicabo-velit`.

## Mocha `.only` and `.skip`

During test spec development, [Mocha exclusive tests](https://mochajs.org/#exclusive-tests) `.only` or [Mocha inclusive tests](https://mochajs.org/#inclusive-tests) `.skip` may be used to control which tests are executed, as described in the Cypress documentation [Excluding and Including Tests](https://on.cypress.io/guides/core-concepts/writing-and-organizing-tests#Excluding-and-Including-Tests). To apply corresponding rules, you can install and use [eslint-plugin-mocha](https://www.npmjs.com/package/eslint-plugin-mocha). The rule [mocha/no-exclusive-tests](https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/no-exclusive-tests.md) detects the use of `.only` and the [mocha/no-skipped-tests](https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/no-skipped-tests.md) rule detects the use of `.skip`:

```sh
npm install --save-dev eslint-plugin-mocha
```

In your `.eslintrc.json`:

```json
{
  "plugins": [
    "cypress",
    "mocha"
  ],
  "rules": {
    "mocha/no-exclusive-tests": "warn",
    "mocha/no-skipped-tests": "warn"
  }
}
```

Or you can simply use the `cypress/recommended` and `mocha/recommended` configurations together, for example:

```json
{
  "extends": [
    "plugin:cypress/recommended",
    "plugin:mocha/recommended"
  ]
}
```

## Chai and `no-unused-expressions`

Using an assertion such as `expect(value).to.be.true` can fail the ESLint rule `no-unused-expressions` even though it's not an error in this case. To fix this, you can install and use [eslint-plugin-chai-friendly](https://www.npmjs.com/package/eslint-plugin-chai-friendly).

```sh
npm install --save-dev eslint-plugin-chai-friendly
```

In your `.eslintrc.json`:

```json
{
  "plugins": [
    "cypress",
    "chai-friendly"
  ],
  "rules": {
    "no-unused-expressions": 0,
    "chai-friendly/no-unused-expressions": 2
  }
}
```

Or you can simply add its `recommended` config:

```json
{
  "extends": ["plugin:chai-friendly/recommended"]
}
```

## Contributing

Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains how to contribute rules or other fixes and features to the repo.

---
_Source: https://npm.io/package/@ryniaubenpm2/aut-explicabo-velit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._