Use pnpm instead of npm

Author: pamella

.github/workflows/ci.yml

@@ -57,6 +57,12 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          run_install: false
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
@@ -65,22 +71,17 @@ jobs:
       - name: Install dependencies
         working-directory: ./frontend
         run: |
-          npm install
-
-      - name: Run ci
-        working-directory: ./frontend
-        run: |
-          npm ci
+          pnpm install
 
       - name: Run build
         working-directory: ./frontend
         run: |
-          npm run build
+          pnpm run build
 
       - name: Run tests
         working-directory: ./frontend
         run: |
-          npm run coveralls
+          pnpm run coveralls
 
       - name: Coveralls Parallel
         uses: coverallsapp/github-action@v2

.github/workflows/pre-commit.yml

@@ -20,15 +20,21 @@ jobs:
           pip install poetry
           poetry install
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          run_install: false
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: "20"
 
       - name: Install Node dependencies
-        run: |
-          npm install
         working-directory: ./frontend
+        run: |
+          pnpm install
 
       - name: Run pre-commit
         uses: pre-commit/[email protected]

.github/workflows/publish.yml

@@ -46,6 +46,12 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          run_install: false
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
@@ -55,21 +61,16 @@ jobs:
       - name: Install dependencies
         working-directory: ./frontend
         run: |
-          npm install
-
-      - name: Run ci
-        working-directory: ./frontend
-        run: |
-          npm ci
+          pnpm install
 
       - name: Build package
         working-directory: ./frontend
         run: |
-          npm run build
+          pnpm run build
 
       - name: Publish package distributions to npm
         working-directory: ./frontend
         run: |
-          npm publish
+          pnpm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_API_TOKEN }}

.pre-commit-config.yaml

@@ -31,14 +31,14 @@ repos:
     hooks:
       - id: frontend-lint
         name: run frontend lint
-        entry: sh -c 'cd frontend && npm run lint'
+        entry: sh -c 'cd frontend && pnpm run lint'
         language: system
         types: [file]
         files: ^frontend/.*\.(js|jsx|ts|tsx)$
         pass_filenames: true
       - id: frontend-tsc
         name: run frontend tsc
-        entry: sh -c 'cd frontend && npm run tsc'
+        entry: sh -c 'cd frontend && pnpm run tsc'
         language: system
         types: [file]
         files: ^frontend/.*\.(ts|tsx)$
@@ -64,7 +64,7 @@ repos:
         pass_filenames: false
       - id: generate-frontend-client
         name: generate frontend client
-        entry: sh -c 'cd frontend && npm run generate-client'
+        entry: sh -c 'cd frontend && pnpm run generate-client'
         language: system
         # Only run frontend client generation if frontend files have changed:
         files: openapi_schema\.json$

CONTRIBUTING.md

@@ -8,7 +8,9 @@ Please follow this guide to learn more about how to develop and test the project
 
 ### Clone the repo
 
-`git clone [email protected]:vintasoftware/django-ai-assistant.git`
+```bash
+git clone [email protected]:vintasoftware/django-ai-assistant.git
+```
 
 ### Set up a virtualenv, optionally set up nvm, and activate your environment(s)
 
@@ -20,31 +22,55 @@ For installing Node, we recommend [NVM](https://github.com/nvm-sh/nvm).
 
 #### Backend
 
-`poetry install`
+Go to the project root and install the Python dependencies:
+
+```bash
+poetry install
+```
 
 #### Frontend
 
+Go to the frontend directory and install the Node dependencies:
+
 ```bash
 cd frontend
-npm install
+pnpm install
 ```
 
 ### Install pre-commit hooks
 
-`pre-commit install`
+```bash
+pre-commit install
+```
 
 It's critical to run the pre-commit hooks before pushing your code to follow the project's code style, and avoid linting errors.
 
 ### Developing with the example project
 
-Run the frontend project in build:watch mode:
+Run the frontend project in `build:watch` mode:
 
 ```bash
 cd frontend
-npm run build:watch
+pnpm run build:watch
+```
+
+Then use `pnpm link` to link the frontend library to the example project:
+
+```bash
+cd frontend
+pnpm link
+```
+
+Go to the example project to finish the link with the frontend library:
+
+```bash
+cd ..  # back to project root directory
+cd example
+pnpm install
+pnpm link django-ai-assistant-client
 ```
 
-Then follow the instructions in the [example README](https://github.com/vintasoftware/django-ai-assistant/tree/main/example#readme).
+Then follow the instructions in the [example README](https://github.com/vintasoftware/django-ai-assistant/tree/main/example#running) to run the example project.
 
 ## Tests
 

docs/frontend.md

@@ -9,10 +9,10 @@ Django AI Assistant has a frontend TypeScript client to facilitate the integrati
 
 ## Installation
 
-Install the frontend client using npm:
+Install the frontend client using pnpm:
 
 ```bash
-npm install django-ai-assistant-client
+pnpm install django-ai-assistant-client
 ```
 
 ## Client Configuration

example/README.md

@@ -6,36 +6,12 @@ Most examples are inside a React frontend, but there is also a HTMX example.
 
 ## Installation
 
-Go to project root, then frontend dir and build the frontend library:
+Go to the example project, install its Node dependencies, and run the example Webpack devserver to build the React frontend:
 
 ```bash
-cd ..  # back to project root directory
-cd frontend
-npm install
-npm run build
-```
-
-Then use `npm link` to link the frontend library to the example project:
-
-```bash
-cd frontend
-npm link
-```
-
-Go to the example project to finish the link with the frontend library:
-
-```bash
-cd ..  # back to project root directory
 cd example
-npm install
-npm link django-ai-assistant-client
-```
-
-Run the example Webpack devserver to build the React frontend:
-
-```bash
-# in example directory
-npm run start
+pnpm install
+pnpm run start
 ```
 
 Install the example project Python dependencies:
@@ -85,4 +61,3 @@ Access the Django admin at `http://localhost:8000/admin/` and log in with the su
 ## Usage
 
 Access the example project at `http://localhost:8000/`.
-