PPI-1041 - Updated lint and test suite

.github/actions/setup-paypal/action.yml

@@ -95,3 +95,9 @@ runs:
         install-storefront: ${{ inputs.install-storefront }}
         dependencies: ${{ steps.dependency-list.outputs.deps }}
         extraRepositories: ${{ steps.dependency-list.outputs.repos }}
+    - name: Prepare Administration
+      shell: bash
+      if: ${{ inputs.install-admin == 'true' }}
+      run: |
+        bin/console bundle:dump
+        composer admin:generate-entity-schema-types

.github/workflows/admin.yml

@@ -23,17 +23,13 @@ jobs:
       - name: Setup SwagPayPal
         uses: ./custom/plugins/SwagPayPal/.github/actions/setup-paypal
         with:
-          install-commercial: true
           install-admin: true
-      - name: Prepare ESLint
-        run: |
-          bin/console bundle:dump
-          composer admin:generate-entity-schema-types
       - name: Run ESLint
         env:
           ADMIN_PATH: ${{ github.workspace }}/src/Administration/Resources/app/administration
         working-directory: custom/plugins/${{ github.event.repository.name }}
         run: composer run lint:admin:ci
+
   jest:
     uses: shopware/github-actions/.github/workflows/admin-jest.yml@main
     with:

src/Resources/app/administration/babel.config.json

@@ -1,7 +1,4 @@
 {
   "presets": ["@babel/preset-env"],
-  "plugins": [
-    "@babel/plugin-proposal-class-properties",
-    "@babel/plugin-transform-runtime"
-  ]
+  "plugins": ["@babel/plugin-proposal-class-properties"]
 }

src/Resources/app/administration/eslint.config.mjs

