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.

Sign up for GitHub

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

Jump to bottom

Should this be a config, not a plugin? #1

Closed
wants to merge 1 commit into from
Closed

Should this be a config, not a plugin? #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Cypress ESLint Plugin
# Cypress ESLint Config

An ESLint plugin for projects that use Cypress.
An ESLint config for projects that use Cypress.

Specifies the environment and globals (`cy`, `Cypress`, etc) for use when writing tests using [Cypress](https://cypress.io).

## Installation

```sh
npm install eslint-plugin-cypress --save-dev
npm install eslint-config-cypress --save-dev
```

## Usage

Add `cypress` as a plugin in your `.eslintrc`:
Add `cypress` as a config in your `.eslintrc`:

```json
{
"plugins": [
"extends": [
"cypress"
]
}
Expand Down
12 changes: 6 additions & 6 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
{
"name": "eslint-plugin-cypress",
"name": "eslint-config-cypress",
"version": "1.1.0",
"description": "An ESLint plugin for projects that use Cypress",
"description": "An ESLint config for projects that use Cypress",
"main": "index.js",
"author": "Chris Breiding (chris@cypress.io)",
"license": "MIT",
"keywords": [
"eslint",
"eslintplugin",
"eslintconfig",
"cypress"
],
"repository": {
"type": "git",
"url": "git+https://github.com/cypress-io/eslint-plugin-cypress.git"
"url": "git+https://github.com/cypress-io/eslint-config-cypress.git"
},
"bugs": {
"url": "https://github.com/cypress-io/eslint-plugin-cypress/issues"
"url": "https://github.com/cypress-io/eslint-config-cypress/issues"
},
"homepage": "https://github.com/cypress-io/eslint-plugin-cypress#readme",
"homepage": "https://github.com/cypress-io/eslint-config-cypress#readme",
"peerDependencies": {
"eslint": ">= 3.2.1"
}
Expand Down