Merge pull request #1861 from flevi29/lint-staged-husky

Add `husky` and configure `lint-staged`

Author: flevi29

.github/workflows/docs.yml

@@ -1,5 +1,8 @@
 name: Build documentation
 
+env:
+  HUSKY: 0
+
 on:
   push:
     branches:

.github/workflows/meilisearch-prototype-tests.yml

@@ -1,6 +1,9 @@
 # Testing the code base against a specific Meilisearch feature
 name: Meilisearch prototype tests
 
+env:
+  HUSKY: 0
+
 # Will only run for PRs and pushes to *-beta
 on:
   pull_request:

.github/workflows/pre-release-tests.yml

@@ -1,6 +1,9 @@
 # Testing the code base against the Meilisearch pre-releases
 name: Pre-Release Tests
 
+env:
+  HUSKY: 0
+
 # Will only run for PRs and pushes to bump-meilisearch-v*
 on:
   pull_request:

.github/workflows/publish.yml

@@ -3,6 +3,9 @@ on:
   release:
     types: [published]
 
+env:
+  HUSKY: 0
+
 jobs:
   publish-npm:
     runs-on: ubuntu-latest

.github/workflows/tests.yml

@@ -1,5 +1,8 @@
 name: Tests
 
+env:
+  HUSKY: 0
+
 on:
   pull_request:
   push:

.husky/pre-commit

@@ -0,0 +1 @@
+yarn lint-staged

.prettierrc.js

@@ -1,7 +1,6 @@
-// https://prettier.io/docs/en/options.html
-
+/** @see {@link 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
+  /** {@link https://github.com/hosseinmd/prettier-plugin-jsdoc#tsdoc} */
   tsdoc: true,
 };

CONTRIBUTING.md

@@ -8,7 +8,7 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
 - [How to Contribute](#how-to-contribute)
 - [Development Workflow](#development-workflow)
 - [Git Guidelines](#git-guidelines)
-- [Release Process (for internal team only)](#release-process-for-internal-team-only)
+- [Release Process (for internal team only)](#release-process-for-the-internal-team-only)
 
 <!-- /MarkdownTOC -->
 
@@ -42,6 +42,7 @@ To run this project, you will need:
 You can set up your local environment natively or using `docker`, check out the [`docker-compose.yml`](/docker-compose.yml).
 
 Example of running all the checks with docker:
+
 ```bash
 docker-compose run --rm package bash -c "yarn install && yarn test && yarn lint"
 ```
@@ -79,6 +80,7 @@ We do not enforce any branch naming style, but please use something descriptive
 ### Git Commits
 
 As minimal requirements, your commit message should:
+
 - be capitalized
 - not finish by a dot or any other punctuation character (!,?)
 - start with a verb so that we can read your commit message this way: "This commit will ...", where "..." is the commit message.
@@ -119,11 +121,13 @@ _[Read more about this](https://github.com/meilisearch/integration-guides/blob/m
 Make a PR modifying the following files with the right version:
 
 [`package.json`](/package.json):
+
 ```javascript
 "version": "X.X.X",
 ```
 
 [`src/package-version`](/src/package-version.ts)
+
 ```javascript
 export const PACKAGE_VERSION = 'X.X.X'
 ```
@@ -137,6 +141,7 @@ GitHub Actions will be triggered and push the package to [npm](https://www.npmjs
 #### Release a `beta` Version
 
 This package is able to create multiple types of betas:
+
 - A standard package beta, working on the latest version of Meilisearch.
 - A beta implementing the changes of a rc version of Meilisearch.
 - A beta implementing a specific feature `prototype` of Meilisearch.
@@ -159,16 +164,16 @@ Here are the steps to release a beta version of this package depending on its ty
 
 3. Commit and push your code to the newly created branch (step 1).
 
-
 4. Go to the [GitHub interface for releasing](https://github.com/meilisearch/meilisearch-js/releases): on this page, click on `Draft a new release`.
 
 5. Create a GitHub pre-release:
-  - Fill the description with the detailed changelogs
-  - Fill the title with `vX.X.X-beta.0`
-  - Fill the tag with `vX.X.X-beta.0`
-  - ⚠️ Select the `vX.X.X-beta.0` branch and NOT `main`
-  - ⚠️ Click on the "This is a pre-release" checkbox
-  - Click on "Publish release"
+
+- Fill the description with the detailed changelogs
+- Fill the title with `vX.X.X-beta.0`
+- Fill the tag with `vX.X.X-beta.0`
+- ⚠️ Select the `vX.X.X-beta.0` branch and NOT `main`
+- ⚠️ Click on the "This is a pre-release" checkbox
+- Click on "Publish release"
 
 <hr>
 

lint-staged.config.js

@@ -0,0 +1,6 @@
+/**
+ * @type {import("lint-staged").Configuration}
+ * @see {@link https://github.com/lint-staged/lint-staged?tab=readme-ov-file#configuration}
+ * @see {@link https://github.com/lint-staged/lint-staged?tab=readme-ov-file#using-js-configuration-files}
+ */
+export default { "*.{js,ts}": ["prettier -w", "eslint"] };

package.json

@@ -60,36 +60,28 @@
     "lint": "eslint",
     "lint:fix": "eslint --fix",
     "style": "yarn fmt && yarn lint",
-    "style:fix": "yarn fmt:fix && yarn lint:fix"
+    "style:fix": "yarn fmt:fix && yarn lint:fix",
+    "prepare": "husky"
   },
   "files": [
     "src",
     "dist",
     "CONTRIBUTING.md"
   ],
-  "lint-staged": {
-    "**/*.{ts,tsx,js,jsx,css,scss,sass,less,md}": [
-      "prettier --write",
-      "git add"
-    ],
-    "src/**/*.{ts,tsx}": [
-      "yarn lint:fix",
-      "git add"
-    ]
-  },
   "devDependencies": {
     "@eslint/js": "^9.19.0",
     "@types/eslint__js": "^8.42.3",
     "@vitest/coverage-v8": "^3.0.7",
     "@types/node": "^22.13.8",
-    "eslint": "^9.21.0",
-    "eslint-plugin-tsdoc": "^0.4.0",
+    "@typescript-eslint/utils": "^8.22.0",
     "@vitest/eslint-plugin": "^1.1.25",
+    "eslint": "^9.21.0",
     "eslint-config-prettier": "^10.0.2",
+    "eslint-plugin-tsdoc": "^0.4.0",
     "typescript": "^5.8.2",
     "vite": "^6.2.0",
-    "@typescript-eslint/utils": "^8.22.0",
     "globals": "^16.0.0",
+    "husky": "^9.1.7",
     "lint-staged": "15.4.3",
     "prettier": "^3.5.2",
     "prettier-plugin-jsdoc": "^1.3.2",

yarn.lock

@@ -1599,6 +1599,11 @@ human-signals@^5.0.0:
   resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-5.0.0.tgz#42665a284f9ae0dade3ba41ebc37eb4b852f3a28"
   integrity sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==
 
+husky@^9.1.7:
+  version "9.1.7"
+  resolved "https://registry.yarnpkg.com/husky/-/husky-9.1.7.tgz#d46a38035d101b46a70456a850ff4201344c0b2d"
+  integrity sha512-5gs5ytaNjBrh5Ow3zrvdUUY+0VxIuWVL4i9irt6friV+BqdCfmV11CQTWMiBYWHbXhco+J1kHfTOUkePhCDvMA==
+
 ignore@^5.2.0, ignore@^5.3.1:
   version "5.3.2"
   resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.3.2.tgz#3cd40e729f3643fd87cb04e50bf0eb722bc596f5"