Add and configure ESLint and update configuration for Prettier (actio…

…ns#391) * Apply ESLint config and update Prettier * Update dependencies and rebuild * Update docs
js6pak · Mar 9, 2023 · c822405 · c822405
1 parent 926f442
commit c822405
Show file tree

Hide file tree

Showing 27 changed files with 3,282 additions and 1,104 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,6 @@
+# Ignore list
+/*
+
+# Do not ignore these folders:
+!__tests__/
+!src/
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,49 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:eslint-plugin-jest/recommended',
+    'eslint-config-prettier'
+  ],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'eslint-plugin-jest'],
+  rules: {
+    '@typescript-eslint/no-require-imports': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/ban-ts-comment': [
+      'error',
+      {
+        'ts-ignore': 'allow-with-description'
+      }
+    ],
+    'no-console': 'error',
+    'yoda': 'error',
+    'prefer-const': [
+      'error',
+      {
+        destructuring: 'all'
+      }
+    ],
+    'no-control-regex': 'off',
+    'no-constant-condition': ['error', {checkLoops: false}]
+  },
+  overrides: [
+    {
+      files: ['**/*{test,spec}.ts'],
+      rules: {
+        '@typescript-eslint/no-unused-vars': 'off',
+        'jest/no-standalone-expect': 'off',
+        'jest/no-conditional-expect': 'off',
+        'no-console': 'off',
+
+      }
+    }
+  ],
+  env: {
+    node: true,
+    es6: true,
+    'jest/globals': true
+  }
+};
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1,2 @@
+* text=auto eol=lf
 .licenses/** -diff linguist-generated=true
diff --git a/.github/workflows/basic-validation.yml b/.github/workflows/basic-validation.yml
@@ -14,4 +14,4 @@ on:
 jobs:
   call-basic-validation:
     name: Basic validation
-    uses: actions/reusable-workflows/.github/workflows/basic-validation.yml@main
+    uses: actions/reusable-workflows/.github/workflows/basic-validation.yml@main
diff --git a/.github/workflows/check-dist.yml b/.github/workflows/check-dist.yml
@@ -14,4 +14,4 @@ on:
 jobs:
   call-check-dist:
     name: Check dist/
-    uses: actions/reusable-workflows/.github/workflows/check-dist.yml@main
+    uses: actions/reusable-workflows/.github/workflows/check-dist.yml@main
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -2,13 +2,13 @@ name: CodeQL analysis
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
   schedule:
     - cron: '0 3 * * 0'
 
 jobs:
   call-codeQL-analysis:
-    name: CodeQL analysis 
-    uses: actions/reusable-workflows/.github/workflows/codeql-analysis.yml@main
+    name: CodeQL analysis
+    uses: actions/reusable-workflows/.github/workflows/codeql-analysis.yml@main
diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml
@@ -192,83 +192,83 @@ jobs:
         run: __tests__/verify-dotnet.ps1 2.2 3.1
 
   test-setup-with-dotnet-quality:
-      runs-on: ${{ matrix.operating-system }}
-      strategy:
-        fail-fast: false
-        matrix:
-          operating-system: [ubuntu-latest, windows-latest, macOS-latest]
-      steps:
-        - name: Checkout
-          uses: actions/checkout@v3
-        - name: Clear toolcache
-          shell: pwsh
-          run: __tests__/clear-toolcache.ps1 ${{ runner.os }}
-               
-        - name: Setup dotnet 7.0 with preview quality
-          uses: ./
-          with:
-            dotnet-version: "7.0"
-            dotnet-quality: "preview"
-        - name: Verify preview version
-          shell: pwsh
-          run: |
-            $version = & dotnet --version
-            Write-Host "Installed version: $version"
-            if (-not ($version.Contains("preview") -or $version.Contains("rc"))) { throw "Unexpected version" }
-  
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      fail-fast: false
+      matrix:
+        operating-system: [ubuntu-latest, windows-latest, macOS-latest]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Clear toolcache
+        shell: pwsh
+        run: __tests__/clear-toolcache.ps1 ${{ runner.os }}
+
+      - name: Setup dotnet 7.0 with preview quality
+        uses: ./
+        with:
+          dotnet-version: '7.0'
+          dotnet-quality: 'preview'
+      - name: Verify preview version
+        shell: pwsh
+        run: |
+          $version = & dotnet --version
+          Write-Host "Installed version: $version"
+          if (-not ($version.Contains("preview") -or $version.Contains("rc"))) { throw "Unexpected version" }
+
   test-dotnet-version-output-during-single-version-installation:
-      runs-on: ${{ matrix.operating-system }}
-      strategy:
-        fail-fast: false
-        matrix:
-          operating-system: [ubuntu-latest, windows-latest, macOS-latest]
-      steps:
-        - name: Checkout
-          uses: actions/checkout@v3
-        - name: Clear toolcache
-          shell: pwsh
-          run: __tests__/clear-toolcache.ps1 ${{ runner.os }}
-
-        - name: Setup dotnet 6.0.401
-          uses: ./
-          id: step1
-          with:
-            dotnet-version: "6.0.401"
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      fail-fast: false
+      matrix:
+        operating-system: [ubuntu-latest, windows-latest, macOS-latest]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Clear toolcache
+        shell: pwsh
+        run: __tests__/clear-toolcache.ps1 ${{ runner.os }}
+
+      - name: Setup dotnet 6.0.401
+        uses: ./
+        id: step1
+        with:
+          dotnet-version: '6.0.401'
+
+      - name: Verify value of the dotnet-version output
+        shell: pwsh
+        run: |
+          $version = & dotnet --version
+          Write-Host "Installed version: $version"
+          if (-not ($version -eq '${{steps.step1.outputs.dotnet-version}}')) { throw "Unexpected output value" }
 
-        - name: Verify value of the dotnet-version output
-          shell: pwsh
-          run: |
-            $version = & dotnet --version
-            Write-Host "Installed version: $version"
-            if (-not ($version -eq '${{steps.step1.outputs.dotnet-version}}')) { throw "Unexpected output value" }
-  
   test-dotnet-version-output-during-multiple-version-installation:
-      runs-on: ${{ matrix.operating-system }}
-      strategy:
-        fail-fast: false
-        matrix:
-          operating-system: [ubuntu-latest, windows-latest, macOS-latest]
-      steps:
-        - name: Checkout
-          uses: actions/checkout@v3
-        - name: Clear toolcache
-          shell: pwsh
-          run: __tests__/clear-toolcache.ps1 ${{ runner.os }}
-
-        - name: Setup dotnet 6.0.401, 5.0.408, 7.0.100-rc.1.22431.12
-          uses: ./
-          id: step2
-          with:
-            dotnet-version: |
-              7.0.100-rc.1.22431.12
-              6.0.401
-              5.0.408
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      fail-fast: false
+      matrix:
+        operating-system: [ubuntu-latest, windows-latest, macOS-latest]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Clear toolcache
+        shell: pwsh
+        run: __tests__/clear-toolcache.ps1 ${{ runner.os }}
 
-        - name: Verify value of the dotnet-version output
-          shell: pwsh
-          run: |
-            $version = "7.0.100-rc.1.22431.12"
-            if (-not ($version -eq '${{steps.step2.outputs.dotnet-version}}')) { throw "Unexpected output value" }
+      - name: Setup dotnet 6.0.401, 5.0.408, 7.0.100-rc.1.22431.12
+        uses: ./
+        id: step2
+        with:
+          dotnet-version: |
+            7.0.100-rc.1.22431.12
+            6.0.401
+            5.0.408
+
+      - name: Verify value of the dotnet-version output
+        shell: pwsh
+        run: |
+          $version = "7.0.100-rc.1.22431.12"
+          if (-not ($version -eq '${{steps.step2.outputs.dotnet-version}}')) { throw "Unexpected output value" }
 
   test-proxy:
     runs-on: ubuntu-latest
@@ -320,4 +320,4 @@ jobs:
         env:
           NUGET_AUTH_TOKEN: NOTATOKEN
       - name: Verify dotnet
-        run: __tests__/verify-dotnet.sh 3.1.201
+        run: __tests__/verify-dotnet.sh 3.1.201
diff --git a/.github/workflows/licensed.yml b/.github/workflows/licensed.yml
@@ -12,4 +12,4 @@ on:
 jobs:
   call-licensed:
     name: Licensed
-    uses: actions/reusable-workflows/.github/workflows/licensed.yml@main
+    uses: actions/reusable-workflows/.github/workflows/licensed.yml@main
diff --git a/.github/workflows/release-new-action-version.yml b/.github/workflows/release-new-action-version.yml
@@ -21,9 +21,9 @@ jobs:
       name: releaseNewActionVersion
     runs-on: ubuntu-latest
     steps:
-    - name: Update the ${{ env.TAG_NAME }} tag
-      id: update-major-tag
-      uses: actions/[email protected]
-      with:
-        source-tag: ${{ env.TAG_NAME }}
-        slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
+      - name: Update the ${{ env.TAG_NAME }} tag
+        id: update-major-tag
+        uses: actions/[email protected]
+        with:
+          source-tag: ${{ env.TAG_NAME }}
+          slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
diff --git a/.github/workflows/test-dotnet.yml b/.github/workflows/test-dotnet.yml
@@ -34,4 +34,4 @@ jobs:
         run: |
           $version = & dotnet --version
           Write-Host "Installed version: $version"
-          if (-not $version.StartsWith("${{ matrix.dotnet-version }}")) { throw "Unexpected version" }
+          if (-not $version.StartsWith("${{ matrix.dotnet-version }}")) { throw "Unexpected version" }
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -2,3 +2,4 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 npm run format
+npm run lint:fix
diff --git a/.husky/pre-push b/.husky/pre-push
@@ -3,3 +3,4 @@
 
 # Tests are not run at push time since they can take 2-4 minutes to complete
 npm run format-check
+npm run lint
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,7 @@
+# Ignore list
+/*
+
+# Do not ignore these folders:
+!__tests__/
+!.github/
+!src/
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,10 @@
+module.exports = {
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'none',
+  bracketSpacing: false,
+  arrowParens: 'avoid'
+};
diff --git a/.prettierrc.json b/.prettierrc.json
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		* text=auto eol=lf
		.licenses/** -diff linguist-generated=true
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,3 +2,4 @@
		. "$(dirname -- "$0")/_/husky.sh"

		npm run format
		npm run lint:fix
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,3 +3,4 @@

		# Tests are not run at push time since they can take 2-4 minutes to complete
		npm run format-check
		npm run lint