From 3c045628748721ffe978c5addff93c70529d8b71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Leroy?= Date: Tue, 11 Jun 2024 14:44:36 +0200 Subject: [PATCH] pnpm dependency install Add documentation for the need to explicitly add dependency to runtime when using pnpm. --- docs/getting-started.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index a1916e2..3e42520 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -32,6 +32,13 @@ yarn add -D typescript @types/node @types/express # Initialize tsconfig.json yarn run tsc --init ``` +When using pnpm, you will also need to explicitely add the @tsoa/runtime as a dependecy for generated routes. +This is inherent to the way pnpm manages node_modules (see [pnpm symlinked node_modules structure](https://pnpm.io/symlinked-node-modules-structure)). +```shell + +# Explicitely add @tsoa/runtime with pnpm as it will be needed by generated routes +pnpm add @tsoa/runtime +``` ## Configuring tsoa and typescript