Update Prettier and ESLint, adapt code

Author: flevi29

.changeset/bright-rabbits-juggle.md

@@ -165,7 +165,7 @@ jobs:
       - name: Install dependencies
         run: yarn install
       - name: Tests style
-        run: yarn lint
+        run: yarn style
       - name: Yaml Style
         uses: ibiqlik/action-yamllint@v3
         with:

.changeset/strong-dodos-carry.md

@@ -0,0 +1,14 @@
+// https://prettier.io/docs/en/options.html
+
+export default {
+  plugins: ['./node_modules/prettier-plugin-jsdoc/dist/index.js'],
+  // https://github.com/hosseinmd/prettier-plugin-jsdoc#tsdoc
+  tsdoc: true,
+  // TODO: Remove everything underneath and remove .editorconfig!
+  singleQuote: true,
+  arrowParens: 'always',
+  semi: false,
+  bracketSpacing: true,
+  trailingComma: 'es5',
+  printWidth: 80,
+}

.github/workflows/tests.yml

@@ -45,9 +45,9 @@ yarn test
 # End-to-end tests
 yarn test:e2e
 # Linter
-yarn lint
+yarn style
 # Linter with fixing
-yarn lint:fix
+yarn style:fix
 # Build the project
 yarn build
 ```

.prettierrc.js

@@ -0,0 +1,82 @@
+import eslint from '@eslint/js'
+import tseslint from 'typescript-eslint'
+import tsdoc from 'eslint-plugin-tsdoc'
+import vitest from '@vitest/eslint-plugin'
+import globals from 'globals'
+import prettier from 'eslint-config-prettier'
+import pluginCypress from 'eslint-plugin-cypress/flat'
+
+// TODO: Vue,React
+export default tseslint.config([
+  { ignores: ['{packages,playgrounds}/*/dist/', 'coverage/'] },
+  eslint.configs.recommended,
+  {
+    files: ['**/*.{js,cjs,mjs}'],
+    languageOptions: { globals: globals.node },
+  },
+  // TSDoc
+  {
+    // TODO: Ignore test files
+    files: ['packages/*/src/**/*.ts'],
+    plugins: { tsdoc },
+    rules: { 'tsdoc/syntax': 'off' },
+  },
+  // Cypress
+  {
+    files: [
+      'playgrounds/{autocomplete,local-react}/cypress/integration/*.spec.js',
+    ],
+    extends: [pluginCypress.configs.recommended],
+    // TODO: Remove rules
+    rules: {
+      'cypress/no-unnecessary-waiting': 'off',
+      'cypress/unsafe-to-chain-command': 'off',
+    },
+  },
+  // TypeScript
+  {
+    files: ['**/*.ts'],
+    extends: [tseslint.configs.recommendedTypeChecked],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    rules: {
+      // TODO: Remove the ones between "~~", adapt code
+      // ~~
+      '@typescript-eslint/ban-ts-comment': 'off',
+      '@typescript-eslint/no-unnecessary-type-assertion': 'off',
+      '@typescript-eslint/no-unsafe-call': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      '@typescript-eslint/no-unsafe-return': 'off',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-argument': 'off',
+      '@typescript-eslint/no-redundant-type-constituents': 'off',
+      // ~~
+      '@typescript-eslint/array-type': ['off', { default: 'array-simple' }],
+      // TODO: Should be careful with this rule, should leave it be and disable
+      //       it within files where necessary with explanations
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        // argsIgnorePattern: https://eslint.org/docs/latest/rules/no-unused-vars#argsignorepattern
+        // varsIgnorePattern: https://eslint.org/docs/latest/rules/no-unused-vars#varsignorepattern
+        { args: 'all', argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ],
+    },
+  },
+  // Vitest
+  {
+    files: ['packages/*/{src,__tests__}/**/*.test.ts'],
+    extends: [vitest.configs.recommended],
+    // TODO: Remove rules
+    rules: {
+      'vitest/no-identical-title': 'off',
+      'vitest/valid-title': 'off',
+    },
+  },
+  // Disable any style linting, as prettier takes care of that separately
+  prettier,
+])

CONTRIBUTING.md

@@ -20,8 +20,12 @@
     "playground:autocomplete": "turbo @meilisearch/autocomplete-playground#dev",
     "test:e2e": "turbo test:e2e",
     "test:e2e:watch": "turbo test:e2e:watch",
-    "lint": "turbo lint",
-    "lint:fix": "turbo lint:fix",
+    "fmt": "prettier -c ./**/*.{js,ts}",
+    "fmt:fix": "prettier -w ./**/*.{js,ts}",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "style": "yarn fmt && yarn lint",
+    "style:fix": "yarn fmt:fix && yarn lint:fix",
     "build": "turbo build",
     "test": "yarn build && vitest run",
     "test:watch": "yarn build && vitest",
@@ -32,8 +36,6 @@
     "release": "yarn build && changeset publish"
   },
   "devDependencies": {
-    "instantsearch.css": "^8.5.1",
-    "prettier": "^3.4.2",
     "vite": "^6.0.9",
     "@vitest/coverage-v8": "^3.0.2",
     "concurrently": "^9.1.2",
@@ -45,7 +47,19 @@
     "typescript": "^5.7.3",
     "@algolia/client-search": "^5.19.0",
     "algoliasearch": "^5.19.0",
-    "search-insights": "^2.17.3"
+    "search-insights": "^2.17.3",
+    "prettier": "^3.4.2",
+    "prettier-plugin-jsdoc": "^1.3.0",
+    "@eslint/js": "^9.16.0",
+    "@types/eslint__js": "^8.42.3",
+    "eslint": "^9.16.0",
+    "eslint-plugin-tsdoc": "^0.4.0",
+    "@vitest/eslint-plugin": "^1.1.23",
+    "eslint-config-prettier": "^9.1.0",
+    "@typescript-eslint/utils": "^8.19.0",
+    "globals": "^15.14.0",
+    "typescript-eslint": "^8.19.0",
+    "eslint-plugin-cypress":"^4.1.0"
   },
   "packageManager": "[email protected]"
 }

eslint.config.js

@@ -8,8 +8,6 @@
   },
   "scripts": {
     "build": "vite build && tsc -p tsconfig.json",
-    "lint": "eslint --ext .js,.ts,.tsx .",
-    "lint:fix": "eslint --ext .js,.ts,.tsx . --fix",
     "version": "node scripts/update_version.cjs"
   },
   "type": "module",
@@ -48,7 +46,6 @@
   "devDependencies": {
     "@algolia/autocomplete-js": "^1.7.4",
     "cssnano": "^4.1.10",
-    "eslint-config-meilisearch": "*",
     "instantsearch.js": "^4.56.2"
   }
 }

package.json

@@ -1,8 +1,6 @@
 import { PACKAGE_VERSION } from '../package-version.js'
 import { createSearchClient } from './createSearchClient.js'
 
-/**
- * Create searchClient instance for autocomplete
- */
+/** Create searchClient instance for autocomplete */
 const userAgent = `Meilisearch autocomplete-client (v${PACKAGE_VERSION})`
 export const meilisearchAutocompleteClient = createSearchClient({ userAgent })

packages/autocomplete-client/package.json

@@ -6,9 +6,7 @@ export const concatUserAgents = (clientAgents: string[]): string[] => {
   return clientAgents.concat(clientAgents.filter((agent) => agent))
 }
 
-/**
- * Create a searchClient instance
- */
+/** Create a searchClient instance */
 export function createSearchClient({ userAgent }: { userAgent: string }) {
   return ({
     url,