@necrobox/eslint-plugin-no-only-tests 6.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Artem Frolkov and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+# @necrobox/eslint-plugin-no-only-tests
+
+[![npm](https://img.shields.io/npm/v/@necrobox/eslint-plugin-no-only-tests.svg)](https://www.npmjs.com/package/@necrobox/eslint-plugin-no-only-tests)
+
+Disallow the use of `describe.only()` and `it.only()`.
+
+[По-русски](./README.ru.md)
+
+## Installation
+
+You'll first need to install [ESLint](http://eslint.org):
+
+```
+$ npm i eslint --save-dev
+```
+
+Next, install the plugin:
+
+```
+$ npm install @necrobox/eslint-plugin-no-only-tests --save-dev
+```
+
+## Usage
+
+Add `@necrobox/eslint-plugin-no-only-tests` to the `plugins` section of your `.eslintrc` configuration file. 
+You can omit the `eslint-plugin-` prefix:
+
+```json
+{
+  "plugins": [
+    "@necrobox/no-only-tests"
+  ]
+}
+```
+
+
+Then configure the rule under the `rules` section.
+
+```json
+{
+  "rules": {
+    "@necrobox/no-only-tests/no-only": 2
+  }
+}
+```
+
+## Rationale
+
+When developers fix tests they may make the process easier by filtering tests using method `only` on `it` & `describe`.
+
+However, such filters should not be in the repo when the project is running on CI.
+So, we add this rule to our [ESLint config](https://github.com/necrobox/eslint-config) to check the existence of `only`
+in the tests files. And we run linter using precommit-hook, which make it possible to prevent committing
+when `only` does exist in the code.

package/README.ru.md

@@ -0,0 +1,53 @@
+# @necrobox/eslint-plugin-no-only-tests
+
+[![npm](https://img.shields.io/npm/v/@necrobox/eslint-plugin-no-only-tests.svg)](https://www.npmjs.com/package/@necrobox/eslint-plugin-no-only-tests)
+
+**eslint-plugin-no-only-tests** — это плагин ESLint, который проверяет наличие в файлах `describe.only()` и `it.only()`, и в случае их обнаружения показывает предупреждение.
+
+## Установка
+
+Для начала необходимо установить [ESLint](http://eslint.org):
+
+```
+$ npm i eslint --save-dev
+```
+
+Далее установить сам плагин:
+
+```
+$ npm install @necrobox/eslint-plugin-no-only-tests --save-dev
+```
+
+## Использование
+
+Необходимо добавить `@necrobox/eslint-plugin-no-only-tests` в раздел `plugins` конфигурационного файла `.eslintrc`.
+Можно опустить префикс `eslint-plugin-`:
+
+```json
+{
+  "plugins": [
+    "@necrobox/no-only-tests"
+  ]
+}
+```
+
+Далее настроить правило в разделе `rules`:
+
+
+```json
+{
+  "rules": {
+    "@necrobox/no-only-tests/no-only": 2
+  }
+}
+```
+
+## Мотивация
+
+Когда разработчик отлаживает тесты локально, он может для упрощения процесса оставить включёнными только те из них,
+которые сломаны. Удобнее всего это делать с помощью метода `only` в `it` и `describe`.
+
+Однако, на CI нужно запускать все тесты.
+Потому мы включаем в нашем [ESLint-конфиге](https://github.com/necrobox/eslint-config) этот плагин, и он проверяет,
+не используется ли метод `only` в файлах с тестами. А сам линтер запускаем с помощью прекоммит-хука,
+тем самым блокируя возможность коммита в случае наличия `only` в кодовой базе.

package/lib/index.js

@@ -0,0 +1,3 @@
+module.exports.rules = {
+  'no-only': require('./rules/no-only'),
+};

package/lib/rules/no-only.js

@@ -0,0 +1,27 @@
+module.exports = {
+  meta: {
+    docs: {
+      description: 'disallow the use of describe.only() and it.only()',
+      category: 'Best Practices',
+      recommended: true,
+    },
+    schema: [],
+  },
+
+  create(context) {
+    return {
+      CallExpression(node) {
+        const callee = node.callee;
+
+        if (callee.type === 'MemberExpression') {
+          if (['describe', 'it'].includes(callee.object.name) && callee.property.name === 'only') {
+            context.report({
+              node,
+              message: `Unexpected ${callee.object.name}.only`,
+            });
+          }
+        }
+      },
+    };
+  },
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@necrobox/eslint-plugin-no-only-tests",
+  "version": "6.0.0",
+  "description": "Disallow the use of describe.only() and it.only()",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/necrobox/eslint-plugin-no-only-tests"
+  },
+  "files": [
+    "lib/"
+  ],
+  "author": "Artem Frolkov <art.frolkov@gmail.com> (https://github.com/artfrolkov)",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "scripts": {
+    "lint": "eslint --cache --ext .js ./",
+    "test": "mocha tests --recursive"
+  },
+  "devDependencies": {
+    "@necrobox/eslint-config": "8.0.0",
+    "eslint": "7.32.0",
+    "mocha": "10.8.2"
+  }
+}