Add eslint

yeonjuan · yeonjuan · commit 9224e2cd029a · 2022-09-05T22:13:35.000+09:00
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,6 @@
+**/*.html
+coverage
+yarn.lock
+dist
+node_modules
+**/*.js
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,20 @@
+module.exports = {
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  root: true,
+  rules: {
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/no-non-null-asserted-optional-chain": "off",
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/no-explicit-any": "off",
+  },
+  overrides: [
+    {
+      files: ["**/__tests__/**/*.ts"],
+      rules: {
+        "@typescript-eslint/no-explicit-any": "off",
+      },
+    },
+  ],
+};
diff --git a/package.json b/package.json
@@ -8,16 +8,20 @@
     "test": "jest --coverage",
     "format": "prettier --write .",
     "build": "rimraf dist && tsc -b tsconfig.build.json",
+    "check:lint": "eslint src",
     "check:ts": "tsc --noEmit",
     "check:format": "prettier --list-different .",
-    "prepublish": "yarn check:ts && yarn check:format && yarn build"
+    "prepublish": "yarn check:lint && yarn check:ts && yarn check:format && yarn build"
   },
   "devDependencies": {
     "@types/jest": "^28.1.7",
+    "@typescript-eslint/eslint-plugin": "^5.36.1",
+    "@typescript-eslint/parser": "^5.36.1",
+    "eslint": "^8.23.0",
     "jest": "^28.1.3",
     "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
     "ts-jest": "^28.0.8",
-    "typescript": "^4.7.4"
+    "typescript": "^4.8.2"
   }
 }
diff --git a/src/constants/node-types.ts b/src/constants/node-types.ts
@@ -1,5 +1,3 @@
-import { TokenTypes } from "./token-types";
-
 export enum NodeTypes {
   Document = "Document",
   Tag = "Tag",
diff --git a/src/tokenizer/handlers/style-tag-content.ts b/src/tokenizer/handlers/style-tag-content.ts
@@ -4,11 +4,7 @@ import {
   TokenTypes,
 } from "../../constants";
 import { Range, Token, TokenizerState } from "../../types";
-import {
-  calculateTokenLocation,
-  calculateTokenPosition,
-  getLineInfo,
-} from "../../utils";
+import { calculateTokenLocation, calculateTokenPosition } from "../../utils";
 
 const CLOSING_STYLE_TAG_PATTERN = /<\/style\s*>/i;
 
diff --git a/src/tokenizer/tokenize.ts b/src/tokenizer/tokenize.ts
@@ -47,7 +47,7 @@ const contextHandlers: Record<TokenizerContextTypes, TokenizeHandler> = {
 function tokenizeChars(
   chars: string,
   state: TokenizerState,
-  tokens: any[],
+  tokens: Token[],
   {
     isFinalChunk,
     positionOffset,
@@ -108,7 +108,7 @@ export function tokenize(
   }
 
   const chars = state.decisionBuffer + source;
-  const tokens: any[] = [];
+  const tokens: Token[] = [];
   const positionOffset = state.caretPosition - state.decisionBuffer.length;
 
   tokenizeChars(chars, state, tokens, {
diff --git a/src/tree-constructor/__tests__/__output__/attributes-empty.ts b/src/tree-constructor/__tests__/__output__/attributes-empty.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 100],
diff --git a/src/tree-constructor/__tests__/__output__/custom-elements.ts b/src/tree-constructor/__tests__/__output__/custom-elements.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 88],
diff --git a/src/tree-constructor/__tests__/__output__/doctypes.ts b/src/tree-constructor/__tests__/__output__/doctypes.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 304],
diff --git a/src/tree-constructor/__tests__/__output__/nested-tags.ts b/src/tree-constructor/__tests__/__output__/nested-tags.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 89],
diff --git a/src/tree-constructor/__tests__/__output__/opening-closing-text.ts b/src/tree-constructor/__tests__/__output__/opening-closing-text.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 40],
diff --git a/src/tree-constructor/__tests__/__output__/script-elements-attributes.ts b/src/tree-constructor/__tests__/__output__/script-elements-attributes.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 308],
diff --git a/src/tree-constructor/__tests__/__output__/script-elements.ts b/src/tree-constructor/__tests__/__output__/script-elements.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 84],
diff --git a/src/tree-constructor/__tests__/__output__/style-elements-attributes.ts b/src/tree-constructor/__tests__/__output__/style-elements-attributes.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 229],
diff --git a/src/tree-constructor/__tests__/__output__/style-elements.ts b/src/tree-constructor/__tests__/__output__/style-elements.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 168],
diff --git a/src/tree-constructor/__tests__/__output__/tags-register.ts b/src/tree-constructor/__tests__/__output__/tags-register.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 198],
diff --git a/src/tree-constructor/__tests__/__output__/void-tags.ts b/src/tree-constructor/__tests__/__output__/void-tags.ts
@@ -1,5 +1,3 @@
-import { NodeTypes } from "../../../constants";
-
 export default {
   type: "Document",
   range: [0, 16],
diff --git a/src/tree-constructor/__tests__/construct-tree.spec.ts b/src/tree-constructor/__tests__/construct-tree.spec.ts
@@ -76,7 +76,7 @@ describe("construct-tree", () => {
     ],
     ["Tag register", TAGS_REGISTER_INPUT, TAGS_REGISTERS_OUTPUT],
     ["Empty", EMPTY_INPUT, EMPTY_OUTPUT],
-  ])("%s", (name: string, inputTokens: any[], output: any) => {
+  ])("%s", (name: string, inputTokens: any, output: any) => {
     const { ast } = constructTree(inputTokens, undefined);
     expect(clearParent(ast)).toEqual(output);
   });
