Merge pull request #59 from lars-reimann/strict_linting

Add custom configuration for ESLint
Safe-DS · Jun 18, 2021 · c90b935 · c90b935
2 parents 7652a04 + 7a46e7a
commit c90b935
Show file tree

Hide file tree

Showing 34 changed files with 267 additions and 233 deletions.
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/client/.eslintignore b/client/.eslintignore
@@ -0,0 +1,2 @@
+build
+node_modules
diff --git a/client/.eslintrc.js b/client/.eslintrc.js
@@ -0,0 +1,29 @@
+// eslint-disable-next-line no-undef
+module.exports = {
+    root: true,
+    parser: "@typescript-eslint/parser",
+    plugins: [
+        "@typescript-eslint",
+    ],
+    extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+    ],
+    rules: {
+        "eol-last": [
+            "warn",
+            "always"
+        ],
+        "no-extra-semi": "warn",
+        "semi": [
+            "warn",
+            "always"
+        ],
+        "@typescript-eslint/no-this-alias": [
+            "error",
+            {
+                "allowedNames": ["current"]
+            }
+        ]
+    }
+};
diff --git a/client/package.json b/client/package.json
@@ -20,12 +20,6 @@
     "predeploy": "yarn run build",
     "deploy": "gh-pages -d build"
   },
