test(cli): add test for creating and building a project (#60)

Author: SamVerschueren

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/ci.yaml

@@ -7,17 +7,32 @@ on:
 jobs:
   test:
     name: Test
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        node-version: [18, 20, 22]
+        include:
+          - os: macos-latest
+            node_version: 20
+          - os: windows-latest
+            node_version: 20.13.1 # 20.14.0 keeps causing a native `node::SetCppgcReference+18123` error in Vitest
     steps:
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
       - name: Setup
         uses: pnpm/action-setup@v4
         with:
           version: 8
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install dependencies
         run: pnpm install
       - name: Lint
         run: pnpm prettier --check .
       - name: Build
         run: pnpm build
+      - name: Test
+        run: pnpm test

.gitignore

@@ -20,3 +20,4 @@ dist-ssr
 .pnpm-store
 /tutorialkit/template
 tsconfig.tsbuildinfo
+.tmp

package.json

@@ -4,6 +4,7 @@
     "build": "pnpm run --filter=@tutorialkit/* --filter=tutorialkit --filter=create-tutorial build",
     "template:dev": "TUTORIALKIT_DEV=true pnpm run build && pnpm run --filter=tutorialkit-starter dev",
     "template:build": "pnpm run build && pnpm run --filter=tutorialkit-starter build",
+    "test": "pnpm run --filter=tutorialkit test",
     "prepare": "is-ci || husky install",
     "clean": "./scripts/clean.sh"
   },

packages/astro/package.json

@@ -47,15 +47,16 @@
     "unocss": "^0.59.4",
     "zod": "3.23.8"
   },
-  "peerDependencies": {
-    "astro": "^4.8.6"
-  },
   "devDependencies": {
     "@tutorialkit/types": "workspace:*",
     "@types/mdast": "^4.0.3",
     "esbuild": "^0.20.2",
     "esbuild-node-externals": "^1.13.0",
+    "execa": "^9.2.0",
     "typescript": "^5.4.5",
     "vite-plugin-inspect": "0.8.4"
+  },
+  "peerDependencies": {
+    "astro": "^4.10.2"
   }
 }

packages/astro/scripts/build.js

@@ -1,15 +1,18 @@
 import assert from 'node:assert';
 import { existsSync } from 'node:fs';
-import { spawnSync } from 'node:child_process';
 import { cp, rm } from 'node:fs/promises';
+import { execa } from 'execa';
 import esbuild from 'esbuild';
 import { nodeExternalsPlugin } from 'esbuild-node-externals';
 
 // clean dist
 await rm('dist', { recursive: true, force: true });
 
 // only do typechecking and emit the type declarations with tsc
-spawnSync('tsc', ['--emitDeclarationOnly', '--project', './tsconfig.build.json'], { stdio: 'inherit' });
+execa('tsc', ['--emitDeclarationOnly', '--project', './tsconfig.build.json'], {
+  stdio: 'inherit',
+  preferLocal: true,
+});
 
 // build with esbuild
 esbuild.build({

packages/astro/src/default/utils/content.ts

@@ -222,7 +222,7 @@ async function getFilesRef(pathToFolder: string): Promise<FilesRef> {
   const root = path.join(CONTENT_DIR, pathToFolder);
 
   const filePaths = (
-    await glob(`${root}/**/*`, {
+    await glob(`${glob.convertPathToPattern(root)}/**/*`, {
       onlyFiles: true,
     })
   ).map((filePath) => `/${path.relative(root, filePath)}`);

packages/astro/src/index.ts

@@ -117,6 +117,10 @@ export default function createPlugin({ defaultRoutes = true, isolation, enterpri
         _config = config;
       },
       'astro:server:setup'(options) {
+        if (!_config) {
+          return;
+        }
+
         const { server, logger } = options;
         const projectRoot = fileURLToPath(_config.root);
 

packages/astro/src/webcontainer-files.ts

@@ -20,8 +20,8 @@ export class WebContainerFiles {
     const cache = new FileMapCache(logger, server, { contentDir, templatesDir });
 
     this._watcher = watch([
-      `${contentDir}/**/${FILES_FOLDER_NAME}/**/*`,
-      `${contentDir}/**/${SOLUTION_FOLDER_NAME}/**/*`,
+      path.join(contentDir, `**/${FILES_FOLDER_NAME}/**/*`),
+      path.join(contentDir, `**/${SOLUTION_FOLDER_NAME}/**/*`),
       templatesDir,
     ]);
 
@@ -57,12 +57,18 @@ export class WebContainerFiles {
     const { contentDir, templatesDir } = this._folders(projectRoot);
 
     const folders = await glob(
-      [`${contentDir}/**/${FILES_FOLDER_NAME}`, `${contentDir}/**/${SOLUTION_FOLDER_NAME}`, `${templatesDir}/*`],
+      [
+        `${glob.convertPathToPattern(contentDir)}/**/${FILES_FOLDER_NAME}`,
+        `${glob.convertPathToPattern(contentDir)}/**/${SOLUTION_FOLDER_NAME}`,
+        `${glob.convertPathToPattern(templatesDir)}/*`,
+      ],
       { onlyDirectories: true },
     );
 
     await Promise.all(
       folders.map(async (folder) => {
+        folder = path.normalize(folder);
+
         const fileRef = getFilesRef(folder, { contentDir, templatesDir });
         const dest = fileURLToPath(new URL(fileRef, dir));
 
@@ -198,7 +204,7 @@ class FileMapCache {
 }
 
 async function createFileMap(dir: string) {
-  const filePaths = await glob(`${dir}/**/*`, {
+  const filePaths = await glob(`${glob.convertPathToPattern(dir)}/**/*`, {
     onlyFiles: true,
   });
 
@@ -261,5 +267,5 @@ function getFilesRef(pathToFolder: string, { contentDir, templatesDir }: Content
     pathToFolder = 'template' + pathToFolder.slice(templatesDir.length);
   }
 
-  return encodeURIComponent(pathToFolder.replaceAll('/', '-').replaceAll('_', '')) + '.json';
+  return encodeURIComponent(pathToFolder.replaceAll(/[\/\\]+/g, '-').replaceAll('_', '')) + '.json';
 }

packages/cli/package.json

@@ -16,16 +16,17 @@
   "scripts": {
     "build": "node scripts/build.js",
     "prepack": "node scripts/pre-pack.js",
-    "postpack": "node scripts/cleanup.js"
+    "postpack": "node scripts/cleanup.js",
+    "test": "vitest --testTimeout=180000"
   },
   "files": [
     "dist",
     "template",
     "template/.gitignore"
   ],
   "dependencies": {
-    "@babel/parser": "7.24.5",
     "@babel/generator": "7.24.5",
+    "@babel/parser": "7.24.5",
     "@babel/traverse": "7.24.5",
     "@babel/types": "7.24.5",
     "@clack/prompts": "^0.7.0",
@@ -42,7 +43,9 @@
     "@types/yargs-parser": "^21.0.3",
     "esbuild": "^0.20.2",
     "esbuild-node-externals": "^1.13.0",
-    "fs-extra": "^11.2.0"
+    "execa": "^9.2.0",
+    "fs-extra": "^11.2.0",
+    "vitest": "^1.6.0"
   },
   "engines": {
     "node": ">=18.18.0"