Merge pull request #43 from Vision-null/visuals

Version 2.0 Release

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env", "@babel/preset-react"]
+}

.eslintrc.json

@@ -1,30 +1,43 @@
 {
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": 6,
-        "sourceType": "module"
-    },
-    "plugins": [
-        "@typescript-eslint"
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2022,
+    "sourceType": "module",
+    "project": "./tsconfig.json"
+  },
+  "env": {
+    "browser": true,
+    "node": true,
+    "es2022": true
+  },
+  "plugins": ["@typescript-eslint", "prettier"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+  "rules": {
+    "@typescript-eslint/naming-convention": [
+      "warn",
+      {
+        "selector": "import",
+        "format": ["camelCase", "PascalCase"]
+      }
     ],
-    "rules": {
-        "@typescript-eslint/naming-convention": [
-            "warn",
-            {
-                "selector": "import",
-                "format": [ "camelCase", "PascalCase" ]
-            }
-        ],
-        "@typescript-eslint/semi": "warn",
-        "curly": "warn",
-        "eqeqeq": "warn",
-        "no-throw-literal": "warn",
-        "semi": "off"
-    },
-    "ignorePatterns": [
-        "out",
-        "dist",
-        "**/*.d.ts"
-    ]
-}
+    "@typescript-eslint/no-unused-vars": ["error", { "varsIgnorePattern": "^_" }],
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/semi": "warn",
+    "curly": "warn",
+    "eqeqeq": "warn",
+    "no-throw-literal": "warn",
+    "semi": "off",
+    "prettier/prettier": "warn"
+  },
+  "ignorePatterns": ["dist", "**/*.d.ts", "src/logic/aria-standards"],
+  "overrides": [
+    {
+      "files": ["webpack.config.js"],
+      "parser": "espree",
+      "parserOptions": {
+        "ecmaVersion": 2020
+      }
+    }
+  ]
+}

.gitattributes

@@ -0,0 +1,10 @@
+# Ignore an entire directory
+src/logic/aria-standards/serious linguist-generated=true
+Summary_Library/* linguist-generated=true
+ludwigReports/* linguist-generated=true
+devTestFiles/* linguist-generated=true
+dist/* linguist-generated=true
+
+*.ts linguist-language=TypeScript
+
+node_modules/* linguist-vendored=true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+# Contribution Guidelines
+
+## Pre-Push Check Instructions
+
+Before pushing your changes, please follow these steps to ensure code quality and consistency:
+
+1. Ensure all dependencies are installed: `pnpm install`
+
+2. Run the linting and formatting checks: `pnpm run lint`
+
+3. If issues are found, attempt to auto-fix them: `pnpm run lint:fix`
+
+4. If any issues remain after auto-fixing, address them manually in your code and re-run `pnpm run lint`
+
+5. Once all checks pass, commit your changes and push to your branch.
+
+## Notes
+
+- The CI pipeline will run these checks automatically on push and pull requests.
+- Minor issues may be auto-fixed by the CI, but it's best to resolve issues locally before pushing.
+
+## Code Style
+
+- ESLint is used for JavaScript and TypeScript linting.
+- Prettier is used for code formatting.
+- Configuration files (.eslintrc and .prettierrc) define the specific rules.

.github/workflows/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+# Contribution Guidelines
+
+## Pre-Push Check Instructions
+
+Before pushing your changes, please follow these steps to ensure code quality and consistency:
+
+1. Ensure all dependencies are installed: `pnpm install`
+
+2. Run the linting and formatting checks: `pnpm run lint`
+
+3. If issues are found, attempt to auto-fix them: `pnpm run lint:fix`
+
+4. If any issues remain after auto-fixing, address them manually in your code and re-run `pnpm run lint`
+
+5. Once all checks pass, commit your changes and push to your branch.
+
+## Notes
+
+- The CI pipeline will run these checks automatically on push and pull requests.
+- Minor issues may be auto-fixed by the CI, but it's best to resolve issues locally before pushing.
+
+## Code Style
+
+- ESLint is used for JavaScript and TypeScript linting.
+- Prettier is used for code formatting.
+- Configuration files (.eslintrc and .prettierrc) define the specific rules.

.github/workflows/lint.yml

@@ -0,0 +1,67 @@
+name: Lint and Format
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+permissions:
+  contents: write
+
+jobs:
+  lint-and-format:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 2
+
+      - name: Setup Node.js environment
+        uses: actions/[email protected]
+        with:
+          node-version: 20
+
+      - name: Setup pnpm
+        uses: pnpm/[email protected]
+        with:
+          version: 9.4.0
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Initial ESLint Check
+        id: lint_check
+        run: pnpm run lint
+        continue-on-error: true
+
+      - name: Initial Prettier Check
+        id: format_check
+        run: pnpm prettier --check "src/**/*.{js,jsx,ts,tsx,json,css,scss,md}"
+        continue-on-error: true
+
+      - name: Run ESLint with auto-fix
+        if: steps.lint_check.outcome == 'failure'
+        run: pnpm eslint --fix src/**/*.{js,jsx,ts}
+
+      - name: Run Prettier with auto-fix
+        if: steps.format_check.outcome == 'failure'
+        run: pnpm prettier --write "src/**/*.{js,jsx,ts,tsx,json,css,scss,md}"
+
+      - name: Git Auto Commit
+        if: steps.lint_check.outcome == 'failure' || steps.format_check.outcome == 'failure'
+        uses: stefanzweifel/[email protected]
+        with:
+          commit_message: 'style: auto-fix linting and formatting issues'
+          branch: ${{ github.head_ref }}
+
+      - name: Final ESLint Check
+        if: steps.lint_check.outcome == 'failure' || steps.format_check.outcome == 'failure'
+        run: pnpm run lint
+
+      - name: Final Prettier Check
+        if: steps.lint_check.outcome == 'failure' || steps.format_check.outcome == 'failure'
+        run: pnpm prettier --check "src/**/*.{js,jsx,ts,tsx,json,css,scss,md}"

