From 823833f23f5f003d0063695c9f23448987e1e4db Mon Sep 17 00:00:00 2001 From: Makio64 Date: Tue, 4 Feb 2025 05:11:51 +0900 Subject: [PATCH] Docs: Add instructions for improving editor auto-completion with jsconfig or tsconfig (#30444) --- docs/manual/en/introduction/Installation.html | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/manual/en/introduction/Installation.html b/docs/manual/en/introduction/Installation.html index 848c1741f17fe0..c0672c0fdbf94b 100644 --- a/docs/manual/en/introduction/Installation.html +++ b/docs/manual/en/introduction/Installation.html @@ -90,6 +90,23 @@

Development

npm installs the code for each dependency in a new node_modules/ folder. When Vite builds your application, it sees imports for 'three' and pulls three.js files automatically from this folder. The node_modules/ folder is used only during development, and shouldn't be uploaded to your web hosting provider or committed to version history.

+
+ Improve your editor auto-completion with jsconfig or tscondig +

+ Place a jsconfig.json (or tsconfig.json for TypeScript projects) in your project's root. Adding the configuration below helps your editor locate three.js files for enhanced auto-completion. +

+ + { + "compilerOptions": { + // other options... + "paths": { + "three/webgpu": ["node_modules/three/build/three.webgpu.js"], + "three/tsl": ["node_modules/three/build/three.tsl.js"], + }, + } + } + +