@ryniaubenpm2/laudantium-quo-amet

v1.0.0

Published

8 months ago

<div align="center"> <a href="https://eslint.org/"> <img height="150" src="https://eslint.org/assets/images/logo/eslint-logo-color.svg"> </a> <a href="https://jestjs.io/"> <img width="150" height="150" vspace="" hspace="25" src="https://jest

Downloads

0High
0Medium
0Low

mi762136

sort values findLast includes cli predictable jsdiff trimRight es8 typeof tostringtag parent classes symbols airbnb key styling ES6 exe utilities watcher typesafe js cloudwatch structuredClone glob log input slice dataView ast es-shims form Object.fromEntries compiler inspect check promise uuid iterate css variable deep-clone auth jest ava javascript up syntax Observables multi-package property dir writable eslint-plugin browserslist l10n serialize [[Prototype]]description is remove move parsing circular TypeBox random extend flags import break whatwg banner flatMap regex dayjs create yup robust rgb busy setPrototypeOf Int8Array delete styled-components typed array nodejs form-validation push elasticache cloudformation walk intrinsic option parser copy crypto regular expressions symbol call-bound gradients css3 merge asserts bind opener private ES7 es2016 internal proto password make dir Symbol.toStringTag view lint environment class-validator editor argument mime stream handlers toSorted dom filter entries linux crypt String.prototype.trim qs fullwidth fetch functional polyfill ArrayBuffer.prototype.slice shrinkwrap negative text Microsoft deepclone api dom-testing-library stateless weakset lru wordbreak console function watch character swf require estree restful prune irq datastructure assign validation endpoint chinese mru nested css extra from fast-copy watchFile serialization open authentication react-hooks eslintplugin status runtime recursive es-shim API TypeScript RegExp.prototype.flags forEach tc39 warning command-line japanese cjk env picomatch live descriptors Array.prototype.flatten nope ECMAScript 6 ES2017 amazon uninstall has link flatten accessibility rate ECMAScript 2020 connect JSON positive find-up install read consume deepcopy color node yaml properties es2017 functions lockfile toArray ESnext css-in-js waf ascii setter es7 descriptor Array.prototype.flat io-ts toobject helpers electron patch jsx eventDispatcher weakmap side ES3 website eslint less mixins workspace:*RFC-6455 rapid app native drop router language Uint8ClampedArray cloudtrail Object.is YAML vest testing mkdir redux-toolkit URLSearchParams in clone dynamodb compile less mobile bluebird throat aws east-asian-width jQuery launch es2015 Object.entries deterministic moment identifiers codes directory proxy route53 es5 typedarrays redact promises has-own getOwnPropertyDescriptor logging time array equality reducer kinesis immutable invariant guid progress wait BigInt64Array hooks Set i18n ECMAScript 2023 syntaxerror findLastIndex group generics chai settings sns environments command karma s3 npm framework https sham jsonpath censor less compiler query real-time mapreduce es-abstract tap simpledb setImmediate ajv installer callback byteOffset extension Array.prototype.findLast escape signal byte symlinks callbind exit worker joi debugger middleware safe regular expression watching es6 throttle awesomesauce internal slot tools a11y collection.es6 ES2015 ebs windows queue react-testing-library dataview vars ender bootstrap less fsevents defineProperty Observable preprocessor ES2020 which Array AsyncIterator cache listeners channel eslintconfig callbound loading CSS fast $.extend Int32Array logger css nesting number sameValueZero package hasOwnProperty ECMAScript 2021 WebSocket call bound offset styles packages tty URL ReactiveX term isConcatSpreadable Array.prototype.includes batch eventEmitter tape jwt lesscss data inference collection events _.extend trimStart telephone ES2023 rmdir ECMAScript 2022 browser interrupts child redux task package.json await spawn process ArrayBuffer#slice type .env rm -fr reuse write urls getintrinsic dependencies Float64Array sequence styleguide every JSON-Schema spec shebang ECMAScript 2017 ts schema matchAll ECMAScript 2016 fast-deep-copy __proto__preserve-symlinks superagent Symbol rangeerror rm -rf folder fps bundler rm find Uint8Array loadbalancing ES5 json stable trim Float32Array commander enumerable format last object rest shared ec2 get bootstrap css style Object.getPrototypeOf ajax jasmine path ECMAScript 2019 error-handling debug touch phone fastify Uint32Array columns contains map state Int16Array emr Map Promise coercible ponyfill parents name core postcss-plugin regexp exec classnames gdpr core-js column argv concat file system ECMAScript 7 Reflect.getPrototypeOf define TypedArray macos compare Array.prototype.contains keys deep less css obj react url request sqs regular korean duplex sinatra minimal plugin shim types tslib diff hash monorepo zero sigint spinner Object.keys streams2 buffer typedarray full parse id pnpm9 Uint16Array tester xhr react-hook-form limit call-bind

Installation

yarn add --dev eslint @ryniaubenpm2/laudantium-quo-amet

Note: If you installed ESLint globally then you must also install @ryniaubenpm2/laudantium-quo-amet globally.

Usage

[!NOTE]
eslint.config.js is supported, though most of the plugin documentation still currently uses .eslintrc syntax.
Refer to the ESLint documentation on the new configuration file format for more.

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

{
  "plugins": ["jest"]
}

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

