Content Collections Intellisense #915

Princesseuh · 2024-07-24T22:57:32Z

Changes

Requires withastro/astro#11639 to land first

Adds support for intellisense inside Markdown, MDX and Markdoc. Everything expected is supported, diagnostics, completions, hover, go to definition / references (both on the .md/.mdx/.mdoc side and the .ts side), etc.

Currently, this is behind a astro.content-intellisense flag as the feature in core is also experimental.

Testing

Added tests

Docs

Will be documented on the Astro part of things mostly

changeset-bot · 2024-07-24T22:57:35Z

🦋 Changeset detected

Latest commit: afda8cb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@astrojs/language-server	Minor
@astrojs/ts-plugin	Minor
@astrojs/yaml2ts	Minor
astro-vscode	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Princesseuh · 2024-08-08T15:28:09Z

package.json

@@ -22,7 +22,7 @@
    "@changesets/cli": "^2.26.1",
    "prettier": "^3.2.5",
    "turbo": "1.10.2",
-    "typescript": "^5.2.2",
+    "typescript": "^5.5.4",


Unrelated to the PR, but I was getting a wonky TS error somewhere and updating TS fixed it.

This reverts commit 4b86b00.

packages/language-server/src/core/frontmatterHolders.ts

Princesseuh · 2024-08-08T23:12:41Z

packages/language-server/src/nodeServer.ts

+		// The vast majority of clients support workspaceFolders, but notably our tests currently don't
+		// Ref: https://github.com/volarjs/volar.js/issues/229
+		const folders =
+			params.workspaceFolders ?? (params.rootUri ? [{ uri: params.rootUri }] : []) ?? [];


This brought me back to 2 years ago when you actually needed to handle rootURI. Good times (no)

Princesseuh · 2024-08-08T23:15:29Z

packages/language-server/src/plugins/yaml.ts

