Prevent the root from being deleted during the build

withastro · Sep 22, 2022 · 18b81b4 · 18b81b4
1 parent e9eb4d1
commit 18b81b4
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 0 deletions.
diff --git a/packages/astro/src/core/build/index.ts b/packages/astro/src/core/build/index.ts
@@ -91,6 +91,7 @@ class AstroBuilder {
 			serverEntry: 'entry.mjs',
 		};
 		await runHookBuildStart({ config: this.settings.config, buildConfig, logging: this.logging });
+		this.validateConfig();
 
 		info(this.logging, 'build', `output target: ${colors.green(this.settings.config.output)}`);
 		if (this.settings.adapter) {
@@ -171,6 +172,15 @@ class AstroBuilder {
 		}
 	}
 
+	private validateConfig() {
+		const { config } = this.settings;
+
+		// outDir gets blown away so it can't be the root.
+		if(config.outDir.toString() === config.root.toString()) {
+			throw new Error(`the outDir cannot be the root folder. Please build to a folder such as dist.`);
+		}
+	}
+
 	/** Stats */
 	private async printStats({
 		logging,

diff --git a/packages/astro/test/dont-delete-root.test.js b/packages/astro/test/dont-delete-root.test.js
@@ -0,0 +1,40 @@
+import { expect } from 'chai';
+import { loadFixture } from './test-utils.js';
+import * as fs from 'fs';
+
+describe('outDir set to project root', async () => {
+	/** @type {import('./test-utils').Fixture} */
+	let fixture;
+
+	/** @type {Error | undefined} */
+	let error;
+
+	before(async () => {
+		fixture = await loadFixture({ root: './fixtures/dont-delete-me/' });
+		try {
+			await fixture.build();
+		} catch(err) {
+			error = err;
+		}
+	});
+
+	it('Throws an error when you attempt to build', async () => {
+		expect(error).to.be.an.instanceOf(Error);
+		expect(error.message).to.match(/outDir cannot be the root folder/);
+	});
+
+	it('Files have not been deleted', async () => {
+		const expectedFiles = [
+			'package.json',
+			'astro.config.mjs',
+			'src/pages/index.astro'
+		];
+
+		for(const rel of expectedFiles) {
+			const root = new URL('./fixtures/dont-delete-me/', import.meta.url);
+			const url = new URL('./' + rel, root);
+			const stats = await fs.promises.stat(url);
+			expect(stats).to.not.be.undefined;
+		}
+	});
+});
diff --git a/packages/astro/test/fixtures/dont-delete-me/astro.config.mjs b/packages/astro/test/fixtures/dont-delete-me/astro.config.mjs
@@ -0,0 +1,5 @@
+import { defineConfig } from 'astro/config';
+
+export default defineConfig({
+	outDir: './'
+});
diff --git a/packages/astro/test/fixtures/dont-delete-me/package.json b/packages/astro/test/fixtures/dont-delete-me/package.json
@@ -0,0 +1,6 @@
+{
+  "name": "@test/dont-delete-me",
+  "dependencies": {
+    "astro": "workspace:*"
+  }
+}
diff --git a/packages/astro/test/fixtures/dont-delete-me/src/pages/index.astro b/packages/astro/test/fixtures/dont-delete-me/src/pages/index.astro
@@ -0,0 +1,8 @@
+<html>
+<head>
+	<title>Testing</title>
+</head>
+<body>
+
+</body>
+</html>
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml