Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(NOBUG): I forgot to include the rule in the plugin #523

Merged
merged 1 commit into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/eslint-plugin/src/rules/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
const componentNamesAreMultiWord = require('./component-names-are-multi-word.js');
const renderVariablesAreExported = require('./render-variables-are-exported');

module.exports = {
'component-names-are-multi-word': componentNamesAreMultiWord,
'render-variables-are-exported': renderVariablesAreExported
};
6 changes: 5 additions & 1 deletion packages/website/pages/eslint-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,12 @@ module.exports = {

## Available rules

We currently only have one rule, but we plan to add more!
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](https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name).

## 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.