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

pr review feedback #448

Merged
merged 2 commits into from
Jul 26, 2024
Merged

pr review feedback #448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df5e029
refactor: pr review
mshanemc Jul 25, 2024
9829eb5
refactor: min/max/default
mshanemc Jul 25, 2024
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
10 changes: 3 additions & 7 deletions src/rules/dash-h.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,9 @@ export const dashH = RuleCreator.withoutDocs({
node.value?.type === AST_NODE_TYPES.CallExpression &&
node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression
) {
const hChar = node.value.arguments[0].properties.find(
(property) =>
property.type === AST_NODE_TYPES.Property &&
flagPropertyIsNamed(property, 'char') &&
property.value.type === AST_NODE_TYPES.Literal &&
property.value.value === 'h'
);
const hChar = node.value.arguments[0].properties
.filter(flagPropertyIsNamed('char'))
.find((property) => property.value.type === AST_NODE_TYPES.Literal && property.value.value === 'h');
if (hChar) {
context.report({
node: hChar,
Expand Down
10 changes: 3 additions & 7 deletions src/rules/dash-o.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,9 @@ export const dashO = RuleCreator.withoutDocs({
!node.value.callee.property.name.toLowerCase().includes('hub') &&
node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression
) {
const hChar = node.value.arguments[0].properties.find(
(property) =>
property.type === AST_NODE_TYPES.Property &&
flagPropertyIsNamed(property, 'char') &&
property.value.type === AST_NODE_TYPES.Literal &&
property.value.value === 'o'
);
const hChar = node.value.arguments[0].properties
.filter(flagPropertyIsNamed('char'))
.find((property) => property.value.type === AST_NODE_TYPES.Literal && property.value.value === 'o');
if (hChar) {
context.report({
node: hChar,
Expand Down
30 changes: 12 additions & 18 deletions src/rules/flag-min-max-default.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Licensed under the BSD 3-Clause license.
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
import { AST_NODE_TYPES, ASTUtils } from '@typescript-eslint/utils';
import { RuleCreator } from '@typescript-eslint/utils/eslint-utils';

import { ancestorsContainsSfCommand, isInCommandDirectory } from '../shared/commands';
Expand All @@ -30,24 +30,18 @@ export const flagMinMaxDefault = RuleCreator.withoutDocs({
if (isFlag(node) && ancestorsContainsSfCommand(context)) {
if (
node.value?.type === AST_NODE_TYPES.CallExpression &&
node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression &&
// has min/max
node.value.arguments[0].properties.some(
(property) =>
property.type === AST_NODE_TYPES.Property &&
(flagPropertyIsNamed(property, 'min') || flagPropertyIsNamed(property, 'max'))
) &&
!node.value.arguments[0].properties.some(
(property) =>
property.type === AST_NODE_TYPES.Property &&
// defaultValue for DurationFlags
(flagPropertyIsNamed(property, 'default') || flagPropertyIsNamed(property, 'defaultValue'))
)
node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression
) {
context.report({
node,
messageId: 'message',
});
const props = node.value.arguments[0].properties.filter(ASTUtils.isNodeOfType(AST_NODE_TYPES.Property));
if (
props.some((p) => flagPropertyIsNamed('min')(p) || flagPropertyIsNamed('max')(p)) &&
!props.some((p) => flagPropertyIsNamed('default')(p) || flagPropertyIsNamed('defaultValue')(p))
) {
context.report({
node,
messageId: 'message',
});
}
}
}
},
Expand Down
12 changes: 4 additions & 8 deletions src/rules/flag-summary.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,8 @@ export const flagSummary = RuleCreator.withoutDocs({
ASTUtils.isNodeOfType(AST_NODE_TYPES.Property)
);

if (!propertyArguments.some((property) => flagPropertyIsNamed(property, 'summary'))) {
const descriptionProp = propertyArguments.find((property) =>
flagPropertyIsNamed(property, 'description')
);
if (!propertyArguments.some(flagPropertyIsNamed('summary'))) {
const descriptionProp = propertyArguments.find(flagPropertyIsNamed('description'));

const range = descriptionProp && 'key' in descriptionProp ? descriptionProp?.key.range : undefined;
return context.report({
Expand All @@ -55,11 +53,9 @@ export const flagSummary = RuleCreator.withoutDocs({
: {}),
});
}
if (!propertyArguments.some((property) => flagPropertyIsNamed(property, 'description'))) {
if (!propertyArguments.some(flagPropertyIsNamed('description'))) {
// if there is no description, but there is a longDescription, turn that into the description
const longDescriptionProp = propertyArguments.find((property) =>
flagPropertyIsNamed(property, 'longDescription')
);
const longDescriptionProp = propertyArguments.find(flagPropertyIsNamed('longDescription'));
if (!longDescriptionProp) {
return;
}
Expand Down
4 changes: 2 additions & 2 deletions src/rules/id-flag-suggestions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ export const idFlagSuggestions = RuleCreator.withoutDocs({
const argProps = node.value.arguments[0].properties.filter(
ASTUtils.isNodeOfType(AST_NODE_TYPES.Property)
);
const hasStartsWith = argProps.some((property) => flagPropertyIsNamed(property, 'startsWith'));
const hasLength = argProps.some((property) => flagPropertyIsNamed(property, 'length'));
const hasStartsWith = argProps.some(flagPropertyIsNamed('startsWith'));
const hasLength = argProps.some(flagPropertyIsNamed('length'));

if (!hasStartsWith || !hasLength) {
const existing = context.sourceCode.getText(node);
Expand Down
49 changes: 24 additions & 25 deletions src/rules/migration/encourage-alias-deprecation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,30 +32,29 @@ export const encourageAliasDeprecation = RuleCreator.withoutDocs({
return isInCommandDirectory(context)
? {
PropertyDefinition(node): void {
if (ancestorsContainsSfCommand(context)) {
if (node.key.type === AST_NODE_TYPES.Identifier && node.key.name === 'aliases') {
// but you don't have deprecateAliases = true then add id
if (
node.parent?.type === AST_NODE_TYPES.ClassBody &&
!node.parent.body.some(
(n) =>
n.type === AST_NODE_TYPES.PropertyDefinition &&
n.key.type === AST_NODE_TYPES.Identifier &&
n.key.name === 'deprecateAliases'
)
) {
context.report({
node,
if (
ancestorsContainsSfCommand(context) &&
node.key.type === AST_NODE_TYPES.Identifier &&
node.key.name === 'aliases' &&
node.parent?.type === AST_NODE_TYPES.ClassBody &&
!node.parent.body.some(
(n) =>
n.type === AST_NODE_TYPES.PropertyDefinition &&
n.key.type === AST_NODE_TYPES.Identifier &&
n.key.name === 'deprecateAliases'
)
) {
// but you don't have deprecateAliases = true then add id
context.report({
node,
messageId: 'command',
suggest: [
{
messageId: 'command',
suggest: [
{
messageId: 'command',
fix: (fixer) => fixer.insertTextBefore(node, 'public static readonly deprecateAliases = true;'),
},
],
});
}
}
fix: (fixer) => fixer.insertTextBefore(node, 'public static readonly deprecateAliases = true;'),
},
],
});
}
},
Property(node): void {
Expand All @@ -69,8 +68,8 @@ export const encourageAliasDeprecation = RuleCreator.withoutDocs({
ASTUtils.isNodeOfType(AST_NODE_TYPES.Property)
);

const aliasesProperty = argProps.find((property) => flagPropertyIsNamed(property, 'aliases'));
if (aliasesProperty && !argProps.some((property) => flagPropertyIsNamed(property, 'deprecateAliases'))) {
const aliasesProperty = argProps.find(flagPropertyIsNamed('aliases'));
if (aliasesProperty && !argProps.some(flagPropertyIsNamed('deprecateAliases'))) {
context.report({
node: aliasesProperty,
messageId: 'flag',
Expand Down
11 changes: 4 additions & 7 deletions src/rules/no-default-depends-on-flags.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Licensed under the BSD 3-Clause license.
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
import { AST_NODE_TYPES, ASTUtils } from '@typescript-eslint/utils';
import { RuleCreator } from '@typescript-eslint/utils/eslint-utils';
import { ancestorsContainsSfCommand, isInCommandDirectory } from '../shared/commands';
import { flagPropertyIsNamed, isFlag } from '../shared/flags';
Expand Down Expand Up @@ -33,12 +33,9 @@ export const noDefaultDependsOnFlags = RuleCreator.withoutDocs({
node.value?.type === AST_NODE_TYPES.CallExpression &&
node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression
) {
const dependsOnProperty = node.value.arguments[0].properties.find(
(property) => property.type === AST_NODE_TYPES.Property && flagPropertyIsNamed(property, 'dependsOn')
);
const defaultValueProperty = node.value.arguments[0].properties.find(
(property) => property.type === AST_NODE_TYPES.Property && flagPropertyIsNamed(property, 'default')
);
const props = node.value.arguments[0].properties.filter(ASTUtils.isNodeOfType(AST_NODE_TYPES.Property));
const dependsOnProperty = props.find(flagPropertyIsNamed('dependsOn'));
const defaultValueProperty = props.find(flagPropertyIsNamed('default'));

// @ts-expect-error from the node (flag), go up a level (parent) and find the dependsOn flag definition, see if it has a default
const dependsOnFlagDefaultValue = node.parent.properties
Expand Down
19 changes: 12 additions & 7 deletions src/rules/no-depends-on-boolean-flags.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
* Licensed under the BSD 3-Clause license.
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
import { AST_NODE_TYPES, ASTUtils } from '@typescript-eslint/utils';
import { RuleCreator } from '@typescript-eslint/utils/eslint-utils';
import { ancestorsContainsSfCommand, isInCommandDirectory } from '../shared/commands';
import { isFlag } from '../shared/flags';
import { flagPropertyIsNamed, isFlag } from '../shared/flags';

export const noDependsOnBooleanFlags = RuleCreator.withoutDocs({
meta: {
Expand All @@ -32,13 +32,18 @@ export const noDependsOnBooleanFlags = RuleCreator.withoutDocs({
node.value?.type === AST_NODE_TYPES.CallExpression &&
node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression
) {
const dependsOnFlagsProp = node.value.arguments[0].properties.find(
(p) => p.type === 'Property' && p.key.type === 'Identifier' && p.key.name === 'dependsOn'
);
const dependsOnFlagsProp = node.value.arguments[0].properties
.filter(ASTUtils.isNodeOfType(AST_NODE_TYPES.Property))
.find(flagPropertyIsNamed('dependsOn'));

if (dependsOnFlagsProp) {
// @ts-ignore we know `dependsOn` exists/is an array
const dependedOnFlags = dependsOnFlagsProp.value.elements.map((l) => l.value);
const dependedOnFlags =
'value' in dependsOnFlagsProp &&
ASTUtils.isNodeOfType(AST_NODE_TYPES.ArrayExpression)(dependsOnFlagsProp.value)
? dependsOnFlagsProp.value.elements
.filter(ASTUtils.isNodeOfType(AST_NODE_TYPES.Literal))
.map((l) => l.value)
: [];

for (const flag of dependedOnFlags) {
if (node.parent.type === 'ObjectExpression') {
Expand Down
8 changes: 4 additions & 4 deletions src/rules/no-duplicate-short-characters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export const noDuplicateShortCharacters = RuleCreator.withoutDocs({
);
// 2. has the char already been used? If so, mark the char as a problem
const charNode = flagProperties.find(
(p) => flagPropertyIsNamed(p, 'char') && p.value.type === AST_NODE_TYPES.Literal
(p) => flagPropertyIsNamed('char')(p) && p.value.type === AST_NODE_TYPES.Literal
);
if (charNode?.value.type === AST_NODE_TYPES.Literal) {
const char = charNode.value.value;
Expand All @@ -81,9 +81,9 @@ export const noDuplicateShortCharacters = RuleCreator.withoutDocs({
}

// 3. is anything in this this flag's aliases already seen (alias or char)? If so, mark that alias as a problem
const aliasesNode = flagProperties.find(
(p) => flagPropertyIsNamed(p, 'aliases') && p.value.type === AST_NODE_TYPES.ArrayExpression
);
const aliasesNode = flagProperties
.filter(flagPropertyIsNamed('aliases'))
.find((p) => p.value.type === AST_NODE_TYPES.ArrayExpression);
if (aliasesNode?.value.type === AST_NODE_TYPES.ArrayExpression) {
aliasesNode.value.elements.forEach((alias) => {
if (alias?.type === AST_NODE_TYPES.Literal)
Expand Down
6 changes: 4 additions & 2 deletions src/shared/flags.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,10 @@ export const isBaseFlagsStaticProperty = (node: TSESTree.Node): node is TSESTree
node.key.name === 'baseFlags' &&
['public', 'protected'].includes(node.accessibility);

export const flagPropertyIsNamed = (node: TSESTree.Property, name: string): node is TSESTree.Property =>
resolveFlagName(node) === name;
export const flagPropertyIsNamed =
(name: string) =>
(node: TSESTree.Property): node is TSESTree.Property =>
resolveFlagName(node) === name;

/** pass in a flag Property and it gives back the key name/value depending on type */
export const resolveFlagName = (
Expand Down
Loading