Skip to content

fix(extension): only match tutorialkit content and meta files #242

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

Merged
merged 3 commits into from
Aug 14, 2024
Merged

fix(extension): only match tutorialkit content and meta files #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd21542
fix: only match tutorialkit content and meta files
Nemikolh Aug 13, 2024
9ef6af4
fix: doing that logic in getLanguageId was racy
Nemikolh Aug 13, 2024
e6e3a34
Merge branch 'main' into joan/fix-extensions-frontmatter-validation
Nemikolh Aug 13, 2024
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
9 changes: 1 addition & 8 deletions extensions/vscode/src/language-server/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,7 @@ connection.onInitialize((params) => {
{
uri: 'https://tutorialkit.dev/reference/configuration',
schema,
fileMatch: [
'**/*',

// TODO: these don't work
'src/content/*.md',
'src/content/**/*.md',
'src/content/**/*.mdx',
],
fileMatch: ['volar-embedded-content://tutorialkit_frontmatter/**/*'],
priority: SchemaPriority.Settings,
},
],
Expand Down
19 changes: 14 additions & 5 deletions extensions/vscode/src/language-server/languagePlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
import { CodeMapping, type LanguagePlugin, type VirtualCode } from '@volar/language-core';
import type * as ts from 'typescript';
import type { URI } from 'vscode-uri';
import { FILES_FOLDER, SOLUTION_FOLDER } from '../models/tree/constants';

export function frontmatterPlugin(debug: (message: string) => void): LanguagePlugin<URI> {
export function frontmatterPlugin(_debug: (message: string) => void): LanguagePlugin<URI> {
return {
getLanguageId(uri) {
debug('URI: ' + uri.path);

if (uri.path.endsWith('.md')) {
return 'markdown';
}
Expand All @@ -17,7 +16,17 @@ export function frontmatterPlugin(debug: (message: string) => void): LanguagePlu

return undefined;
},
createVirtualCode(_uri, languageId, snapshot) {
createVirtualCode(uri, languageId, snapshot) {
// only match markdown files inside the src/content/tutorial folder
if (!uri.path.match(/.*src\/content\/tutorial\/.*(content|meta)\.mdx?$/)) {
return undefined;
}

// but ignore all files under _files or _solution
if (uri.path.includes(FILES_FOLDER) || uri.path.includes(SOLUTION_FOLDER)) {
return undefined;
}

if (languageId === 'markdown' || languageId === 'mdx') {
return new FrontMatterVirtualCode(snapshot);
}
Expand Down Expand Up @@ -74,7 +83,7 @@ function* frontMatterCode(snapshot: ts.IScriptSnapshot): Generator<VirtualCode>
const frontMatterText = content.substring(frontMatterStartIndex, frontMatterEndIndex);

yield {
id: 'frontmatter_1',
id: 'tutorialkit_frontmatter',
languageId: 'yaml',
snapshot: {
getText: (start, end) => frontMatterText.slice(start, end),
Expand Down