fix: code review

Author: AriPerkkio

extensions/vscode/scripts/build.mjs

@@ -57,7 +57,7 @@ async function main() {
     await buildMetadataSchema();
 
     if (production) {
-      // rename name in package json to match extension name on store:
+      // rename name in `package.json` to match extension name on store
       const pkgJSON = JSON.parse(fs.readFileSync('./package.json', { encoding: 'utf8' }));
 
       pkgJSON.name = 'tutorialkit';

extensions/vscode/src/extension.ts

@@ -18,6 +18,7 @@ export async function activate(context: vscode.ExtensionContext) {
   const serverModule = vscode.Uri.joinPath(context.extensionUri, 'dist', 'server.js');
   const runOptions = { execArgv: <string[]>[] };
   const debugOptions = { execArgv: ['--nolazy', '--inspect=' + 6009] };
+
   const serverOptions: lsp.ServerOptions = {
     run: {
       module: serverModule.fsPath,
@@ -30,10 +31,12 @@ export async function activate(context: vscode.ExtensionContext) {
       options: debugOptions,
     },
   };
+
   const clientOptions: lsp.LanguageClientOptions = {
     documentSelector: [{ language: 'markdown' }, { language: 'mdx' }],
     initializationOptions: {},
   };
+
   client = new lsp.LanguageClient('tutorialkit-language-server', 'TutorialKit', serverOptions, clientOptions);
 
   await client.start();

extensions/vscode/src/language-server/index.ts

@@ -23,7 +23,7 @@ connection.onInitialize((params) => {
         isKubernetes: false,
         schemas: [
           {
-            uri: 'https://tutorialkit.dev/reference/configuration/',
+            uri: 'https://tutorialkit.dev/reference/configuration',
             schema,
             fileMatch: [
               '**/*',

extensions/vscode/src/language-server/languagePlugin.ts

@@ -2,8 +2,8 @@ import { CodeMapping, type LanguagePlugin, type VirtualCode } from '@volar/langu
 import type * as ts from 'typescript';
 import type { URI } from 'vscode-uri';
 
-export const frontmatterPlugin = (debug: (message: string) => void) =>
-  ({
+export function frontmatterPlugin(debug: (message: string) => void): LanguagePlugin<URI> {
+  return {
     getLanguageId(uri) {
       debug('URI: ' + uri.path);
 
@@ -24,7 +24,8 @@ export const frontmatterPlugin = (debug: (message: string) => void) =>
 
       return undefined;
     },
-  }) satisfies LanguagePlugin<URI>;
+  };
+}
 
 export class FrontMatterVirtualCode implements VirtualCode {
   id = 'root';

packages/types/src/schemas/chapter.ts

@@ -7,7 +7,7 @@ export const chapterSchema = baseSchema.extend({
     .array(z.string())
     .optional()
     .describe(
-      'The list of lessons in this chapter. The order in this array defines the order of the lessons. If not specified a folder-based numbering system is used instead.',
+      'The list of lessons in this chapter. The order of the array defines the order of the lessons. If not specified a folder-based numbering system is used instead.',
     ),
 });
 

packages/types/src/schemas/common.ts

@@ -57,7 +57,7 @@ const panelTypeSchema = z
 const allowRedirectsSchema = z
   .boolean()
   .optional()
-  .describe('`true` if you want to enable output redirects in the terminal, disabled by default.');
+  .describe("Set to `true` if you want to enable output redirects in the terminal. It's disabled by default.");
 
 const allowCommandsSchema = z
   .array(z.string())
@@ -173,7 +173,7 @@ export const webcontainerSchema = commandsSchema.extend({
     .string()
     .optional()
     .describe(
-      'Specified which folder from the src/templates/ directory should be used as the basis for the code. See the “Code templates” guide for a detailed explainer.',
+      'Specified which folder from the `src/templates/` directory should be used as the basis for the code. See the "Code templates" guide for a detailed explainer.',
     ),
   terminal: terminalSchema
     .optional()
@@ -210,7 +210,7 @@ export const webcontainerSchema = commandsSchema.extend({
     ])
     .optional()
     .describe(
-      'Display a link in lesson for editing the page content. The value is a URL pattern where ${path} is replaced with the lesson’s location relative to src/content/tutorial.',
+      'Display a link in lesson for editing the page content. The value is a URL pattern where `${path}` is replaced with the lesson’s location relative to `src/content/tutorial`.',
     ),
 });
 
@@ -220,7 +220,7 @@ export const baseSchema = webcontainerSchema.extend({
     .string()
     .optional()
     .describe(
-      'Customize the URL segment of this part / chapter or lesson. The full URL path is /:partSlug/:chapterSlug/:lessonSlug.',
+      'Customize the URL segment of this part, chapter or lesson. The full URL path is `/:partSlug/:chapterSlug/:lessonSlug`.',
     ),
 });
 

packages/types/src/schemas/i18n.ts

@@ -50,25 +50,25 @@ export const i18nSchema = z.object({
   prepareEnvironmentTitleText: z.string().optional().describe('Text shown on top of the steps section.'),
 
   /**
-   * Text shown for the toggle terminal button.
+   * Text for the toggle terminal button.
    *
    * @default 'Toggle Terminal'
    */
-  toggleTerminalButtonText: z.string().optional().describe('Text shown for the toggle terminal button.'),
+  toggleTerminalButtonText: z.string().optional().describe('Text for the toggle terminal button.'),
 
   /**
-   * Text shown for the solve button.
+   * Text for the solve button.
    *
    * @default 'Solve'
    */
-  solveButtonText: z.string().optional().describe('Text shown for the solve button.'),
+  solveButtonText: z.string().optional().describe('Text for the solve button.'),
 
   /**
-   * Text shown for the reset button.
+   * Text for the reset button.
    *
    * @default 'Reset'
    */
-  resetButtonText: z.string().optional().describe('Text shown for the reset button.'),
+  resetButtonText: z.string().optional().describe('Text for the reset button.'),
 });
 
 export type I18nSchema = z.infer<typeof i18nSchema>;