@@ -0,0 +1,199 @@
+import { resolve } from 'path';
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import vue from 'eslint-plugin-vue';
+import vueTs from '@vue/eslint-config-typescript';
+import swESLintBase from '@shopware-ag/eslint-config-base';
+import importPlugin from 'eslint-plugin-import' ;
+import stylistic from '@stylistic/eslint-plugin';
+import pluginJest from 'eslint-plugin-jest';
+import globals from 'globals';
+
+process.env.ADMIN_PATH =
+    process.env.ADMIN_PATH ??
+    resolve('../../../../../../../src/Administration/Resources/app/administration');
+
+const twigVuePlugin = await import(`${process.env.ADMIN_PATH}/twigVuePlugin/lib/index.js`);
+
+export default tseslint.config(
+    eslint.configs.recommended,
+    ...vue.configs['flat/recommended'],
+    ...vueTs(),
+    {
+        files: ['**/*.ts', '**/*.js'],
+        ignores: ['**/*.d.ts'],
+
+        plugins: { import: importPlugin, stylistic },
+
+        languageOptions: {
+            ecmaVersion: 'latest',
+            globals: {
+                Shopware: true,
+            },
+            parserOptions: {
+                projectService: true,
+                tsconfigRootDir: import.meta.dirname,
+            },
+        },
+
+        settings: {
+            'import/resolver': {
+                node: {},
+                webpack: {
+                    config: {
+                        // Sync with webpack.config.js
+                        resolve: {
+                            extensions: ['.js', '.ts', '.vue', '.json', '.sass', '.twig'],
+                            alias: {
+                                SwagPayPal: resolve('./src'),
+                                src: `${process.env.ADMIN_PATH}/src`,
+                                '@vue/test-utils': `${process.env.ADMIN_PATH}/node_modules/@vue/test-utils`,
+                                vue: `${process.env.ADMIN_PATH}/node_modules/@vue/compat/dist/vue.cjs.js`,
+                            },
+                        },
+                    },
+                },
+            },
+        },
+
+        rules: {
+            ...swESLintBase.rules,
+            indent: 'off',
+            'comma-dangle': 'off',
+            'max-len': 'off',
+
+            'no-console': ['error', { allow: ['warn', 'error'] }],
+            'internal-rules/no-src-imports': 'off',
+
+            /* import rules */
+            // lets depend on shopware's deps (vue and @vue/test-utils)
+            'import/no-extraneous-dependencies': 'off',
+            'import/no-useless-path-segments': 'off',
+            'import/extensions': [
+                'error',
+                'ignorePackages',
+                { js: 'never', ts: 'never' },
+            ],
+            /* import rules */
+
+            /* stylistic rules */
+            'stylistic/semi': ['error', 'always'],
+            'stylistic/indent': ['error', 4, { SwitchCase: 1 }],
+            'stylistic/member-delimiter-style': ['error'],
+            'stylistic/no-multi-spaces': ['error'],
+            'stylistic/object-curly-spacing': ['error', 'always'],
+            'stylistic/space-before-function-paren': ['error', {
+                anonymous: 'always',
+                named: 'never',
+                asyncArrow: 'always',
+            }],
+            'stylistic/spaced-comment': ['error', 'always'],
+            'stylistic/no-tabs': ['error'],
+            'stylistic/no-mixed-spaces-and-tabs': ['error'],
+            'stylistic/max-len': 'off',
+            'stylistic/quote-props': ['error', 'as-needed'],
+            'stylistic/no-extra-semi': ['error'],
+            'stylistic/comma-dangle': ['error', 'always-multiline'],
+            /* stylistic rules */
+
+            /* typescript rules */
+            '@typescript-eslint/ban-ts-comment': ['error', { 'ts-expect-error': false }],
+            '@typescript-eslint/no-unsafe-member-access': 'error',
+            '@typescript-eslint/no-unsafe-call': 'error',
+            '@typescript-eslint/no-unsafe-assignment': 'error',
+            '@typescript-eslint/no-unsafe-return': 'error',
+            '@typescript-eslint/explicit-module-boundary-types': 'off',
+            '@typescript-eslint/prefer-ts-expect-error': 'error',
+            '@typescript-eslint/no-floating-promises': 'off',
+            '@typescript-eslint/no-shadow': 'error',
+            '@typescript-eslint/consistent-type-imports': 'error',
+            '@typescript-eslint/no-unused-vars': ['error', {
+                argsIgnorePattern: '^_',
+                varsIgnorePattern: '^_',
+                caughtErrorsIgnorePattern: '^_|^(e|err)$',
+            }],
+            '@typescript-eslint/no-namespace': 'off',
+            '@typescript-eslint/restrict-template-expressions': 'off',
+            /* typescript rules */
+        },
+    },
+    {
+        files: ['**/*.html.twig'],
+
+        plugins: { twigVuePlugin },
+
+        processor: 'twigVuePlugin/twig-vue',
+
+        extends: [vue.configs['flat/recommended']],
+
+        rules: {
+            'vue/multiline-html-element-content-newline': 'off',
+
+            'vue/max-attributes-per-line': ['error', { singleline: 3 }],
+            'vue/component-definition-name-casing': ['error', 'kebab-case'],
+            'vue/require-explicit-emits': ['error'],
+            'vue/block-lang': ['error', { script: { lang: 'ts' } }],
+            'vue/html-indent': ['error', 4, { baseIndent: 0 }],
+            'vue/html-quotes': ['error', 'double', { avoidEscape: true }],
+            'vue/html-closing-bracket-newline': ['error', { singleline: 'never', multiline: 'always' }],
+            'vue/component-name-in-template-casing': ['error', 'kebab-case', { registeredComponentsOnly: true }],
+        },
+    },
+    {
+        files: [
+            '**/module/swag-paypal-disputes/**/*.html.twig',
+            '**/module/swag-paypal-payment/**/*.html.twig',
+            '**/module/swag-paypal-pos/**/*.html.twig',
+            '**/module/swag-paypal/**/*.html.twig',
+            '**/module/extension/**/*.html.twig',
+        ],
+
+        rules: {
+            'vue/attribute-hyphenation': 'off', // $attrs doesn't normalize kebab -> camelCase
+            'vue/v-on-event-hyphenation': 'off',
+            'vue/no-v-html': 'off',
+            'vue/no-unused-vars': 'off',
+            'vue/valid-v-slot': 'off',
+            'vue/require-v-for-key': 'off',
+            'vue/valid-v-for': 'off',
+            'vue/no-lone-template': 'off',
+            'vue/valid-v-model': 'off',
+
+            // templates are all wrong formatted
+            'vue/first-attribute-linebreak': 'off',
+            'vue/html-closing-bracket-newline': 'off',
+        },
+    },
+    {
+        files: ['**/*.spec.js', '**/*.spec.ts'],
+
+        plugins: { jest: pluginJest },
+
+        languageOptions: {
+            globals: {
+                ...globals.node,
+                ...pluginJest.environments.globals.globals,
+                wrapTestComponent: true,
+                flushPromises: true,
+            }
+        },
+
+        rules: {
+            'jest/expect-expect': 'error',
+            'jest/no-duplicate-hooks': 'error',
+            'jest/no-test-return-statement': 'error',
+            'jest/prefer-hooks-in-order': 'error',
+            'jest/prefer-hooks-on-top': 'error',
+            'jest/prefer-to-be': 'error',
+            'jest/require-top-level-describe': 'error',
+            'jest/prefer-to-contain': 'error',
+            'jest/prefer-to-have-length': 'error',
+            'jest/consistent-test-it': ['error', { fn: 'it', withinDescribe: 'it' }],
+        },
+    },
+    {
+        files: ['**/*.js'],
+
+        extends: [tseslint.configs.disableTypeChecked],
+    },
+);

