From ba8ba4fbf5871d0d84e150f4d455e27304a9f001 Mon Sep 17 00:00:00 2001 From: Matsu Date: Tue, 21 Nov 2023 19:39:22 +0200 Subject: [PATCH] Update FAQ --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index dc1063f..ba5ee11 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,23 @@ These operations include but are not limited to Via installing a plugin to your favorite editor to support LSP actions, you are able to enable all of these Language Service functionalities. +## FAQ + +#### Do I need to install anything? + +You should only have a `package.json`, and a `tsconfig.json` (or a `jsconfig.json`) file in your project. So pretty much any Javascript/Typescript project will do! + +#### Where does this plugin work? + +The Custom Elements Language Server should provide you with completions and diagnostics *anywhere* where you are using html and custom elements. + +#### How does the tool analyze my project? + +The Custom Elements Language Server utilizes the [Open WC CEM Analyzer](https://github.com/open-wc/custom-elements-manifest/tree/master/packages/analyzer) and a bunch of custom tools to go through your codebase and provide useful analytics on your code. + +##### Can I extend the analyzer? + +You sure can! By providing a `custom-elements-manifest.config.mjs` in your project root, you can extend the capability of the analyzer itself, and the Custom Elements Language Server will also utilize these changes while doing it's own scanning through your project. ### Disabling diagnostics