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.

Sign up for GitHub

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

Jump to bottom

chore: use no-restricted-syntax to enforce created options in rules #6074

Merged
merged 5 commits into from Nov 24, 2022
Merged

chore: use no-restricted-syntax to enforce created options in rules #6074

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6e7ade5
fix(eslint-plugin): [keyword-spacing] prevent crash on no options
JoshuaKGoldberg Nov 23, 2022
ee43230
chore: add internal lint rule to always prefer created options
JoshuaKGoldberg Nov 23, 2022
b586758
Merge branch 'main' into lint-always-create-options
JoshuaKGoldberg Nov 24, 2022
9be5793
All right base rules, you do you
JoshuaKGoldberg Nov 24, 2022
790a565
Merge branch 'main' into lint-always-create-options
JoshuaKGoldberg Nov 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions .eslintrc.js
View file
Open in desktop
Expand Up @@ -264,6 +264,16 @@ module.exports = {

// specifically for rules - default exports makes the tooling easier
'import/no-default-export': 'off',

'no-restricted-syntax': [
'error',
{
selector:
'ExportDefaultDeclaration Property[key.name="create"] MemberExpression[object.name="context"][property.name="options"]',
message:
"Retrieve options from create's second parameter so that defaultOptions are applied.",
},
],
},
},
// plugin rule tests
Expand Down
5 changes: 1 addition & 4 deletions packages/eslint-plugin/src/rules/brace-style.ts
View file
Open in desktop
Expand Up @@ -27,10 +27,7 @@ export default createRule<Options, MessageIds>({
schema: baseRule.meta.schema,
},
defaultOptions: ['1tbs'],
create(context) {
const [style, { allowSingleLine } = { allowSingleLine: false }] =
context.options;

create(context, [style, { allowSingleLine } = { allowSingleLine: false }]) {
const isAllmanStyle = style === 'allman';
const sourceCode = context.getSourceCode();
const rules = baseRule.create(context);
Expand Down
6 changes: 3 additions & 3 deletions packages/eslint-plugin/src/rules/keyword-spacing.ts
View file
Open in desktop
Expand Up @@ -25,7 +25,7 @@ export default util.createRule<Options, MessageIds>({
},
defaultOptions: [{}],

create(context) {
create(context, [{ after }]) {
const sourceCode = context.getSourceCode();
const baseRules = baseRule.create(context);
return {
Expand Down Expand Up @@ -58,7 +58,7 @@ export default util.createRule<Options, MessageIds>({
const punctuatorToken = sourceCode.getTokenAfter(typeToken)!;
const spacesBetweenTypeAndPunctuator =
punctuatorToken.range[0] - typeToken.range[1];
if (context.options[0].after && spacesBetweenTypeAndPunctuator === 0) {
if (after && spacesBetweenTypeAndPunctuator === 0) {
context.report({
loc: punctuatorToken.loc,
messageId: 'expectedBefore',
Expand All @@ -68,7 +68,7 @@ export default util.createRule<Options, MessageIds>({
},
});
}
if (!context.options[0].after && spacesBetweenTypeAndPunctuator > 0) {
if (!after && spacesBetweenTypeAndPunctuator > 0) {
context.report({
loc: punctuatorToken.loc,
messageId: 'unexpectedBefore',
Expand Down
4 changes: 1 addition & 3 deletions packages/eslint-plugin/src/rules/no-unused-vars.ts
View file
Open in desktop
Expand Up @@ -84,7 +84,7 @@ export default util.createRule<Options, MessageIds>({
},
},
defaultOptions: [{}],
create(context) {
create(context, [firstOption]) {
const filename = context.getFilename();
const sourceCode = context.getSourceCode();
const MODULE_DECL_CACHE = new Map<TSESTree.TSModuleDeclaration, boolean>();
Expand All @@ -97,8 +97,6 @@ export default util.createRule<Options, MessageIds>({
caughtErrors: 'none',
};

const [firstOption] = context.options;

if (firstOption) {
if (typeof firstOption === 'string') {
options.vars = firstOption;
Expand Down
3 changes: 1 addition & 2 deletions packages/eslint-plugin/src/rules/object-curly-spacing.ts
View file
Open in desktop
Expand Up @@ -30,8 +30,7 @@ export default createRule<Options, MessageIds>({
},
},
defaultOptions: ['never'],
create(context) {
const [firstOption, secondOption] = context.options;
create(context, [firstOption, secondOption]) {
const spaced = firstOption === 'always';
const sourceCode = context.getSourceCode();

Expand Down
1 change: 1 addition & 0 deletions packages/eslint-plugin/src/rules/padding-line-between-statements.ts
View file
Open in desktop
Expand Up @@ -634,6 +634,7 @@ export default util.createRule<Options, MessageIds>({
defaultOptions: [],
create(context) {
const sourceCode = context.getSourceCode();
// eslint-disable-next-line no-restricted-syntax -- We need all raw options.
const configureList = context.options || [];

type Scope = null | {
Expand Down
3 changes: 1 addition & 2 deletions packages/eslint-plugin/src/rules/space-before-blocks.ts
View file
Open in desktop
Expand Up @@ -29,9 +29,8 @@ export default util.createRule<Options, MessageIds>({
},
},
defaultOptions: ['always'],
create(context) {
create(context, [config]) {
const rules = baseRule.create(context);
const config = context.options[0];
const sourceCode = context.getSourceCode();

let requireSpace = true;
Expand Down