-  "eslintConfig": {
-    "extends": [
-      "react-app",
-      "react-app/jest"
-    ]
-  },
   "browserslist": {
     "production": [
       ">0.2%",

diff --git a/client/src/Components/App/App.tsx b/client/src/Components/App/App.tsx
@@ -3,11 +3,12 @@ import './App.css';
 import ParameterView from "../ParameterView/ParameterView";
 import TreeView from "../TreeView/TreeView";
 import PythonFunction from "../../model/PythonFunction";
+import PythonParameter from "../../model/PythonParameter";
 
-function App() {
+function App(): JSX.Element {
 
-    const [parameters, setParameters] = useState([]);
-    const [selection, setSelection] = useState([]);
+    const [parameters, setParameters] = useState<PythonParameter[]>([]);
+    const [selection, setSelection] = useState<string[]>([]);
     const [selectedFunction, setSelectedFunction] = useState<Nullable<PythonFunction>>(null);
 
     return (

diff --git a/client/src/Components/ParameterView/DocumentationText.tsx b/client/src/Components/ParameterView/DocumentationText.tsx
@@ -4,8 +4,11 @@ import ReactMarkdown from "react-markdown";
 import remarkGfm from "remark-gfm";
 import classNames from "classnames";
 
-// @ts-ignore
-const DocumentationText = ({inputText = ""}) => {
+type DocumentationTextProps = {
+    inputText: string
+}
+
+export default function DocumentationText({inputText = ""}: DocumentationTextProps): JSX.Element {
 
     const shortenedText = inputText.split("\n\n")[0];
     const hasMultipleLines = shortenedText !== inputText;
@@ -21,7 +24,7 @@ const DocumentationText = ({inputText = ""}) => {
 
     return (
         <div className="docu-paragraph" onClick={() => {
-            setReadMore(!readMore)
+            setReadMore(!readMore);
         }}>
             {!readMore && hasMultipleLines && "▶"}
             {readMore && hasMultipleLines && "▼"}
@@ -30,6 +33,4 @@ const DocumentationText = ({inputText = ""}) => {
 
         </div>
     );
-};
-
-export default DocumentationText;
+}
diff --git a/client/src/Components/ParameterView/ParameterNode.tsx b/client/src/Components/ParameterView/ParameterNode.tsx
@@ -6,7 +6,7 @@ import { Dropdown } from "react-bootstrap";
 
 type ParameterProps = {inputParameter: PythonParameter}
 
-const ParameterNode = ({inputParameter}: ParameterProps) => {
+export default function ParameterNode({inputParameter}: ParameterProps): JSX.Element {
 
     const hasDescription = !!inputParameter.description;
 
@@ -35,7 +35,4 @@ const ParameterNode = ({inputParameter}: ParameterProps) => {
 
         </div>
     );
-};
-
-export default ParameterNode;
-
+}
diff --git a/client/src/Components/ParameterView/ParameterView.tsx b/client/src/Components/ParameterView/ParameterView.tsx
@@ -10,40 +10,37 @@ type ParameterViewProps = {
     selectedFunction: Nullable<PythonFunction>
 };
 
-const ParameterView = ({inputParameters, selection, selectedFunction}: ParameterViewProps) => {
+export default function ParameterView({inputParameters, selection, selectedFunction}: ParameterViewProps): JSX.Element {
 
     const hasInputParameters = inputParameters.length > 0;
 
     return (
         <div className="parameter-view">
-            <div className="parameter-view-path" >
-                { selection.length > 0 ?
+            <div className="parameter-view-path">
+                {selection.length > 0 ?
                     // eslint-disable-next-line
                     selection.map<React.ReactNode>(n => <a href="#">{n}</a>)
-                             .reduce((p, c) => [p, (<span> / </span>), c]) :
-                    "" }
+                        .reduce((p, c) => [p, (<span> / </span>), c]) :
+                    ""}
             </div>
-            { selectedFunction !== null &&
-                <>
-                    <h1>{selectedFunction.name}</h1>
-                    <DocumentationText inputText={selectedFunction.description} />
-                </>
+            {selectedFunction !== null &&
+            <>
+                <h1>{selectedFunction.name}</h1>
+                <DocumentationText inputText={selectedFunction.description}/>
+            </>
             }
 
             <h2 className={"parameter-title"}>Parameters</h2>
             {
                 inputParameters?.map(function (parameters) {
-                    return (<ParameterNode key={parameters.name} inputParameter={parameters} />)
+                    return (<ParameterNode key={parameters.name} inputParameter={parameters}/>);
                 })
             }
             {
                 !hasInputParameters &&
-                    <span>There are no Parameters.</span>
+                <span>There are no Parameters.</span>
             }
 
         </div>
-    )
-};
-
-export default ParameterView;
-
+    );
+}
diff --git a/client/src/Components/Tree/ClassNode.tsx b/client/src/Components/Tree/ClassNode.tsx
@@ -4,26 +4,26 @@ import classNames from "classnames";
 import FunctionNode from "./FunctionNode";
 import {isEmptyList} from "../../util/listOperations";
 import PythonFunction from "../../model/PythonFunction";
+import PythonParameter from "../../model/PythonParameter";
 
 type ClassNodeProps = {
     parentPath: string[],
     pythonClass: PythonClass,
     selection: string[],
     setSelection: (newValue: string[]) => void,
     moduleName: string,
-    setParameters: any,
+    setParameters: Setter<PythonParameter[]>,
     setSelectedFunction: Setter<Nullable<PythonFunction>>
 }
 
-const ClassNode = ({
-                       parentPath,
-                       pythonClass,
-                       selection,
-                       setSelection,
-                       moduleName,
-                       setParameters,
-                       setSelectedFunction
-                   }: ClassNodeProps) => {
+export default function ClassNode({
+                                      parentPath,
+                                      pythonClass,
+                                      selection,
+                                      setSelection,
+                                      setParameters,
+                                      setSelectedFunction
+                                  }: ClassNodeProps): JSX.Element {
 
     const [childVisible, setChildVisibility] = useState(false);
     const hasMethods = !isEmptyList(pythonClass.methods);
@@ -66,6 +66,4 @@ const ClassNode = ({
             </div>}
         </div>
     );
-};
-
-export default ClassNode;
+}
diff --git a/client/src/Components/Tree/FunctionNode.tsx b/client/src/Components/Tree/FunctionNode.tsx
@@ -2,30 +2,31 @@ import React from "react";
 import PythonFunction from "../../model/PythonFunction";
 import classNames from "classnames";
 import {isEmptyList} from "../../util/listOperations";
+import PythonParameter from "../../model/PythonParameter";
 
 type FunctionNodeProps = {
     pythonFunction: PythonFunction,
     selection: string[],
     setSelection: (newValue: string[]) => void,
-    setParameters: any,
+    setParameters: Setter<PythonParameter[]>,
     isMethod?: boolean,
 
     /** A parent of a Python class can be a class or a Python module. */
     parentPath: string[],
     setSelectedFunction: Setter<Nullable<PythonFunction>>
 }
 
-const FunctionNode = ({
+export default function FunctionNode({
                           pythonFunction,
                           selection,
                           setSelection,
                           setParameters,
                           parentPath,
                           isMethod = false,
                           setSelectedFunction
-                      }: FunctionNodeProps) => {
+                      }: FunctionNodeProps): JSX.Element {
 
-    const path = parentPath.concat(pythonFunction.name)
+    const path = parentPath.concat(pythonFunction.name);
     const hasParameters = !isEmptyList(pythonFunction.parameters);
     const cssClasses = classNames(
         "tree-view-row", {
@@ -54,6 +55,4 @@ const FunctionNode = ({
             </div>
         </div>
     );
-};
-
-export default FunctionNode;
+}
diff --git a/client/src/Components/Tree/ModuleNode.tsx b/client/src/Components/Tree/ModuleNode.tsx
@@ -11,27 +11,27 @@ type ModuleNodeProps = {
     pythonModule: PythonModule,
     selection: string[],
     setSelection: (newValue: string[]) => void,
-    setParameters: any,
+    setParameters: Setter<string[]>,
     setSelectedFunction: Setter<Nullable<PythonFunction>>
 }
 
-const ModuleNode = ({
-                        parentPath,
-                        pythonModule,
-                        selection,
-                        setSelection,
-                        setParameters,
-                        setSelectedFunction
-                    }: ModuleNodeProps) => {
+export default function ModuleNode({
+                                       parentPath,
+                                       pythonModule,
+                                       selection,
+                                       setSelection,
+                                       setParameters,
+                                       setSelectedFunction
+                                   }: ModuleNodeProps): JSX.Element {
 
     /** This is the Name of this module without its packages name prefixed. */
 
     const [, ...moduleName] = pythonModule.name.split(".");
 
-    const path = parentPath.concat(moduleName)
+    const path = parentPath.concat(moduleName);
     const [childVisible, setChildVisibility] = useState(false);
-    let hasClasses = !isEmptyList(pythonModule.classes);
-    let hasFunctions = !isEmptyList(pythonModule.functions);
+    const hasClasses = !isEmptyList(pythonModule.classes);
+    const hasFunctions = !isEmptyList(pythonModule.functions);
     const hasChildren = hasClasses || hasFunctions;
 
     const cssClasses = classNames(
@@ -48,8 +48,8 @@ const ModuleNode = ({
         <div className="module-node">
             <div className={cssClasses}
                  onClick={() => {
-                     setSelection(path)
-                     setChildVisibility(!childVisible)
+                     setSelection(path);
+                     setChildVisibility(!childVisible);
                  }}>
                 {(hasClasses || hasFunctions) &&
                 <span className="indicator visibility-indicator">{childVisible ? "▼" : "▶"}</span>}
@@ -89,7 +89,5 @@ const ModuleNode = ({
                 </div>}
             </div>
         </div>
-    )
-};
-
-export default ModuleNode;
+    );
+}
diff --git a/client/src/Components/Tree/Tree.tsx b/client/src/Components/Tree/Tree.tsx
@@ -1,17 +1,24 @@
-import React from 'react'
+import React from 'react';
 import ModuleNode from "./ModuleNode";
 import PythonPackage from "../../model/PythonPackage";
 import PythonFunction from "../../model/PythonFunction";
+import PythonParameter from "../../model/PythonParameter";
 
 type TreeProps = {
     pythonPackage: PythonPackage,
-    setParameters: any,
+    setParameters: Setter<PythonParameter[]>,
     selection: string[],
-    setSelection: any,
+    setSelection: Setter<string[]>,
     setSelectedFunction: Setter<Nullable<PythonFunction>>
 }
 
-const Tree = ({pythonPackage, setParameters, selection, setSelection, setSelectedFunction}: TreeProps) => {
+export default function Tree({
+                                 pythonPackage,
+                                 setParameters,
+                                 selection,
+                                 setSelection,
+                                 setSelectedFunction
+                             }: TreeProps): JSX.Element {
 
     const path = [pythonPackage.name];
 
@@ -30,5 +37,3 @@ const Tree = ({pythonPackage, setParameters, selection, setSelection, setSelecte
         </div>
     );
 }
-
-export default Tree;