Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: standardize meta.docs.description property #192

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"pattern": "https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/{{name}}.md"
}
],
"eslint-plugin/require-meta-docs-description": "error",
"n/no-extraneous-require": [
"error",
{
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/assertion-before-screenshot.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ module.exports = {
meta: {
type: 'problem',
docs: {
description: 'Assert on the page state before taking a screenshot, so the screenshot is consistent',
description: 'require screenshots to be preceded by an assertion',
category: 'Possible Errors',
recommended: false,
url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/assertion-before-screenshot.md',
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/no-assigning-return-values.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ module.exports = {
meta: {
type: 'problem',
docs: {
description: 'Prevent assigning return values of cy calls',
description: 'disallow assigning return values of `cy` calls',
category: 'Possible Errors',
recommended: true,
url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-assigning-return-values.md',
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/no-async-before.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module.exports = {
meta: {
type: 'problem',
docs: {
description: 'Prevent using async/await in Cypress before methods',
description: 'disallow using `async`/`await` in Cypress `before` methods',
category: 'Possible Errors',
recommended: true,
url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-async-before.md',
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/no-async-tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module.exports = {
meta: {
type: 'problem',
docs: {
description: 'Prevent using async/await in Cypress test cases',
description: 'disallow using `async`/`await` in Cypress test cases',
category: 'Possible Errors',
recommended: true,
url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-async-tests.md',
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/no-force.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'Disallow using of \'force: true\' option for click and type calls',
description: 'disallow using `force: true` with action commands',
category: 'Possible Errors',
recommended: false,
url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-force.md',
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/no-pause.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'Disallow using of \'cy.pause\' calls',
description: 'disallow using `cy.pause()` calls',
category: 'Possible Errors',
recommended: false,
url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-pause.md',
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/no-unnecessary-waiting.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module.exports = {
meta: {
type: 'problem',
docs: {
description: 'Prevent waiting for arbitrary time periods',
description: 'disallow waiting for arbitrary time periods',
category: 'Possible Errors',
recommended: true,
url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-unnecessary-waiting.md',
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/require-data-selectors.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'Use data-* attributes to provide context to your selectors and insulate them from CSS or JS changes',
description: 'require `data-*` attribute selectors',
category: 'Possible Errors',
recommended: false,
url: 'https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/require-data-selectors.md',
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/unsafe-to-chain-command.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
const { basename } = require('path')

const NAME = basename(__dirname)
const DESCRIPTION = 'Actions should be in the end of chains, not in the middle'
const DESCRIPTION = 'disallow actions within chains'

/**
* Commands listed in the documentation with text: 'It is unsafe to chain further commands that rely on the subject after xxx.'
Expand Down