cy-lint

Cy-Lint is a Cypress linting tool that helps ensure your test files adhere to best practices. It analyzes your Cypress tests based on a set of rules defined in a configuration file and generates a report of any violations found.

Cy-Lint is a Cypress linting tool that helps ensure your test files adhere to best practices. It analyzes your Cypress tests based on a set of rules defined in a configuration file and generates a report of any violations found`

Installation

To install Cy-Lint as a CLI tool, use:

npm install cy-lint

Usage

You can run the linter on your test files with: cylint

If your configuration file is not found, you can create a sample configuration file using the init command: cylint init [directory] Where [directory] is the directory where you want to create the config file. If not specified, the current directory will be used.

Configuration

The rules are defined in a .cylintrc.json configuration file. This file should be located at the root of your project or any subdirectory. In there you can select wich rules should be active and also define teh path to your test scripts.

Creating new rules

To create a new rule, follow these steps:

1. Create a new TypeScript file in the src/rules directory.
2. Define and export a function that analyzes a TypeScript AST node and returns an array of violations.
3. Add an entry for the new rule in the src/rulesRegistry.ts file, mapping the rule's unique ID to the function.
4. Update the configuration file to enable or disable the new rule as needed.

Contributing

We welcome contributions to this project. Please submit a pull request with your proposed changes, and include a description of the changes and the reason for the update.

Before submitting a pull request, make sure to test your changes thoroughly and update any relevant documentation.