@tybalt/eslint-plugin

Tybalt uses eslint for linting.

Installation

Install the plugin with your favorite package manager

npm i -D @tybalt/eslint-plugin

Getting Started

The best way to get started is to extend our recommended rule set. For example, in .eslintrc.cjs:

module.exports = {
    extends: ['@tybalt/eslint-plugin/ts-recommended'],
};

Available rules

We currently only have two rules, but we plan to add more!

Component names are multi-word

Checks to make sure that your component has a multi-word name (a name that contains an en-dash -). This is a requirement from the spec.

Render variables are exported

Checks to make sure that the variables you are using in your render function were exported, either as a prop or from a setup function.