Skip to content

Implement variable-name rule converter #222

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

Merged
merged 6 commits into from
Oct 10, 2019
Merged

Implement variable-name rule converter #222

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
583ed43
Implement variable-name converter
Oct 6, 2019
4b58c1b
Feedback changes
Oct 6, 2019
14fa169
Add more test cases
Oct 6, 2019
2b91029
Merge branch 'master' into enhancement/variable-name-converter
Oct 7, 2019
b54afee
Set const values to improve readability and order converters rules
Oct 7, 2019
1c692c9
Optimize rules array on variable name
Oct 7, 2019
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
3 changes: 2 additions & 1 deletion src/rules/converters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ import { convertUnifiedSignatures } from "./converters/unified-signatures";
import { convertUnnecessaryBind } from "./converters/unnecessary-bind";
import { convertUnnecessaryConstructor } from "./converters/unnecessary-constructor";
import { convertUseIsnan } from "./converters/use-isnan";
import { convertVariableName } from "./converters/variable-name";
import { convertQuotemark } from "./converters/quotemark";
import { convertTripleEquals } from "./converters/triple-equals";

Expand Down Expand Up @@ -227,6 +228,7 @@ export const converters = new Map([
["unnecessary-bind", convertUnnecessaryBind],
["unnecessary-constructor", convertUnnecessaryConstructor],
["use-isnan", convertUseIsnan],
["variable-name", convertVariableName],

// These converters are all for rules that need more complex option conversions.
// Some of them will likely need to have notices about changed lint behaviors...
Expand All @@ -240,7 +242,6 @@ export const converters = new Map([
// ["no-shadowed-variable", convertNoShadowedVariable], // no-shadow
// ["no-unused-expression", convertNoUnusedExpression], // no-unused-expressions
// ["space-within-parens", convertSpaceWithinParens], // space-in-parens
// ["variable-name", convertVariableName], // a bunch of rules...

// tslint-microsoft-contrib rules:
// ["max-func-body-length", convertMaxFuncBodyLength],
Expand Down
261 changes: 261 additions & 0 deletions src/rules/converters/tests/variable-name.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
import { convertVariableName } from "../variable-name";

describe(convertVariableName, () => {
test("conversion without arguments", () => {
const result = convertVariableName({
ruleArguments: [],
});

expect(result).toEqual({
rules: [
{
ruleName: "camelcase",
ruleArguments: [],
notices: [
"By default, this rule looks for any underscores (_) located within the source code. It ignores leading and trailing underscores and only checks those in the middle of a variable name.",
],
},
{
ruleName: "no-underscore-dangle",
ruleArguments: [],
notices: [
'By default, "no-underscore-dangle" will disallows dangling underscores in identifiers.',
],
},
{
ruleName: "id-blacklist",
ruleArguments: [],
notices: [],
},
{
ruleName: "id-match",
},
],
});
});

test("conversion with require-const-for-all-caps argument", () => {
const result = convertVariableName({
ruleArguments: ["require-const-for-all-caps"],
});

expect(result).toEqual({
rules: [
{
ruleName: "camelcase",
ruleArguments: [],
notices: [
"By default, this rule looks for any underscores (_) located within the source code. It ignores leading and trailing underscores and only checks those in the middle of a variable name.",
'The argument "require-const-for-all-caps" is not needed as ESlint will decide if a variable is a constant (all uppercase). If not, a warning will be thrown.',
],
},
{
ruleName: "no-underscore-dangle",
ruleArguments: [],
notices: [
'By default, "no-underscore-dangle" will disallows dangling underscores in identifiers.',
],
},
{
ruleName: "id-blacklist",
ruleArguments: [],
notices: [],
},
{
ruleName: "id-match",
},
],
});
});

test("conversion with allow-pascal-case argument", () => {
const result = convertVariableName({
ruleArguments: ["allow-pascal-case"],
});

expect(result).toEqual({
rules: [
{
ruleName: "camelcase",
ruleArguments: [],
notices: [
"By default, this rule looks for any underscores (_) located within the source code. It ignores leading and trailing underscores and only checks those in the middle of a variable name.",
"This rule does not allow pascal neither snake case to variable names. Those are reserved for class names and static methods.",
],
},
{
ruleName: "no-underscore-dangle",
ruleArguments: [],
notices: [
'By default, "no-underscore-dangle" will disallows dangling underscores in identifiers.',
],
},
{
ruleName: "id-blacklist",
ruleArguments: [],
notices: [],
},
{
ruleName: "id-match",
},
],
});
});

test("conversion with allow-snake-case argument", () => {
const result = convertVariableName({
ruleArguments: ["allow-snake-case"],
});

expect(result).toEqual({
rules: [
{
ruleName: "camelcase",
ruleArguments: [],
notices: [
"By default, this rule looks for any underscores (_) located within the source code. It ignores leading and trailing underscores and only checks those in the middle of a variable name.",
"This rule does not allow pascal neither snake case to variable names. Those are reserved for class names and static methods.",
],
},
{
ruleName: "no-underscore-dangle",
ruleArguments: [],
notices: [
'By default, "no-underscore-dangle" will disallows dangling underscores in identifiers.',
],
},
{
ruleName: "id-blacklist",
ruleArguments: [],
notices: [],
},
{
ruleName: "id-match",
},
],
});
});

test("conversion with allow-leading-underscore without check-format argument", () => {
const result = convertVariableName({
ruleArguments: ["allow-leading-underscore"],
});

expect(result).toEqual({
rules: [
{
ruleName: "camelcase",
ruleArguments: [],
notices: [
"By default, this rule looks for any underscores (_) located within the source code. It ignores leading and trailing underscores and only checks those in the middle of a variable name.",
],
},
{
ruleName: "no-underscore-dangle",
ruleArguments: [],
notices: [
'By default, "no-underscore-dangle" will disallows dangling underscores in identifiers.',
],
},
{
ruleName: "id-blacklist",
ruleArguments: [],
notices: [],
},
{
ruleName: "id-match",
},
],
});
});

test("conversion with allow-leading-underscore with check-format argument", () => {
const result = convertVariableName({
ruleArguments: ["check-format", "allow-leading-underscore"],
});

expect(result).toEqual({
rules: [
{
ruleName: "camelcase",
ruleArguments: [],
notices: [
"By default, this rule looks for any underscores (_) located within the source code. It ignores leading and trailing underscores and only checks those in the middle of a variable name.",
],
},
{
ruleName: "no-underscore-dangle",
ruleArguments: ["off"],
notices: [
'By default, "no-underscore-dangle" will disallows dangling underscores in identifiers.',
'If either "allow-leading-underscore" or "allow-trailing-underscore" are provided, "no-underscore-dangle" will be turned off.',
],
},
{
ruleName: "id-blacklist",
ruleArguments: [],
notices: [],
},
{
ruleName: "id-match",
},
],
});
});

test("conversion with all arguments", () => {
const result = convertVariableName({
ruleArguments: [
"check-format",
"allow-leading-underscore",
"allow-pascal-case",
"allow-snake-case",
"allow-trailing-underscore",
"require-const-for-all-caps",
"ban-keywords",
],
});

expect(result).toEqual({
rules: [
{
ruleName: "camelcase",
ruleArguments: [],
notices: [
"By default, this rule looks for any underscores (_) located within the source code. It ignores leading and trailing underscores and only checks those in the middle of a variable name.",
'The argument "require-const-for-all-caps" is not needed as ESlint will decide if a variable is a constant (all uppercase). If not, a warning will be thrown.',
"This rule does not allow pascal neither snake case to variable names. Those are reserved for class names and static methods.",
],
},
{
ruleName: "no-underscore-dangle",
ruleArguments: ["off"],
notices: [
'By default, "no-underscore-dangle" will disallows dangling underscores in identifiers.',
'If either "allow-leading-underscore" or "allow-trailing-underscore" are provided, "no-underscore-dangle" will be turned off.',
],
},
{
ruleName: "id-blacklist",
ruleArguments: [
"any",
"Number",
"number",
"String",
"string",
"Boolean",
"boolean",
"Undefined",
"undefined",
],
notices: [
'If "ban-keywords" was provided, ESLint has to disallows the use of certain TypeScript keywords by using "id-blacklist" rule.',
],
},
{
ruleName: "id-match",
},
],
});
});
});
Loading