Class: CssDocLanguageService

Defined in: servers/language-server/src/service.ts:422

The language service. Construct with the component index (rebuild it when the CSS changes).

Constructors

Constructor

new CssDocLanguageService(index, severities?): CssDocLanguageService;

Defined in: servers/language-server/src/service.ts:431

Parameters

index

CssDocIndex

severities?

RuleSeverities = DEFAULT_RULE_SEVERITIES

Returns

CssDocLanguageService

Methods

codeActions()

codeActions(diagnostics, path?): LspCodeAction[];

Defined in: servers/language-server/src/service.ts:1053

Quick fixes for the given diagnostics (replace a deprecated modifier with its canonical).

Parameters

diagnostics

LspDiagnostic[]

path?

string

Returns

LspCodeAction[]

---

completions()

completions(
   text, 
   position, 
   path?, 
   languageId?): LspCompletion[];

Defined in: servers/language-server/src/service.ts:516

Completions at a position: cssdoc @tags inside a doc comment (while authoring a stylesheet), var(--…) custom properties, or classes/modifiers in a class/className attribute.

Parameters

text

string

position

LspPosition

path?

string

languageId?

string

Returns

LspCompletion[]

---

definition()

definition(
   text, 
   position, 
   path?, 
   languageId?): LspLocation | undefined;

Defined in: servers/language-server/src/service.ts:785

Definition at a position — the CSS rule for the thing under the cursor. Mirrors hover: it jumps from a class usage (class/className, clsx(…), Vue :class, Svelte class:name) to the rule, and from a selector/property authored in a stylesheet or embedded CSS to its own rule.

Parameters

text

string

position

LspPosition

path?

string

languageId?

string

Returns

LspLocation | undefined

---

diagnostics()

diagnostics(
   text, 
   languageId?, 
   path?): LspDiagnostic[];

Defined in: servers/language-server/src/service.ts:859

Diagnostics for a document. For CSS the stylesheet is linted in place (doc-comment hygiene plus the registered-property value checks); for other languages, class-attribute usage is checked against the configured index.

Parameters

text

string

languageId?

string

path?

string

Returns

LspDiagnostic[]

---

hover()

hover(
   text, 
   position, 
   path?, 
   languageId?): LspHover | undefined;

Defined in: servers/language-server/src/service.ts:588

Hover at a position. Resolves to a documentation card in three places: while authoring a stylesheet (a selector/property in a .css file), while authoring embedded CSS (inside a <style> block, a css template, or a Markdown ```css fence — resolved against the projected CSS, which shares the source's offsets), and over a class usage (class/className, clsx(…), Vue :class, Svelte class:name).

Parameters

text

string

position

LspPosition

path?

string

languageId?

string

Returns

LspHover | undefined

---

setHoverDetail()

setHoverDetail(
   detail, 
   sections?, 
   sectionOrder?): void;

Defined in: servers/language-server/src/service.ts:436

Set the component-hover detail level (compact | full | custom), section map, and order.

Parameters

detail

HoverDetail

sections?

HoverSections = {}

sectionOrder?

HoverSectionOrder

Returns

void

---

setIndex()

setIndex(index): void;

Defined in: servers/language-server/src/service.ts:447

Replace the component index (single-scope path; e.g. after the CSS files change).

Parameters

index

CssDocIndex

Returns

void

---

setNaming()

setNaming(naming): void;

Defined in: servers/language-server/src/service.ts:457

Set the name-case conventions (single-scope path).

Parameters

naming

NamingRules

Returns

void

---

setRuleSeverities()

setRuleSeverities(severities): void;

Defined in: servers/language-server/src/service.ts:452

Set the per-rule severities (single-scope path).

Parameters

severities

RuleSeverities

Returns

void

---

setScopes()

setScopes(scopes): void;

Defined in: servers/language-server/src/service.ts:462

Replace all config scopes (multi-config path; one per governing cssdoc.json).

Parameters

scopes

ConfigScope[]

Returns

void