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
docs: update shared settings example #18251
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistent indentation.
plugins: { | ||
customPlugin: { | ||
rules: { | ||
"my-rule": { | ||
meta: { | ||
// custom rule's meta information | ||
}, | ||
|
||
create(context) { | ||
const sharedData = context.settings.sharedData; | ||
|
||
return { | ||
// code | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
rules: { | ||
"customPlugin/my-rule": "error" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
plugins: { | |
customPlugin: { | |
rules: { | |
"my-rule": { | |
meta: { | |
// custom rule's meta information | |
}, | |
create(context) { | |
const sharedData = context.settings.sharedData; | |
return { | |
// code | |
} | |
} | |
} | |
} | |
} | |
}, | |
rules: { | |
"customPlugin/my-rule": "error" | |
plugins: { | |
customPlugin: { | |
rules: { | |
"my-rule": { | |
meta: { | |
// custom rule's meta information | |
}, | |
create(context) { | |
const sharedData = context.settings.sharedData; | |
return { | |
// code | |
}; | |
} | |
} | |
} | |
} | |
}, | |
rules: { | |
"customPlugin/my-rule": "error" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Added custom plugin example to show how shared data can be used in custom plugin.
Is there anything you'd like reviewers to focus on?
Fixes: #16507