fix: respect the config ordering used when adding a new unit

Author: Nemikolh

extensions/vscode/src/commands/tutorialkit.add.ts

@@ -2,6 +2,7 @@ import { cmd } from '.';
 import { Node, NodeType } from '../models/Node';
 import * as vscode from 'vscode';
 import { FILES_FOLDER, SOLUTION_FOLDER } from '../models/tree/constants';
+import { updateNodeMetadataInVFS } from '../models/tree/update';
 
 let kebabCase: (string: string) => string;
 let capitalize: (string: string) => string;
@@ -56,10 +57,16 @@ async function getUnitName(unitType: NodeType, unitNumber: number) {
 async function createUnitFolder(parent: Node, unitType: NodeType) {
   const unitNumber = parent.children.length + 1;
   const unitName = await getUnitName(unitType, unitNumber);
-  const unitFolderPath = `${unitNumber}-${kebabCase(unitName)}`;
+  const unitFolderPath = parent.order ? kebabCase(unitName) : `${unitNumber}-${kebabCase(unitName)}`;
+
   const metaFile = unitType === 'lesson' ? 'content.mdx' : 'meta.md';
   const metaFilePath = vscode.Uri.joinPath(parent.path, unitFolderPath, metaFile);
 
+  if (parent.order) {
+    parent.pushChild(unitFolderPath);
+    await updateNodeMetadataInVFS(parent);
+  }
+
   await vscode.workspace.fs.writeFile(
     metaFilePath,
     new TextEncoder().encode(`---\ntype: ${unitType}\ntitle: ${unitName}\n---\n`),

extensions/vscode/src/models/Node.ts

@@ -53,6 +53,29 @@ export class Node {
     readonly path: vscode.Uri,
     private _customName?: string,
   ) {}
+
+  pushChild(folderPath: string) {
+    this.childCount += 1;
+
+    if (this.order) {
+      this.order.set(folderPath, this.order.size);
+
+      switch (this.metadata?.type) {
+        case 'chapter': {
+          this.metadata.lessons!.push(folderPath);
+          break;
+        }
+        case 'tutorial': {
+          this.metadata.parts!.push(folderPath);
+          break;
+        }
+        case 'part': {
+          this.metadata.chapters!.push(folderPath);
+          break;
+        }
+      }
+    }
+  }
 }
 
 export type Metadata = PartSchema | ChapterSchema | LessonSchema | TutorialSchema;

extensions/vscode/src/models/tree/update.ts

@@ -0,0 +1,36 @@
+import * as vscode from 'vscode';
+import grayMatter from 'gray-matter';
+import { Node } from '../Node';
+
+export async function updateNodeMetadataInVFS(node: Node) {
+  if (!node.metadata || !node.metadataFilePath) {
+    return;
+  }
+
+  const filePath = node.metadataFilePath;
+  const document = vscode.workspace.textDocuments.find((document) => document.uri.toString() === filePath.toString());
+
+  const content = document ? document.getText() : await readContentAsString(filePath);
+
+  const parsedContent = grayMatter(content);
+  const frontMatterEnd = content.length - parsedContent.content.length;
+  const newMetadata = grayMatter.stringify('', node.metadata);
+
+  if (document) {
+    const edit = new vscode.WorkspaceEdit();
+    const range = new vscode.Range(document.positionAt(0), document.positionAt(frontMatterEnd));
+
+    edit.replace(filePath, range, newMetadata, { needsConfirmation: false, label: `Updated ${node.name}` });
+
+    await vscode.workspace.applyEdit(edit);
+  } else {
+    const newContent = new TextEncoder().encode(newMetadata + parsedContent.content);
+    await vscode.workspace.fs.writeFile(filePath, newContent);
+  }
+}
+
+async function readContentAsString(filePath: vscode.Uri) {
+  const binContent = await vscode.workspace.fs.readFile(filePath);
+
+  return new TextDecoder().decode(binContent);
+}