+					}
+
+					if (hasChanges) {
+						// TODO: Figure out how to refresh the diagnostics


Couldn't figure out a way to do this from a Volar service, will have to ask Johnson. It's not too impactful, as soon as you trigger any actions that refresh the diagnostics (open the file, type anything etc) it refreshes normally.

Princesseuh · 2024-08-08T23:16:06Z

packages/language-server/src/plugins/yaml.ts

+
+			return {
+				...yamlPluginInstance,
+				// Disable codelenses, we'll provide our own


Not included in this PR, but disabling the built-in code lenses is still valuable, they're irrelevant for Astro users.

Princesseuh · 2024-08-08T23:17:33Z

packages/language-server/test/fixture/enhancedDiagnostics.astro

---
-import { getEntryBySlug } from 'astro:content';
-getEntryBySlug;
---


This test no longer work since we now generate types in the tests. That's okay because the feature being tested here is still tested, just not.. double tested

Princesseuh · 2024-08-08T23:17:47Z

packages/language-server/test/fixture/package.json

@@ -2,6 +2,9 @@
  "name": "astro-language-server-test",
  "private": true,
  "devDependencies": {
-    "astro": "^4.1.0"
+    "astro": "0.0.0-content-collections-intellisense-20240808223933"


To replace with the actual version once it's out.

Princesseuh · 2024-08-08T23:19:52Z

packages/ts-plugin/src/index.ts

+	if (collectionConfig) {
+		languagePlugins.push(getFrontmatterLanguagePlugin([collectionConfig]));
+	}


Unfortunately in TS plugins getting any kind of config (apart from tsconfig.json) is really annoying. As such, the feature is always enabled there when it finds a config.

bluwy

I think I more or less / maybe / a little bit grasp what's going on, but otherwise the code generally looks good to me.

packages/ts-plugin/src/frontmatter.ts

ematipico

Left questions. Few things:

there's a bunch of repeated code, can that be shared?
there are few magic numbers that don't have any comment associated that explain them
I've seen many bang operators (e.g. yamlPluginInstance.provide!['yaml/languageService']) used. It would be great to add a // SAFETY comment that explains why they are safe to use

packages/yaml2ts/src/yaml2ts.ts

ematipico · 2024-08-09T10:52:20Z

packages/yaml2ts/src/yaml2ts.ts

+					const valueKey = JSON.stringify(item.key.toJS(frontmatterContent));
+
+					frontmatterMappings.push({
+						generatedOffsets: [fullResult.length + objectContent.length],


nit: I prefer to see fullResult.length being passed as parameter, so the function stays pure.

packages/yaml2ts/src/yaml2ts.ts

ematipico · 2024-08-09T10:55:48Z

packages/yaml2ts/src/yaml2ts.ts

+			}
+
+			if (isSeq(item)) {
+				mapSeq(item);


nit: I wish we could avoid recursion... 😅

packages/language-server/src/core/frontmatterHolders.ts

packages/language-server/src/plugins/yaml.ts

packages/ts-plugin/src/frontmatter.ts

ematipico · 2024-08-09T11:07:42Z

packages/ts-plugin/src/frontmatter.ts

+const SUPPORTED_FRONTMATTER_EXTENSIONS = { md: 'markdown', mdx: 'mdx', mdoc: 'mdoc' };
+const SUPPORTED_FRONTMATTER_EXTENSIONS_KEYS = Object.keys(SUPPORTED_FRONTMATTER_EXTENSIONS);
+const SUPPORTED_FRONTMATTER_EXTENSIONS_VALUES = Object.values(SUPPORTED_FRONTMATTER_EXTENSIONS);


This is repeated code, any chance to make this shared?

It's a bit wonky to make shared because it's in different packages with no link between each others apart from one and it doesn't really belong in the YAML 2 TS package since it doesn't deal with the supported languages, but I guess it could be there

Princesseuh added 2 commits July 23, 2024 18:46

feat: cc integration

0685220

fix: clean up

96cb75f

Princesseuh added 17 commits July 25, 2024 00:59

chore: remove unused package

ce47285

feat: support maps and seqs

3166cec

Merge branch 'main' into feat/content-collections-intellisense

059b81e

Merge branch 'main' into feat/content-collections-intellisense

a7c3242

Merge branch 'main' into feat/content-collections-intellisense

21aa268

Merge branch 'main' into feat/content-collections-intellisense

7c75c14

feat: do hybrid ts / json

f673235

feat: apply schemas dynamically

6233fad

feat: flag it

682868e

feat: references support

fa7175b

Merge branch 'main' into feat/content-collections-intellisense

fb9ce87

chore: lockfile

78699c0

fix: merge conflicts

e314fec

fix: handle errors

5ef168c

feat: cleanup ts output to not include values

6fb3f4f

refactor: ts-plugin

fc2b6a9

fix: remove unneeded param

f88e988

Princesseuh commented Aug 8, 2024

View reviewed changes

Princesseuh added 5 commits August 8, 2024 17:35

refactor: don't hardcode frontmatter holders

f1819ea

refactor: use consistent languageIds

90b68e3

test: add tests

34babad

fix: disable codelenses properly

9baf238

fix: use file urls

3543e23

Princesseuh mentioned this pull request Aug 8, 2024

Add file generation and flag for content intellisense withastro/astro#11639

Merged

Princesseuh added 3 commits August 9, 2024 00:14

fix: atempt to debug windows

4b86b00

fix: windooooows

ed0443b

Revert "fix: atempt to debug windows"

432ea33

This reverts commit 4b86b00.

chore: changeset

f9ac9a5

Princesseuh marked this pull request as ready for review August 8, 2024 23:08

Princesseuh commented Aug 8, 2024

View reviewed changes

packages/language-server/src/core/frontmatterHolders.ts Show resolved Hide resolved

Princesseuh commented Aug 8, 2024

View reviewed changes

bluwy approved these changes Aug 9, 2024

View reviewed changes

packages/ts-plugin/src/frontmatter.ts Outdated Show resolved Hide resolved

Princesseuh added 3 commits August 9, 2024 10:42

refactor: remove some unused code

5c4f24a

refactor: remove more unused code

9263237

refactor: use same frontmatter extraction as Astro itself

3ba06a8

ematipico reviewed Aug 9, 2024

View reviewed changes

Princesseuh added 2 commits August 9, 2024 13:14

docs: add comments explaining uri transformations

cc9d498

nit: adjust for feedback

ba45198

ematipico approved these changes Aug 9, 2024

View reviewed changes

Princesseuh added 3 commits August 15, 2024 12:07

Merge branch 'main' into feat/content-collections-intellisense

f417cd3

chore: lockfile

af9616f

chore: update Astro version

afda8cb

Princesseuh merged commit d624646 into main Aug 15, 2024
4 checks passed

Princesseuh deleted the feat/content-collections-intellisense branch August 15, 2024 10:15

maxchang3 mentioned this pull request Aug 23, 2024

🐛 BUG: ERR_REQUIRE_ESM on .astro file save #627

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Content Collections Intellisense #915

Content Collections Intellisense #915

Princesseuh commented Jul 24, 2024 •

edited

Loading

changeset-bot bot commented Jul 24, 2024 •

edited

Loading

Princesseuh Aug 8, 2024

Princesseuh Aug 8, 2024

Princesseuh Aug 8, 2024

Princesseuh Aug 8, 2024

Princesseuh Aug 8, 2024

Princesseuh Aug 8, 2024

Princesseuh Aug 8, 2024

bluwy left a comment

ematipico left a comment

ematipico Aug 9, 2024

ematipico Aug 9, 2024

ematipico Aug 9, 2024

Princesseuh Aug 9, 2024 •

edited

Loading

Content Collections Intellisense #915

Content Collections Intellisense #915

Conversation

Princesseuh commented Jul 24, 2024 • edited Loading

Changes

Testing

Docs

changeset-bot bot commented Jul 24, 2024 • edited Loading

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bluwy left a comment

Choose a reason for hiding this comment

ematipico left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Princesseuh Aug 9, 2024 • edited Loading

Choose a reason for hiding this comment

Princesseuh commented Jul 24, 2024 •

edited

Loading

changeset-bot bot commented Jul 24, 2024 •

edited

Loading

Princesseuh Aug 9, 2024 •

edited

Loading