.gitignore

@@ -0,0 +1,10 @@
+out
+dist
+node_modules
+.vscode-test/
+*.vsix
+resultsLib.json
+ludwigReports/*
+!ludwigReports/.gitkeep
+Summary_Library/*
+!Summary_Library/persistent

.npmrc

@@ -0,0 +1,2 @@
+enable-pre-post-scripts = true
+shamefully-hoist=true

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "printWidth": 120
+}

.vscode/extensions.json

@@ -1,5 +1,7 @@
 {
-  // See http://go.microsoft.com/fwlink/?LinkId=827846
-  // for the documentation about the extensions.json format
-  "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher"]
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "amodio.tsl-problem-matcher",
+    "ms-vscode.extension-test-runner"
+  ]
 }

.vscode/launch.json

@@ -1,35 +1,22 @@
-// A launch configuration that compiles the extension and then opens it inside a new window
-// Use IntelliSense to learn about possible attributes.
-// Hover to view descriptions of existing attributes.
-// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"name": "Run Extension",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}"
-			],
-			"outFiles": [
-				"${workspaceFolder}/dist/**/*.js"
-			],
-			"preLaunchTask": "${defaultBuildTask}"
-		},
-		{
-			"name": "Extension Tests",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
-			],
-			"outFiles": [
-				"${workspaceFolder}/out/**/*.js",
-				"${workspaceFolder}/dist/**/*.js"
-			],
-			"preLaunchTask": "tasks: watch-tests"
-		}
-	]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--new-window",
+        "--folder-uri=${workspaceFolder}/devTestFiles/",
+        "--disable-extensions",
+        "--disable-telemetry"
+      ],
+      "outFiles": ["${workspaceFolder}/dist/**/*.js"],
+      "preLaunchTask": "${defaultBuildTask}",
+      "env": {
+        "VSCODE_DEBUGGING_EXTENSION": "true"
+      }
+    }
+  ]
 }

.vscode/settings.json

@@ -1,13 +1,12 @@
-// Place your settings in this file to overwrite default and user settings.
 {
-    "files.exclude": {
-        "out": false, // set this to true to hide the "out" folder with the compiled JS files
-        "dist": false // set this to true to hide the "dist" folder with the compiled JS files
-    },
-    "search.exclude": {
-        "out": true, // set this to false to include "out" folder in search results
-        "dist": true // set this to false to include "dist" folder in search results
-    },
-    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
-    "typescript.tsc.autoDetect": "off"
-}
+  "files.exclude": {
+    "out": false,
+    "dist": false
+  },
+  "search.exclude": {
+    "out": true,
+    "dist": true
+  },
+
+  "typescript.tsc.autoDetect": "off"
+}