weg-eslint-configuration v1.0.3

WEG Eslint Configuration

Overview

This package provides a shared ESLint configuration for your JavaScript/TypeScript projects. It includes a set of SEO rules and settings that ensure code quality and consistency across all your repositories.

Installation

To install the ESLint configuration package, run the following command:

npm install --save-dev weg-eslint-configuration

Or, if you’re using yarn:

yarn add --dev weg-eslint-configuration

Usage

Import The Plugin

const wegPlugin = require("weg-eslint-configuration");

Add the following line to your .eslintrc.json or .eslintrc.js or eslint.config.js (Above eslint 9.0) file to extend the configuration:

{
  "extends": [wegPlugin],
}

Running ESLint

npx eslint .

or with yarn:

yarn eslint .

Available Scripts

Add these scripts to your package.json for convenience:

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  }
}

Then, run the linting commands with:

npm run lint

or to automatically fix issues:

npm run lint:fix

Contributing

We welcome contributions! Please follow these guidelines:

1. Clone the repository.
2. Create a new branch git checkout -b feature/your-feature-name.
3. Make your changes and commit them git commit -m 'Add some feature'.
4. Push to the branch git push origin feature/your-feature-name.
5. Open a Merge Request.