eslint-plugin-rules-for-qwik

ESLint plugin with rules for programming in Qwik.

Installation

Install the plugin with npm:

npm install --save-dev koenvanmeijeren-eslint-plugin-rules-for-qwik

Usage

In your .eslintrc file, add the rules to your plugins:

{
  "plugins": [
    "koenvanmeijeren-rules-for-qwik"
  ],
  "rules": {
    "koenvanmeijeren-rules-for-qwik/no-direct-scss-imports": "error",
    "koenvanmeijeren-rules-for-qwik/require-generic-props": "error"
    "koenvanmeijeren-rules-for-qwik/require-document-head": ["error", {
      "excludedFiles": ["**/exclude-this-file.ts", "**/exclude-this-directory/**"]
    }]
  }
}

Release new version

To release a new version, run the following commands:

npm login
npm run release

Rules

no-direct-scss-imports

This rule checks for direct imports of SCSS files and suggests using importing the SCSS in global files instead.

require-document-head

This rule requires the document head for all routes.

Added to comply with WCAG standards.

require-generic-props

This rule requires generic props for all components.

Added to fix a weird error in Qwik component library.

License

This project is licensed under the MIT License.