Enable more eslint rules

ark120202 · ark120202 · commit d4d27cf9a42c · 2020-03-21T18:19:43.000Z
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -73,7 +73,6 @@ module.exports = {
         "arrow-body-style": "error",
         curly: ["error", "multi-line"],
         eqeqeq: ["error", "always", { null: "ignore" }],
-        "id-match": "error",
         "no-caller": "error",
         "no-cond-assign": "error",
         "no-debugger": "error",
@@ -87,6 +86,32 @@ module.exports = {
         "prefer-const": ["error", { destructuring: "all" }],
         radix: "error",
         "use-isnan": "error",
+        "object-shorthand": [
+            "error",
+            "always",
+            { avoidQuotes: true, ignoreConstructors: false, avoidExplicitReturnArrows: true },
+        ],
+        "no-restricted-syntax": ["error", "ForInStatement", "LabeledStatement", "SequenceExpression"],
+        "spaced-comment": [
+            "error",
+            "always",
+            {
+                line: { exceptions: ["-", "+"], markers: ["=", "!", "/"] },
+                block: { exceptions: ["-", "+"], markers: ["=", "!", ":", "::"], balanced: true },
+            },
+        ],
+        "no-delete-var": ["error"],
+        "no-label-var": ["error"],
+        yoda: ["error"],
+        "prefer-destructuring": [
+            "error",
+            {
+                VariableDeclarator: { array: false, object: true },
+                AssignmentExpression: { array: false, object: false },
+            },
+            { enforceForRenamedProperties: false },
+        ],
+        "prefer-numeric-literals": ["error"],
 
         "import/no-default-export": "error",
     },
@@ -132,6 +157,7 @@ module.exports = {
         {
             files: "src/lualib/**/*.ts",
             rules: {
+                "no-restricted-syntax": ["error", "LabeledStatement", "SequenceExpression"],
                 "@typescript-eslint/no-throw-literal": "off",
                 "@typescript-eslint/prefer-optional-chain": "off",
             },
diff --git a/src/cli/parse.ts b/src/cli/parse.ts
@@ -71,12 +71,12 @@ export const optionDeclarations: CommandLineOption[] = [
 
 export function updateParsedConfigFile(parsedConfigFile: ts.ParsedCommandLine): ParsedCommandLine {
     let hasRootLevelOptions = false;
-    for (const key in parsedConfigFile.raw) {
-        const option = optionDeclarations.find(option => option.name === key);
+    for (const [name, rawValue] of Object.entries(parsedConfigFile.raw)) {
+        const option = optionDeclarations.find(option => option.name === name);
         if (!option) continue;
 
         if (parsedConfigFile.raw.tstl === undefined) parsedConfigFile.raw.tstl = {};
-        parsedConfigFile.raw.tstl[key] = parsedConfigFile.raw[key];
+        parsedConfigFile.raw.tstl[name] = rawValue;
         hasRootLevelOptions = true;
     }
 
@@ -85,16 +85,16 @@ export function updateParsedConfigFile(parsedConfigFile: ts.ParsedCommandLine):
             parsedConfigFile.errors.push(cliDiagnostics.tstlOptionsAreMovingToTheTstlObject(parsedConfigFile.raw.tstl));
         }
 
-        for (const key in parsedConfigFile.raw.tstl) {
-            const option = optionDeclarations.find(option => option.name === key);
+        for (const [name, rawValue] of Object.entries(parsedConfigFile.raw.tstl)) {
+            const option = optionDeclarations.find(option => option.name === name);
             if (!option) {
-                parsedConfigFile.errors.push(cliDiagnostics.unknownCompilerOption(key));
+                parsedConfigFile.errors.push(cliDiagnostics.unknownCompilerOption(name));
                 continue;
             }
 
-            const { error, value } = readValue(option, parsedConfigFile.raw.tstl[key]);
+            const { error, value } = readValue(option, rawValue);
             if (error) parsedConfigFile.errors.push(error);
-            if (parsedConfigFile.options[key] === undefined) parsedConfigFile.options[key] = value;
+            if (parsedConfigFile.options[name] === undefined) parsedConfigFile.options[name] = value;
         }
     }
 
diff --git a/src/lualib/Map.ts b/src/lualib/Map.ts
@@ -23,6 +23,7 @@ Map = class Map<K, V> {
                 if (result.done) {
                     break;
                 }
+                // eslint-disable-next-line prefer-destructuring
                 const value: [K, V] = result.value; // Ensures index is offset when tuple is accessed
                 this.set(value[0], value[1]);
             }
@@ -114,8 +115,7 @@ Map = class Map<K, V> {
     }
 
     public entries(): IterableIterator<[K, V]> {
-        const items = this.items;
-        const nextKey = this.nextKey;
+        const { items, nextKey } = this;
         let key = this.firstKey;
         return {
             [Symbol.iterator](): IterableIterator<[K, V]> {
@@ -130,7 +130,7 @@ Map = class Map<K, V> {
     }
 
     public keys(): IterableIterator<K> {
-        const nextKey = this.nextKey;
+        const { nextKey } = this;
         let key = this.firstKey;
         return {
             [Symbol.iterator](): IterableIterator<K> {
@@ -145,8 +145,7 @@ Map = class Map<K, V> {
     }
 
     public values(): IterableIterator<V> {
-        const items = this.items;
-        const nextKey = this.nextKey;
+        const { items, nextKey } = this;
         let key = this.firstKey;
         return {
             [Symbol.iterator](): IterableIterator<V> {
diff --git a/src/lualib/ObjectFromEntries.ts b/src/lualib/ObjectFromEntries.ts
@@ -11,6 +11,7 @@ function __TS__ObjectFromEntries<T>(
             const result = iterator.next();
             if (result.done) break;
 
+            // eslint-disable-next-line prefer-destructuring
             const value: [string, T] = result.value;
             obj[value[0]] = value[1];
         }
diff --git a/src/lualib/Set.ts b/src/lualib/Set.ts
@@ -103,7 +103,7 @@ Set = class Set<T> {
     }
 
     public entries(): IterableIterator<[T, T]> {
-        const nextKey = this.nextKey;
+        const { nextKey } = this;
         let key: T = this.firstKey;
         return {
             [Symbol.iterator](): IterableIterator<[T, T]> {
@@ -118,7 +118,7 @@ Set = class Set<T> {
     }
 
     public keys(): IterableIterator<T> {
-        const nextKey = this.nextKey;
+        const { nextKey } = this;
         let key: T = this.firstKey;
         return {
             [Symbol.iterator](): IterableIterator<T> {
@@ -133,7 +133,7 @@ Set = class Set<T> {
     }
 
     public values(): IterableIterator<T> {
-        const nextKey = this.nextKey;
+        const { nextKey } = this;
         let key: T = this.firstKey;
         return {
             [Symbol.iterator](): IterableIterator<T> {
diff --git a/src/lualib/WeakMap.ts b/src/lualib/WeakMap.ts
@@ -17,6 +17,7 @@ WeakMap = class WeakMap<K extends object, V> {
                 if (result.done) {
                     break;
                 }
+                // eslint-disable-next-line prefer-destructuring
                 const value: [K, V] = result.value; // Ensures index is offset when tuple is accessed
                 this.items.set(value[0], value[1]);
             }
diff --git a/src/transformation/builtins/array.ts b/src/transformation/builtins/array.ts
@@ -9,7 +9,7 @@ export function transformArrayPrototypeCall(
     context: TransformationContext,
     node: PropertyCallExpression
 ): lua.CallExpression | undefined {
-    const expression = node.expression;
+    const { expression } = node;
     const signature = context.checker.getResolvedSignature(node);
     const params = transformArguments(context, node.arguments, signature);
     const caller = context.transformExpression(expression.expression);
diff --git a/src/transformation/builtins/function.ts b/src/transformation/builtins/function.ts
@@ -9,7 +9,7 @@ export function transformFunctionPrototypeCall(
     context: TransformationContext,
     node: PropertyCallExpression
 ): lua.CallExpression | undefined {
-    const expression = node.expression;
+    const { expression } = node;
     const callerType = context.checker.getTypeAtLocation(expression.expression);
     if (getFunctionContextType(context, callerType) === ContextType.Void) {
         context.diagnostics.push(unsupportedSelfFunctionConversion(node));
diff --git a/src/transformation/builtins/global.ts b/src/transformation/builtins/global.ts
@@ -12,7 +12,7 @@ export function transformGlobalCall(
     const signature = context.checker.getResolvedSignature(node);
     const parameters = transformArguments(context, node.arguments, signature);
     const expressionType = context.checker.getTypeAtLocation(node.expression);
-    const name = expressionType.symbol.name;
+    const { name } = expressionType.symbol;
     switch (name) {
         case "SymbolConstructor":
             return transformLuaLibFunction(context, LuaLibFeature.Symbol, node, ...parameters);
diff --git a/src/transformation/builtins/math.ts b/src/transformation/builtins/math.ts
@@ -34,7 +34,7 @@ export function transformMathCall(
     context: TransformationContext,
     node: PropertyCallExpression
 ): lua.Expression | undefined {
-    const expression = node.expression;
+    const { expression } = node;
     const signature = context.checker.getResolvedSignature(node);
     const params = transformArguments(context, node.arguments, signature);
 
diff --git a/src/transformation/builtins/number.ts b/src/transformation/builtins/number.ts
@@ -8,7 +8,7 @@ export function transformNumberPrototypeCall(
     context: TransformationContext,
     node: PropertyCallExpression
 ): lua.Expression | undefined {
-    const expression = node.expression;
+    const { expression } = node;
     const signature = context.checker.getResolvedSignature(node);
     const params = transformArguments(context, node.arguments, signature);
     const caller = context.transformExpression(expression.expression);
diff --git a/src/transformation/builtins/object.ts b/src/transformation/builtins/object.ts
@@ -32,7 +32,7 @@ export function transformObjectPrototypeCall(
     context: TransformationContext,
     node: PropertyCallExpression
 ): lua.Expression | undefined {
-    const expression = node.expression;
+    const { expression } = node;
     const signature = context.checker.getResolvedSignature(node);
 
     const name = expression.name.text;
diff --git a/src/transformation/builtins/string.ts b/src/transformation/builtins/string.ts
@@ -19,7 +19,7 @@ export function transformStringPrototypeCall(
     context: TransformationContext,
     node: PropertyCallExpression
 ): lua.Expression | undefined {
-    const expression = node.expression;
+    const { expression } = node;
     const signature = context.checker.getResolvedSignature(node);
     const params = transformArguments(context, node.arguments, signature);
     const caller = context.transformExpression(expression.expression);
@@ -118,7 +118,7 @@ export function transformStringConstructorCall(
     context: TransformationContext,
     node: PropertyCallExpression
 ): lua.Expression | undefined {
-    const expression = node.expression;
+    const { expression } = node;
     const signature = context.checker.getResolvedSignature(node);
     const params = transformArguments(context, node.arguments, signature);
 
diff --git a/src/transformation/utils/annotations.ts b/src/transformation/utils/annotations.ts
@@ -76,7 +76,7 @@ export function getFileAnnotations(sourceFile: ts.SourceFile): AnnotationsMap {
 
     if (sourceFile.statements.length > 0) {
         // Manually collect jsDoc because `getJSDocTags` includes tags only from closest comment
-        const jsDoc = sourceFile.statements[0].jsDoc;
+        const { jsDoc } = sourceFile.statements[0];
         if (jsDoc) {
             for (const tag of jsDoc.flatMap(x => x.tags ?? [])) {
                 const tagName = tag.tagName.text;
diff --git a/src/transformation/visitors/call.ts b/src/transformation/visitors/call.ts
@@ -128,7 +128,7 @@ export function transformContextualCallExpression(
             transformedArguments.unshift(lua.createIdentifier("____self"));
 
             // Cache left-side if it has effects
-            //(function() local ____self = context; return ____self[argument](parameters); end)()
+            // (function() local ____self = context; return ____self[argument](parameters); end)()
             const argument = ts.isElementAccessExpression(left)
                 ? transformElementAccessArgument(context, left)
                 : lua.createStringLiteral(left.name.text);
diff --git a/src/transformation/visitors/class/decorators.ts b/src/transformation/visitors/class/decorators.ts
@@ -16,13 +16,13 @@ export function createConstructorDecorationStatement(
             ? addExportToIdentifier(context, transformIdentifier(context, declaration.name))
             : lua.createAnonymousIdentifier();
 
-    const decorators = declaration.decorators;
+    const { decorators } = declaration;
     if (!decorators) {
         return undefined;
     }
 
     const decoratorExpressions = decorators.map(decorator => {
-        const expression = decorator.expression;
+        const { expression } = decorator;
         const type = context.checker.getTypeAtLocation(expression);
         const callContext = getFunctionContextType(context, type);
         if (callContext === ContextType.Void) {
diff --git a/src/transformation/visitors/generator.ts b/src/transformation/visitors/generator.ts
@@ -89,12 +89,12 @@ export function transformGeneratorFunctionBody(
     const block = [
         coroutine,
         iterator,
-        //____it[Symbol.iterator] = {return ____it}
+        // ____it[Symbol.iterator] = {return ____it}
         lua.createAssignmentStatement(
             lua.createTableIndexExpression(itIdentifier, symbolIterator),
             lua.createFunctionExpression(lua.createBlock([lua.createReturnStatement([itIdentifier])]))
         ),
-        //return ____it
+        // return ____it
         lua.createReturnStatement([itIdentifier]),
     ];
 
diff --git a/src/transformation/visitors/identifier.ts b/src/transformation/visitors/identifier.ts
@@ -30,7 +30,7 @@ export const transformIdentifierExpression: FunctionVisitor<ts.Identifier> = (no
     if (symbol) {
         const exportScope = getSymbolExportScope(context, symbol);
         if (exportScope) {
-            const name = symbol.name;
+            const { name } = symbol;
             const text = hasUnsafeIdentifierName(context, node) ? createSafeName(name) : name;
             const symbolId = getIdentifierSymbolId(context, node);
             const identifier = lua.createIdentifier(text, node, symbolId, name);
diff --git a/src/transformation/visitors/modules/import.ts b/src/transformation/visitors/modules/import.ts
@@ -18,8 +18,10 @@ const getAbsoluteImportPath = (relativePath: string, directoryPath: string, opti
         : path.resolve(directoryPath, relativePath);
 
 function getImportPath(context: TransformationContext, relativePath: string, node: ts.Node): string {
-    const fileName = context.sourceFile.fileName;
-    const options = context.options;
+    const {
+        options,
+        sourceFile: { fileName },
+    } = context;
     const rootDir = options.rootDir ? path.resolve(options.rootDir) : path.resolve(".");
 
     const absoluteImportPath = path.format(
diff --git a/src/transformation/visitors/template.ts b/src/transformation/visitors/template.ts
@@ -27,7 +27,7 @@ export const transformTemplateExpression: FunctionVisitor<ts.TemplateExpression>
         const expression = context.transformExpression(span.expression);
         parts.push(wrapInToStringForConcat(expression));
 
-        const text = span.literal.text;
+        const { text } = span.literal;
         if (text.length > 0) {
             parts.push(lua.createStringLiteral(text, span.literal));
         }
diff --git a/src/transpilation/index.ts b/src/transpilation/index.ts
@@ -49,9 +49,9 @@ export function createVirtualProgram(input: Record<string, string>, options: Com
         readFile: () => "",
         getNewLine: () => "\n",
         useCaseSensitiveFileNames: () => false,
-        writeFile: () => {},
+        writeFile() {},
 
-        getSourceFile: filename => {
+        getSourceFile(filename) {
             if (filename in input) {
                 return ts.createSourceFile(filename, input[filename], ts.ScriptTarget.Latest, false);
             }
diff --git a/test/transpile/plugins/printer.ts b/test/transpile/plugins/printer.ts
@@ -1,7 +1,7 @@
 import * as tstl from "../../../src";
 
 const plugin: tstl.Plugin = {
-    printer: (program, emitHost, fileName, ...args) => {
+    printer(program, emitHost, fileName, ...args) {
         const result = new tstl.LuaPrinter(program.getCompilerOptions(), emitHost, fileName).print(...args);
         result.code = `-- Plugin\n${result.code}`;
         return result;
diff --git a/test/transpile/plugins/visitor-super.ts b/test/transpile/plugins/visitor-super.ts
@@ -3,7 +3,7 @@ import * as tstl from "../../../src";
 
 const plugin: tstl.Plugin = {
     visitors: {
-        [ts.SyntaxKind.StringLiteral]: (node, context) => {
+        [ts.SyntaxKind.StringLiteral](node, context) {
             const result = context.superTransformExpression(node);
 
             if (tstl.isStringLiteral(result)) {
diff --git a/test/util.ts b/test/util.ts
@@ -487,7 +487,7 @@ const createTestBuilderFactory = <T extends TestBuilder>(
     let tsCode: string;
     if (typeof args[0] === "string") {
         expect(serializeSubstitutions).toBe(false);
-        tsCode = args[0];
+        [tsCode] = args;
     } else {
         let [raw, ...substitutions] = args;
         if (serializeSubstitutions) {

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ function __TS__ObjectFromEntries<T>(`
`11`	`11`	`const result = iterator.next();`
`12`	`12`	`if (result.done) break;`
`13`	`13`
	`14`	`+ // eslint-disable-next-line prefer-destructuring`
`14`	`15`	`const value: [string, T] = result.value;`
`15`	`16`	`obj[value[0]] = value[1];`
`16`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ WeakMap = class WeakMap<K extends object, V> {`
`17`	`17`	`if (result.done) {`
`18`	`18`	`break;`
`19`	`19`	`}`
	`20`	`+ // eslint-disable-next-line prefer-destructuring`
`20`	`21`	`const value: [K, V] = result.value; // Ensures index is offset when tuple is accessed`
`21`	`22`	`this.items.set(value[0], value[1]);`
`22`	`23`	`}`