Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prevent type checking define:vars scripts #718

Merged
merged 3 commits into from
Dec 7, 2023
Merged

Prevent type checking define:vars scripts #718

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7bfa505
prevent type errors in define:vars scripts
lilnasy Dec 6, 2023
bdb7661
add changeset
lilnasy Dec 6, 2023
042bb0d
update changeset
lilnasy Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/early-fireants-leave.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/language-server': patch
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the VS Code package and the Astro check ones to this changeset so they also get a release for this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't their semver ranges include this release?

---

Fixes an issue where type checking errors were shown on define:vars scripts when "type=module" attribute was also present.
35 changes: 17 additions & 18 deletions packages/language-server/src/core/parseJS.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,43 +12,41 @@ export function extractScriptTags(
htmlDocument: HTMLDocument,
ast: ParseResult['ast']
): VirtualFile[] {
const embeddedJSFiles: VirtualFile[] = findIsolatedScripts(
const embeddedJSFiles: VirtualFile[] = findModuleScripts(
fileName,
snapshot,
htmlDocument.roots
);

const javascriptContexts = [
...findInlineScripts(htmlDocument, snapshot),
...findClassicScripts(htmlDocument, snapshot),
...findEventAttributes(ast),
].sort((a, b) => a.startOffset - b.startOffset);

if (javascriptContexts.length > 0) {
// classic scripts share the same scope
// merging them brings about redeclaration errors
embeddedJSFiles.push(mergeJSContexts(fileName, javascriptContexts));
}

return embeddedJSFiles;
}

function isIsolatedScriptTag(scriptTag: Node): boolean {
// Using any kind of attributes on the script tag will disable hoisting
if (
!scriptTag.attributes ||
(scriptTag.attributes && Object.entries(scriptTag.attributes).length === 0) ||
scriptTag.attributes['type']?.includes('module')
) {
return true;
}

return false;
function getScriptType(scriptTag: Node): "classic" | "module" | "processed module" {
// script tags without attributes are processed and converted into module scripts
if (!scriptTag.attributes || Object.entries(scriptTag.attributes).length === 0) return "processed module";
// even when it is not processed by vite, scripts with type=module remain modules
if (scriptTag.attributes["type"]?.includes("module") === true) return "module";
// whenever there are attributes, is:inline is implied and in the absence of type=module, the script is classic
return "classic"
}

/**
* Get all the isolated scripts in the HTML document
* Isolated scripts are scripts that are hoisted by Astro and as such, are isolated from the rest of the code because of the implicit `type="module"`
* All the isolated scripts are passed to the TypeScript language server as separate `.mts` files.
*/
function findIsolatedScripts(
function findModuleScripts(
fileName: string,
snapshot: ts.IScriptSnapshot,
roots: Node[]
Expand All @@ -64,11 +62,12 @@ function findIsolatedScripts(
node.tag === 'script' &&
node.startTagEnd !== undefined &&
node.endTagStart !== undefined &&
isIsolatedScriptTag(node)
getScriptType(node) !== "classic"
) {
const scriptText = snapshot.getText(node.startTagEnd, node.endTagStart);
const extension = getScriptType(node) === "processed module" ? "mts" : "mjs";
embeddedScripts.push({
fileName: fileName + `.${scriptIndex}.mts`,
fileName: fileName + `.${scriptIndex}.${extension}`,
Comment on lines +68 to +70
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the fix is here, the rest is clerical

kind: FileKind.TypeScriptHostFile,
snapshot: {
getText: (start, end) => scriptText.substring(start, end),
Expand Down Expand Up @@ -113,7 +112,7 @@ interface JavaScriptContext {
* Inline scripts are scripts that are not hoisted by Astro and as such, are not isolated from the rest of the code.
* All the inline scripts are concatenated into a single `.mjs` file and passed to the TypeScript language server.
*/
function findInlineScripts(
function findClassicScripts(
htmlDocument: HTMLDocument,
snapshot: ts.IScriptSnapshot
): JavaScriptContext[] {
Expand All @@ -128,7 +127,7 @@ function findInlineScripts(
node.startTagEnd !== undefined &&
node.endTagStart !== undefined &&
!isJSON(node.attributes?.type) &&
!isIsolatedScriptTag(node)
getScriptType(node) === "classic"
) {
const scriptText = snapshot.getText(node.startTagEnd, node.endTagStart);
inlineScripts.push({
Expand Down