[!WARNING] THIS PLUGIN IS A WORK IN PROGRESS!

A set of Oxlint rules to help developers write better Qwik code.

This project is a port of eslint-plugin-qwik.

Usage

npm add -D oxlint-plugin-qwik
pnpm add -D oxlint-plugin-qwik
yarn add -D oxlint-plugin-qwik
bun add -D oxlint-plugin-qwik

Configurations

Using default rulesets

The plugin includes two primary rulesets:

import { recommended, strict } from 'oxlint-plugin-qwik/ruleset';
import { defineConfig } from 'oxlint';

export default defineConfig({
	extends: [strict], // recommended
});

Customizing your ruleset

If you prefer granular control, you can register the plugin manually and toggle specific rules within the rules object.

import { defineConfig } from 'oxlint';

export default defineConfig({
	jsPlugins: ['oxlint-plugin-qwik'],
	rules: {
		// override rules
		// "qwik/jsx-img": "error",
	},
});

Available rules

A list of rules that we are currently based is in here.

• ✅: Supported
• ⌛️: In progress
• ⚓: Native support

| Rule | Status | | :----------------------: | :----------------------------------------------------------------: | | qwik/use-method-usage | ✅ | | qwik/valid-lexical-scope | https://github.com/qwiksilverlabs/oxlint-plugin-qwik/discussions/2 | | qwik/loader-location | ✅ | | qwik/no-react-props | ✅ | | qwik/prefer-classlist | ✅ | | qwik/jsx-no-script-url | ✅ | | qwik/jsx-key | ⚓ | | qwik/unused-server | https://github.com/qwiksilverlabs/oxlint-plugin-qwik/discussions/1 | | qwik/jsx-img | ✅ | | qwik/jsx-a-tag | ✅ | | qwik/no-use-visible-task | ✅ |

Contributing

This project welcomes contributions of all types. Before you start work on a feature that you would like to contribute, please read our Contributor's Guide.