src/Resources/app/administration/jest.config.js → src/Resources/app/administration/jest.config.mjs

@@ -1,9 +1,9 @@
-const { resolve, join } = require('path');
+import { resolve } from 'path';
 
 process.env.ADMIN_PATH =
     process.env.ADMIN_PATH || resolve('../../../../../../../src/Administration/Resources/app/administration');
 
-module.exports = {
+export default {
     preset: '@shopware-ag/jest-preset-sw6-admin',
     globals: {
         // required, e.g. /www/sw6/platform/src/Administration/Resources/app/administration
@@ -12,10 +12,11 @@ module.exports = {
 
     testMatch: [
         '<rootDir>/**/*.spec.js',
+        '<rootDir>/**/*.spec.ts',
     ],
 
     setupFilesAfterEnv: [
-        resolve(join(process.env.ADMIN_PATH, '/test/_setup/prepare_environment.js')),
+        `${process.env.ADMIN_PATH}/test/_setup/prepare_environment.js`,
         '<rootDir>/jest.setup.js',
     ],
 
@@ -38,9 +39,8 @@ module.exports = {
     moduleNameMapper: {
         '^SwagPayPal(.*)$': '<rootDir>/src$1',
         '^src(.*)$': `${process.env.ADMIN_PATH}/src$1`,
-        '^\@shopware-ag\/meteor-admin-sdk\/es\/(.*)':
-            `${process.env.ADMIN_PATH}/node_modules/@shopware-ag/meteor-admin-sdk/umd/$1`,
-        'vue$': `${process.env.ADMIN_PATH}/node_modules/@vue/compat/dist/vue.cjs.js`,
+        '^\@shopware-ag\/meteor-admin-sdk\/es\/(.*)': `${process.env.ADMIN_PATH}/node_modules/@shopware-ag/meteor-admin-sdk/umd/$1`,
+        vue$: `${process.env.ADMIN_PATH}/node_modules/@vue/compat/dist/vue.cjs.js`,
         '^@vue\/test-utils$': `${process.env.ADMIN_PATH}/node_modules/@vue/test-utils/dist/vue-test-utils.cjs.js`,
     },