Fix tests not being compatible with Windows paths joining

Author: leeyi45

docs/src/lib/dev/devdocs.data.ts

@@ -14,7 +14,7 @@ const filesToInclude = files.filter(each => {
   return each.name !== 'index.md';
 }).map(each => {
   // Paths are resolved relative to the src directory
-  return pathlib.join('/lib/dev', each.name);
+  return pathlib.posix.join('/lib/dev', each.name);
 });
 
 export default createContentLoader(filesToInclude, {

docs/src/modules/2-bundle/3-editing.md

@@ -38,6 +38,14 @@ This adds the dependency to `devDependencies` instead.
 > yarn add @sourceacademy/modules-lib@workspace:^
 > ```
 
+### React Within bundles
+Currently, the way bundles are loaded by `js-slang` means that React cannot be externalized for bundles. `js-slang` simply has no way to provide React
+from the frontend to the bundle.
+
+This means that tools like the React DevTools will not be able to work correctly during development with the frontend.
+
+Refer to the [issue](https://github.com/source-academy/modules/issues/211) tracking this functionality.
+
 ## Bundle Conventions
 To ensure that bundles conform to the different Source language specifications, there are a few rules that bundles need to abide by.
 Refer to [this list](./4-conventions/index) for more information.

docs/src/modules/4-advanced/testing.md

@@ -43,6 +43,8 @@ test('CurveTab', () => {
 })
 ```
 
+For more instructions on how to write tests you can refer to the [Vitest website](https://vitest.dev/guide/#writing-tests).
+
 ## Running Tests
 To run tests for a given bundle or tab, simply run either of the following commands within the directory:
 ```sh

lib/buildtools/build.js

@@ -35,7 +35,7 @@ const command = getBuildCommand({
         const newDirectory = pathlib.relative('./bin', repoRoot);
         return {
           external: true,
-          path: pathlib.join(newDirectory, base),
+          path: pathlib.posix.join(newDirectory, base),
         };
       });
     }

lib/buildtools/src/build/__tests__/all.test.ts

@@ -1,3 +1,4 @@
+import pathlib from 'path';
 import { afterEach, describe, expect, test, vi } from 'vitest';
 import { testMocksDir } from '../../__tests__/fixtures.js';
 import * as docs from '../../build/docs/index.js';
@@ -33,7 +34,7 @@ describe('Test the buildAll command', () => {
   });
 
   describe('Test command with a bundle', () => {
-    const bundlePath = `${testMocksDir}/bundles/test0`;
+    const bundlePath = pathlib.join(testMocksDir, 'bundles', 'test0');
 
     test('Regular execution for a bundle', async () => {
       mockedBuildBundle.mockResolvedValueOnce({
@@ -163,7 +164,7 @@ describe('Test the buildAll command', () => {
   });
 
   describe('Test command with a tab', () => {
-    const tabPath = `${testMocksDir}/tabs/tab0`;
+    const tabPath = pathlib.join(testMocksDir, 'tabs', 'tab0');
 
     test('Regular execution for a tab', async () => {
       mockedBuildTab.mockResolvedValueOnce({

lib/buildtools/src/build/docs/__tests__/index.test.ts

@@ -54,8 +54,8 @@ describe('Test buildSingleBundleDocs', () => {
     const result = await buildSingleBundleDocs(mockBundle, outDir, td.LogLevel.None);
     expectSuccess(result.severity);
 
-    expect(mockGenerateJson).toHaveBeenCalledExactlyOnceWith(project, `${bundlesDir}/test0/dist/docs.json`);
-    expect(fs.mkdir).toHaveBeenCalledExactlyOnceWith(`${outDir}/jsons`, { recursive: true });
+    expect(mockGenerateJson).toHaveBeenCalledExactlyOnceWith(project, pathlib.join(bundlesDir, 'test0', 'dist', 'docs.json'));
+    expect(fs.mkdir).toHaveBeenCalledExactlyOnceWith(pathlib.join(outDir,'jsons'), { recursive: true });
     expect(json.buildJson).toHaveBeenCalledTimes(1);
   });
 });
@@ -68,7 +68,7 @@ describe('Test buildHtml', () => {
     test0: mockBundle,
     test1: {
       type: 'bundle',
-      directory: `${bundlesDir}/test1`,
+      directory: pathlib.join(bundlesDir, 'test1'),
       manifest: {},
       name: 'test1'
     }
@@ -94,8 +94,8 @@ describe('Test buildHtml', () => {
 
     const result = await buildHtml(bundles, outDir, td.LogLevel.None);
     expectSuccess(result.severity);
-    expect(result.path).toEqual(`${outDir}/documentation`);
-    expect(generateDocs).toHaveBeenCalledExactlyOnceWith(project, `${outDir}/documentation`);
+    expect(result.path).toEqual(pathlib.join(outDir, 'documentation'));
+    expect(generateDocs).toHaveBeenCalledExactlyOnceWith(project, pathlib.join(outDir, 'documentation'));
   });
 
   test('Generation of HTML when not all bundles have been generated', async () => {

lib/buildtools/src/build/docs/__tests__/json.test.ts

@@ -1,4 +1,5 @@
 import fs from 'fs/promises';
+import pathlib from 'path';
 import { bundlesDir, outDir } from '@sourceacademy/modules-repotools/getGitRoot';
 import type { ResolvedBundle } from '@sourceacademy/modules-repotools/types';
 import * as td from 'typedoc';
@@ -39,7 +40,7 @@ describe('Test buildJson', () => {
 
     expect(fs.writeFile).toHaveBeenCalledOnce();
     const { calls: [[path, data]] } = mockedWriteFile.mock;
-    expect(path).toEqual(`${outDir}/jsons/test0.json`);
+    expect(path).toEqual(pathlib.join(outDir, 'jsons', 'test0.json'));
     expect(data).toMatchInlineSnapshot(`
       "{
         "test_function": {
@@ -72,7 +73,7 @@ describe('Test buildJson', () => {
 
     expect(fs.writeFile).toHaveBeenCalledOnce();
     const { calls: [[path, data]] } = mockedWriteFile.mock;
-    expect(path).toEqual(`${outDir}/jsons/test0.json`);
+    expect(path).toEqual(pathlib.join(outDir, 'jsons', 'test0.json'));
     expect(data).toMatchInlineSnapshot(`
       "{
         "test_function": {
@@ -106,7 +107,7 @@ describe('Test buildJson', () => {
 
     expect(fs.writeFile).toHaveBeenCalledOnce();
     const { calls: [[path, data]] } = mockedWriteFile.mock;
-    expect(path).toEqual(`${outDir}/jsons/test0.json`);
+    expect(path).toEqual(pathlib.join(outDir, 'jsons', 'test0.json'));
     expect(data).toMatchInlineSnapshot(`
       "{
         "test_function": {

lib/buildtools/src/build/docs/index.ts

@@ -1,4 +1,5 @@
 import fs from 'fs/promises';
+import pathlib from 'path';
 import type { BuildResult, ResolvedBundle, ResultType } from '@sourceacademy/modules-repotools/types';
 import { mapAsync } from '@sourceacademy/modules-repotools/utils';
 import * as td from 'typedoc';
@@ -22,7 +23,7 @@ export async function buildSingleBundleDocs(bundle: ResolvedBundle, outDir: stri
     };
   }
 
-  await app.generateJson(project, `${bundle.directory}/dist/docs.json`);
+  await app.generateJson(project, pathlib.join(bundle.directory, 'dist', 'docs.json'));
 
   if (app.logger.hasErrors()) {
     return {
@@ -33,7 +34,7 @@ export async function buildSingleBundleDocs(bundle: ResolvedBundle, outDir: stri
     };
   }
 
-  await fs.mkdir(`${outDir}/jsons`, { recursive: true });
+  await fs.mkdir(pathlib.join(outDir, 'jsons'), { recursive: true });
   return buildJson(bundle, outDir, project);
 }
 
@@ -45,7 +46,7 @@ type BuildHtmlResult = ResultType;
 export async function buildHtml(bundles: Record<string, ResolvedBundle>, outDir: string, logLevel: td.LogLevel): Promise<BuildHtmlResult> {
   const jsonStats = await mapAsync(Object.values(bundles), async ({ name, directory }) => {
     try {
-      const stats = await fs.stat(`${directory}/dist/docs.json`);
+      const stats = await fs.stat(pathlib.join(directory, 'dist', 'docs.json'));
       return stats.isFile() ? undefined : name;
     } catch {
       return name;
@@ -71,7 +72,7 @@ export async function buildHtml(bundles: Record<string, ResolvedBundle>, outDir:
     };
   }
 
-  await app.generateDocs(project, `${outDir}/documentation`);
+  await app.generateDocs(project, pathlib.join(outDir, 'documentation'));
   if (app.logger.hasErrors()) {
     return {
       severity: 'error',

lib/buildtools/src/build/docs/json.ts

@@ -1,6 +1,6 @@
 // Code for building JSON documentation specifically
-
 import fs from 'fs/promises';
+import pathlib from 'path';
 import type { BuildResult, ResolvedBundle } from '@sourceacademy/modules-repotools/types';
 import * as td from 'typedoc';
 import drawdown from './drawdown.js';
@@ -163,7 +163,7 @@ export async function buildJson(bundle: ResolvedBundle, outDir: string, reflecti
     };
   }
 
-  const outpath = `${outDir}/jsons/${bundle.name}.json`;
+  const outpath = pathlib.join(outDir, 'jsons', `${bundle.name}.json`);
   await fs.writeFile(outpath, JSON.stringify(jsonData, null, 2));
 
   if (warnings.length > 0) {

lib/buildtools/src/build/docs/typedoc.ts

@@ -1,3 +1,4 @@
+import pathlib from 'path';
 import type { ResolvedBundle } from '@sourceacademy/modules-repotools/types';
 import * as td from 'typedoc';
 
@@ -20,8 +21,8 @@ export function initTypedocForJson(bundle: ResolvedBundle, logLevel: td.LogLevel
     ...typedocPackageOptions,
     name: bundle.name,
     logLevel,
-    entryPoints: [`${bundle.directory}/src/index.ts`],
-    tsconfig: `${bundle.directory}/tsconfig.json`,
+    entryPoints: [pathlib.join(bundle.directory, 'src', 'index.ts')],
+    tsconfig: pathlib.join(bundle.directory, 'tsconfig.json')
   });
 }
 
@@ -34,8 +35,8 @@ export function initTypedocForHtml(bundles: Record<string, ResolvedBundle>, logL
     ...typedocPackageOptions,
     name: 'Source Academy Modules',
     logLevel,
-    entryPoints: Object.values(bundles).map(({ directory }) => `${directory}/dist/docs.json`),
+    entryPoints: Object.values(bundles).map(({ directory }) => pathlib.join(directory, 'dist', 'docs.json')),
     entryPointStrategy: 'merge',
-    readme: `${import.meta.dirname}/docsreadme.md`,
+    readme: pathlib.join(import.meta.dirname, 'docsreadme.md'),
   });
 }