{
  "rules": {
    "jest/no-disabled-tests": "warn",
    "jest/no-focused-tests": "error",
    "jest/no-identical-title": "error",
    "jest/prefer-to-have-length": "warn",
    "jest/valid-expect": "error"
  }
}

You can also tell ESLint about the environment variables provided by Jest by doing:

{
  "env": {
    "jest/globals": true
  }
}

This is included in all configs shared by this plugin, so can be omitted if extending them.

Aliased Jest globals

You can tell this plugin about any global Jests you have aliased using the globalAliases setting:

{
  "settings": {
    "jest": {
      "globalAliases": {
        "describe": ["context"],
        "fdescribe": ["fcontext"],
        "xdescribe": ["xcontext"]
      }
    }
  }
}

Aliased `@jest/globals`

You can tell this plugin to treat a different package as the source of Jest globals using the globalPackage setting:

{
  "settings": {
    "jest": {
      "globalPackage": "bun:test"
    }
  }
}

[!WARNING]
While this can be used to apply rules when using alternative testing libraries and frameworks like bun, vitest and node, there's no guarantee the semantics this plugin assumes will hold outside of Jest

Running rules only on test-related files

The rules provided by this plugin assume that the files they are checking are test-related. This means it's generally not suitable to include them in your top-level configuration as that applies to all files being linted which can include source files.

For .eslintrc configs you can use overrides to have ESLint apply additional rules to specific files:

{
  "extends": ["eslint:recommended"],
  "overrides": [
    {
      "files": ["test/**"],
      "plugins": ["jest"],
      "extends": ["plugin:jest/recommended"],
      "rules": { "jest/prefer-expect-assertions": "off" }
    }
  ],
  "rules": {
    "indent": ["error", 2]
  }
}

For eslint.config.js you can use files and ignores:

const jest = require('@ryniaubenpm2/laudantium-quo-amet');

module.exports = [
  ...require('@eslint/js').configs.recommended,
  {
    files: ['test/**'],
    ...jest.configs['flat/recommended'],
    rules: {
      ...jest.configs['flat/recommended'].rules,
      'jest/prefer-expect-assertions': 'off',
    },
  },
  // you can also configure jest rules in other objects, so long as some of the `files` match
  {
    files: ['test/**'],
    rules: { 'jest/prefer-expect-assertions': 'off' },
  },
];

Jest `version` setting

The behaviour of some rules (specifically no-deprecated-functions) change depending on the version of Jest being used.

By default, this plugin will attempt to determine to locate Jest using require.resolve, meaning it will start looking in the closest node_modules folder to the file being linted and work its way up.

Since we cache the automatically determined version, if you're linting sub-folders that have different versions of Jest, you may find that the wrong version of Jest is considered when linting. You can work around this by providing the Jest version explicitly in nested ESLint configs:

{
  "settings": {
    "jest": {
      "version": 27
    }
  }
}

To avoid hard-coding a number, you can also fetch it from the installed version of Jest if you use a JavaScript config file such as .eslintrc.js:

module.exports = {
  settings: {
    jest: {
      version: require('jest/package.json').version,
    },
  },
};

Shareable configurations

[!NOTE]
eslint.config.js compatible versions of configs are available prefixed with flat/ and may be subject to small breaking changes while ESLint v9 is being finalized.

Style

This plugin also exports a configuration named style, which adds some stylistic rules, such as prefer-to-be-null, which enforces usage of toBeNull over toBe(null).

To enable this configuration use the extends property in your .eslintrc config file:

{
  "extends": ["plugin:jest/style"]
}

To enable this configuration with eslint.config.js, use jest.configs['flat/style']:

const jest = require('@ryniaubenpm2/laudantium-quo-amet');

module.exports = [
  {
    files: [
      /* glob matching your test files */
    ],
    ...jest.configs['flat/style'],
  },
];

All

If you want to enable all rules instead of only some you can do so by adding the all configuration to your .eslintrc config file:

{
  "extends": ["plugin:jest/all"]
}

To enable this configuration with eslint.config.js, use jest.configs['flat/all']:

const jest = require('@ryniaubenpm2/laudantium-quo-amet');

module.exports = [
  {
    files: [
      /* glob matching your test files */
    ],
    ...jest.configs['flat/all'],
  },
];

While the recommended and style configurations only change in major versions the all configuration may change in any release and is thus unsuited for installations requiring long-term consistency.

Rules

💼 Configurations enabled in.
⚠️ Configurations set to warn in.
✅ Set in the recommended configuration.
🎨 Set in the style configuration.
🔧 Automatically fixable by the --fix CLI option.
💡 Manually fixable by editor suggestions.

Requires Type Checking

| Name | Description | 💼 | ⚠️ | 🔧 | 💡 | | :--------------------------------------------- | :----------------------------------------------------------- | :-- | :-- | :-- | :-- | | unbound-method | Enforce unbound methods are called with their expected scope | | | | |

In order to use the rules powered by TypeScript type-checking, you must be using @typescript-eslint/parser & adjust your eslint config as outlined here.

Note that unlike the type-checking rules in @typescript-eslint/eslint-plugin, the rules here will fallback to doing nothing if type information is not available, meaning it's safe to include them in shared configs that could be used on JavaScript and TypeScript projects.

Also note that unbound-method depends on @typescript-eslint/eslint-plugin, as it extends the original unbound-method rule from that plugin.

Credit

Related Projects