@heycart-ag/admin-eslint-rules/README.md

HeyCart Administration ESLint rules

# ESLint Rules for HeyCart Administration

This package provides ESLint rules for the HeyCart Administration.

## Installation

You can install this package using npm:

```bash
npm install @heycart-ag/admin-eslint-rules --save-dev
```

## Usage

Add the following to your `.eslintrc.js` file:

```javascript
module.exports = {
    "plugins": [
        "@heycart-ag/admin-eslint-rules"
    ],
    "rules": {
        "@heycart-ag/admin-eslint-rules/no-snippet-import": "error",
        "@heycart-ag/admin-eslint-rules/no-src-import": "error",
        "@heycart-ag/admin-eslint-rules/no-sw-extension-override": "error",
        "@heycart-ag/admin-eslint-rules/require-explict-emits": "error",
        "@heycart-ag/admin-eslint-rules/state-import": "error"
    }
};
```

## Rules

- `no-snippet-import`: Prevents direct import of snippets.
- `no-src-import`: Prevents direct import of `src` files.
- `no-sw-extension-override`: Prevents overriding of `sw-extension` components.
- `require-explict-emits`: Requires explicit emits in components.
- `state-import`: Enforces correct import of state.