diff --git a/src/tree-constructor/construct-tree.ts b/src/tree-constructor/construct-tree.ts
@@ -88,8 +88,6 @@ function processTokens(
   let tokenIndex = state.caretPosition - positionOffset;
   while (tokenIndex < tokens.length) {
     const token = tokens[tokenIndex];
-    // debugger;
-    // @ts-ignore
     const handler = contextHandlers[state.currentContext.type].construct;
     state = handler(token, state);
     tokenIndex = state.caretPosition - positionOffset;
diff --git a/src/tree-constructor/handlers/tag.ts b/src/tree-constructor/handlers/tag.ts
@@ -1,7 +1,6 @@
 import { ConstructTreeContextTypes, TokenTypes } from "../../constants";
 import { ConstructTreeState, Token } from "../../types";
 import { createNodeFrom, updateNodeEnd } from "../../utils";
-import { cloneLocation } from "../../utils/clone-location";
 
 const ATTRIBUTE_START_TOKENS = [
   TokenTypes.AttributeKey,
diff --git a/src/types/construct-tree-state.ts b/src/types/construct-tree-state.ts
@@ -6,7 +6,7 @@ export type ConstructTreeState<CurNode = any> = {
   currentContext: {
     type: ConstructTreeContextTypes;
     parentRef?: any;
-    content?: any;
+    content?: any[];
   };
   currentNode: CurNode;
   rootNode: DocumentNode;
diff --git a/src/types/temp-node.ts b/src/types/temp-node.ts
@@ -5,6 +5,7 @@ import {
   ScriptNode,
   StyleNode,
   TagNode,
+  DocumentNode,
 } from "./node";
 
 type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
@@ -27,3 +28,4 @@ export type TempTagNode = TempNode<
   TagNode,
   "close" | "selfClosing" | "name" | "openEnd" | "openStart"
 >;
+export type TempDocumentNode = TempNode<DocumentNode>;
diff --git a/src/types/tokenizer-context-handler.ts b/src/types/tokenizer-context-handler.ts
@@ -1,6 +1,7 @@
+import { Token } from "./token";
 import { TokenizerState } from "./tokenizer-state";
 
 export interface TokenizeHandler {
-  parse(chars: string, state: TokenizerState, tokens: any[]): void;
-  handleContentEnd?: (state: TokenizerState, tokens: any[]) => void;
+  parse(chars: string, state: TokenizerState, tokens: Token[]): void;
+  handleContentEnd?: (state: TokenizerState, tokens: Token[]) => void;
 }
diff --git a/src/utils/calculate-token-location.ts b/src/utils/calculate-token-location.ts
@@ -1,4 +1,4 @@
-import { Range, TokenizerState } from "../types";
+import { Range } from "../types";
 import { getLineInfo } from "./get-line-info";
 
 export function calculateTokenLocation(source: string, range: Range) {
diff --git a/src/utils/clear-parent.ts b/src/utils/clear-parent.ts
@@ -1,4 +1,6 @@
-export function clearParent(ast: any) {
+import { TempDocumentNode } from "../types";
+
+export function clearParent(ast: TempDocumentNode) {
   const cleanAst = ast;
 
   delete cleanAst.parentRef;
diff --git a/src/utils/get-line-info.ts b/src/utils/get-line-info.ts
@@ -5,7 +5,7 @@ function isNewLine(code: number) {
 }
 function nextLineBreak(code: string, from: number, end = code.length) {
   for (let i = from; i < end; i++) {
-    let next = code.charCodeAt(i);
+    const next = code.charCodeAt(i);
     if (isNewLine(next))
       return i < end - 1 && next === 13 && code.charCodeAt(i + 1) === 10
         ? i + 2
@@ -16,7 +16,7 @@ function nextLineBreak(code: string, from: number, end = code.length) {
 
 export function getLineInfo(input: string, offset: number) {
   for (let line = 1, cur = 0; ; ) {
-    let nextBreak = nextLineBreak(input, cur, offset);
+    const nextBreak = nextLineBreak(input, cur, offset);
     if (nextBreak < 0) return { line, column: offset - cur };
     ++line;
     cur = nextBreak;
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-import { TokenTypes } from "./token-types";`
`2`		`-`
`3`	`1`	`export enum NodeTypes {`
`4`	`2`	`Document = "Document",`
`5`	`3`	`Tag = "Tag",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-import { NodeTypes } from "../../../constants";`
`2`		`-`
`3`	`1`	`export default {`
`4`	`2`	`type: "Document",`
`5`	`3`	`range: [0, 100],`