Renaming the _site directory to site.

adrianwebb · adrianwebb · commit 572eb545ffc6 · 2025-12-16T19:14:08.000-05:00
diff --git a/README.md b/README.md
@@ -124,36 +124,36 @@ npx astrical init <directory> [options]
 
 #### `dev`
 
-Starts the development server in ephemeral mode. It constructs a temporary build environment in `_site` and runs the Astro dev server with Hot Module Replacement (HMR).
+Starts the development server in ephemeral mode. It constructs a temporary build environment in `site` and runs the Astro dev server with Hot Module Replacement (HMR).
 
 **Usage:**
 ```bash
 npx astrical dev
 ```
 
 **What it does:**
-1.  **Prepares** the `_site` directory by mounting `src/core`, `src/modules`, and content.
+1.  **Prepares** the `site` directory by mounting `src/core`, `src/modules`, and content.
 2.  **Starts** the Astro development server (accessible at `http://localhost:4321` by default).
 3.  **Watches** for changes in your project and updates the ephemeral build automatically.
 
 ---
 
 #### `build`
 
-Compiles the project for production. It assembles the final site structure in `_site` and generates static assets.
+Compiles the project for production. It assembles the final site structure in `site` and generates static assets.
 
 **Usage:**
 ```bash
 npx astrical build
 ```
 
 **What it does:**
-1.  **Cleans** the `_site` directory to ensure a fresh build.
-2.  **Copies** all necessary source files (`src/core`, `src/modules`, `src/content`, `public`) into `_site`.
-3.  **Runs** `astro build` to generate the production output in `_site/dist`.
+1.  **Cleans** the `site` directory to ensure a fresh build.
+2.  **Copies** all necessary source files (`src/core`, `src/modules`, `src/content`, `public`) into `site`.
+3.  **Runs** `astro build` to generate the production output in `site/dist`.
 
 **Output:**
-- A production-ready static site in `_site/dist`.
+- A production-ready static site in `site/dist`.
 
 ---
 
@@ -170,7 +170,7 @@ npx astrical preview
 - You must run `astrical build` first.
 
 **What it does:**
-- Starts a local web server serving the static files from `_site/dist`.
+- Starts a local web server serving the static files from `site/dist`.
 
 ---
 
@@ -184,7 +184,7 @@ npx astrical clean
 ```
 
 **What it does:**
-- Deletes `_site`, `dist`, and `node_modules/.vite`.
+- Deletes `site`, `dist`, and `node_modules/.vite`.
 
 ---
 
diff --git a/src/commands/build.ts b/src/commands/build.ts
@@ -13,7 +13,7 @@ export default class BuildCommand extends BaseCommand {
             return;
         }
 
-        const siteDir = path.resolve(this.projectRoot, '_site');
+        const siteDir = path.resolve(this.projectRoot, 'site');
 
         try {
             logger.debug(`Preparing environment at: ${this.projectRoot}`);
diff --git a/src/commands/clean.ts b/src/commands/clean.ts
@@ -18,7 +18,7 @@ export default class CleanCommand extends BaseCommand {
             path.join(coreDir, 'node_modules'),
             path.join(coreDir, 'dist'),
             'node_modules',
-            '_site'
+            'site'
         ];
 
         for (const target of targets) {
diff --git a/src/commands/dev.ts b/src/commands/dev.ts
@@ -15,7 +15,7 @@ export default class DevCommand extends BaseCommand {
             return;
         }
 
-        const siteDir = path.resolve(this.projectRoot, '_site');
+        const siteDir = path.resolve(this.projectRoot, 'site');
 
         this.info('Initializing ephemeral build environment...');
 
diff --git a/src/commands/preview.ts b/src/commands/preview.ts
@@ -15,7 +15,7 @@ export default class PreviewCommand extends BaseCommand {
             return;
         }
 
-        const siteDir = path.resolve(this.projectRoot, '_site');
+        const siteDir = path.resolve(this.projectRoot, 'site');
         const distDir = path.join(siteDir, 'dist');
 
         logger.debug('Preview paths:', { siteDir, distDir });
diff --git a/src/commands/run.ts b/src/commands/run.ts
@@ -32,7 +32,7 @@ export default class RunCommand extends BaseCommand {
         }
 
         await linkEnvironment(this.projectRoot!);
-        const siteDir = path.resolve(this.projectRoot!, '_site');
+        const siteDir = path.resolve(this.projectRoot!, 'site');
 
         logger.debug('Run command context:', { script, args: scriptArgs, siteDir });
 
diff --git a/src/utils/environment.ts b/src/utils/environment.ts
@@ -3,7 +3,7 @@ import fs from 'fs-extra';
 import path from 'path';
 
 export async function linkEnvironment(projectRoot: string) {
-    const siteDir = path.resolve(projectRoot, '_site');
+    const siteDir = path.resolve(projectRoot, 'site');
     const srcDir = path.resolve(projectRoot, 'src');
     const coreDir = path.resolve(srcDir, 'core');
     const modulesDir = path.resolve(srcDir, 'modules');
@@ -13,10 +13,10 @@ export async function linkEnvironment(projectRoot: string) {
 
     logger.debug('Preparing environment paths:', { siteDir, srcDir });
 
-    // 1. Ensure _site exists (recreate it cleanly to remove old links)
+    // 1. Ensure site exists (recreate it cleanly to remove old links)
     await fs.remove(siteDir);
 
-    // 2. Symlink Core -> _site
+    // 2. Symlink Core -> site
     if (await fs.pathExists(coreDir)) {
         await fs.ensureSymlink(coreDir, siteDir, 'junction');
     } else {
@@ -54,7 +54,7 @@ export async function linkEnvironment(projectRoot: string) {
 
 
 export async function copyEnvironment(projectRoot: string) {
-    const siteDir = path.resolve(projectRoot, '_site');
+    const siteDir = path.resolve(projectRoot, 'site');
     const srcDir = path.resolve(projectRoot, 'src');
     const coreDir = path.resolve(srcDir, 'core');
     const modulesDir = path.resolve(srcDir, 'modules');
@@ -64,7 +64,7 @@ export async function copyEnvironment(projectRoot: string) {
 
     logger.debug('Build paths resolved:', { siteDir, srcDir, coreDir, modulesDir, contentDir, publicDir });
 
-    // 1. Clean _site
+    // 1. Clean site
     logger.debug(`Cleaning site directory: ${siteDir}`);
     await fs.remove(siteDir);
     await fs.ensureDir(siteDir);
diff --git a/test/e2e/lifecycle.e2e.test.ts b/test/e2e/lifecycle.e2e.test.ts
@@ -152,7 +152,7 @@ if (args[0] === 'build') {
         const cleanResult = await runCLI(['clean'], projectDir, { env });
 
         expect(cleanResult.exitCode).toBe(0);
-        expect(fs.existsSync(path.join(projectDir, '_site'))).toBe(false);
+        expect(fs.existsSync(path.join(projectDir, 'site'))).toBe(false);
 
     }, 120000); // Long timeout for full chain
 });
diff --git a/test/integration/commands/build.integration.test.ts b/test/integration/commands/build.integration.test.ts
@@ -64,8 +64,8 @@ describe('BuildCommand Integration', () => {
 
         await command.run({});
 
-        // 1. Verify _site assembly
-        const siteDir = path.join(projectDir, '_site');
+        // 1. Verify site assembly
+        const siteDir = path.join(projectDir, 'site');
         expect(fs.existsSync(siteDir)).toBe(true);
         expect(fs.existsSync(path.join(siteDir, 'index.astro'))).toBe(true);
         expect(fs.existsSync(path.join(siteDir, 'content', 'config.ts'))).toBe(true);
@@ -76,7 +76,7 @@ describe('BuildCommand Integration', () => {
         expect(execMock).toHaveBeenCalledWith(
             expect.stringContaining('npm run build'),
             expect.objectContaining({
-                cwd: expect.stringContaining('_site')
+                cwd: expect.stringContaining('site')
             }),
             expect.anything()
         );
diff --git a/test/integration/commands/clean.integration.test.ts b/test/integration/commands/clean.integration.test.ts
@@ -11,8 +11,8 @@ describe('CleanCommand Integration', () => {
     beforeEach(async () => {
         tempDir = await createTempDir('clean-integration-');
         // Setup initial state
-        await fs.ensureDir(path.join(tempDir, '_site'));
-        await fs.outputFile(path.join(tempDir, '_site', 'index.html'), '<html></html>');
+        await fs.ensureDir(path.join(tempDir, 'site'));
+        await fs.outputFile(path.join(tempDir, 'site', 'index.html'), '<html></html>');
         await fs.ensureDir(path.join(tempDir, 'node_modules'));
         await fs.outputFile(path.join(tempDir, 'node_modules', 'pkg.json'), '{}');
     });
@@ -21,7 +21,7 @@ describe('CleanCommand Integration', () => {
         if (tempDir) await fs.remove(tempDir);
     });
 
-    it('should remove _site and node_modules directories', async () => {
+    it('should remove site and node_modules directories', async () => {
         const cli = new CLI({ commandName: 'astrical' });
         const command = new CleanCommand(cli);
 
@@ -31,7 +31,7 @@ describe('CleanCommand Integration', () => {
 
             await command.run({});
 
-            expect(fs.existsSync(path.join(tempDir, '_site'))).toBe(false);
+            expect(fs.existsSync(path.join(tempDir, 'site'))).toBe(false);
             expect(fs.existsSync(path.join(tempDir, 'node_modules'))).toBe(false);
         } finally {
             process.chdir(originalCwd);
diff --git a/test/integration/commands/dev_preview.integration.test.ts b/test/integration/commands/dev_preview.integration.test.ts
@@ -21,8 +21,8 @@ describe('Dev/Preview Integration', () => {
         projectDir = await createTempDir('dev-preview-');
         vi.mocked(spawn).mockClear();
         await fs.ensureDir(path.join(projectDir, 'src', 'core'));
-        // Preview command checks for _site/dist
-        await fs.ensureDir(path.join(projectDir, '_site', 'dist'));
+        // Preview command checks for site/dist
+        await fs.ensureDir(path.join(projectDir, 'site', 'dist'));
 
         spawnMock = vi.mocked(spawn).mockImplementation(() => {
             const child: any = new EventEmitter();
@@ -60,7 +60,7 @@ describe('Dev/Preview Integration', () => {
             expect.stringContaining('node_modules/.bin/astro'),
             ['dev'],
             expect.objectContaining({
-                cwd: expect.stringContaining('_site')
+                cwd: expect.stringContaining('site')
             })
         );
     });
@@ -76,7 +76,7 @@ describe('Dev/Preview Integration', () => {
             expect.stringContaining('node_modules/.bin/astro'),
             ['preview'],
             expect.objectContaining({
-                cwd: expect.stringContaining('_site')
+                cwd: expect.stringContaining('site')
             })
         );
     });
diff --git a/test/integration/commands/run.integration.test.ts b/test/integration/commands/run.integration.test.ts
@@ -35,8 +35,8 @@ describe('RunCommand Integration', () => {
             }
         }));
 
-        await fs.ensureDir(path.join(projectDir, '_site'));
-        await fs.outputFile(path.join(projectDir, '_site', 'package.json'), JSON.stringify({
+        await fs.ensureDir(path.join(projectDir, 'site'));
+        await fs.outputFile(path.join(projectDir, 'site', 'package.json'), JSON.stringify({
             scripts: {
                 'test-script': 'echo test'
             }
@@ -72,7 +72,7 @@ describe('RunCommand Integration', () => {
             'npm',
             ['run', 'test-script', '--', '--flag'],
             expect.objectContaining({
-                cwd: expect.stringContaining('_site')
+                cwd: expect.stringContaining('site')
             })
         );
     });
diff --git a/test/integration/utils/environment.integration.test.ts b/test/integration/utils/environment.integration.test.ts
@@ -30,7 +30,7 @@ describe('Environment Integration', () => {
         await linkEnvironment(projectRoot);
 
         // Verify
-        const resultDir = path.join(projectRoot, '_site/public');
+        const resultDir = path.join(projectRoot, 'site/public');
         expect(await fs.pathExists(resultDir)).toBe(true);
 
         // Should be symlink to Starter public dir
@@ -53,7 +53,7 @@ describe('Environment Integration', () => {
         await linkEnvironment(projectRoot);
 
         // Verify
-        const resultItem = path.join(projectRoot, '_site/content');
+        const resultItem = path.join(projectRoot, 'site/content');
         expect(await fs.pathExists(resultItem)).toBe(true);
 
         // Should be symlink to Starter content dir
@@ -76,7 +76,7 @@ describe('Environment Integration', () => {
         await linkEnvironment(projectRoot);
 
         // Verify
-        const resultItem = path.join(projectRoot, '_site/modules');
+        const resultItem = path.join(projectRoot, 'site/modules');
         expect(await fs.pathExists(resultItem)).toBe(true);
 
         // Should be symlink to Starter modules dir
diff --git a/test/unit/commands/build.test.ts b/test/unit/commands/build.test.ts
@@ -77,7 +77,7 @@ describe('BuildCommand', () => {
 
         expect(runCommand).toHaveBeenCalledWith(
             'npm run build',
-            expect.stringContaining('_site')
+            expect.stringContaining('site')
         );
 
         expect(command.success).toHaveBeenCalledWith(expect.stringContaining('Build completed'));
diff --git a/test/unit/commands/clean.test.ts b/test/unit/commands/clean.test.ts
@@ -40,21 +40,21 @@ describe('CleanCommand', () => {
     it('should remove targets if they exist', async () => {
         // Mock targets existing
         vi.mocked(fs.pathExists).mockImplementation(async (p: string) => {
-            return p.includes('_site') || p.includes('dist');
+            return p.includes('site') || p.includes('dist');
         });
 
-        await command.run();
+        await command.run({});
 
-        expect(fs.remove).toHaveBeenCalledWith(expect.stringContaining('_site'));
+        expect(fs.remove).toHaveBeenCalledWith(expect.stringContaining('site'));
         expect(fs.remove).toHaveBeenCalledWith(expect.stringContaining('dist'));
         // node_modules/.vite shouldn't be removed if not returning true for pathExists
-        // But our mock logic returns true for _site and dist only? 
+        // But our mock logic returns true for site and dist only? 
         // Let's refine mock to be cleaner
     });
 
     it('should log success', async () => {
         const spy = vi.spyOn(command, 'success').mockImplementation(() => { });
-        await command.run();
+        await command.run({});
         expect(spy).toHaveBeenCalledWith(expect.stringContaining('cleaned'));
     });
 });
diff --git a/test/unit/commands/dev.test.ts b/test/unit/commands/dev.test.ts
@@ -79,7 +79,7 @@ describe('DevCommand', () => {
             expect.stringContaining('astro'),
             ['dev'],
             expect.objectContaining({
-                cwd: expect.stringContaining('_site'),
+                cwd: expect.stringContaining('site'),
                 stdio: 'inherit'
             })
         );
diff --git a/test/unit/commands/preview.test.ts b/test/unit/commands/preview.test.ts
@@ -67,7 +67,7 @@ describe('PreviewCommand', () => {
             expect.stringContaining('astro'),
             ['preview'],
             expect.objectContaining({
-                cwd: expect.stringContaining('_site')
+                cwd: expect.stringContaining('site')
             })
         );
     });
diff --git a/test/unit/commands/run.test.ts b/test/unit/commands/run.test.ts
@@ -92,7 +92,7 @@ describe('RunCommand', () => {
         // It is mocked at line 18: vi.mock(..., () => ({ linkEnvironment: vi.fn().mockResolvedValue(undefined) }))
 
         expect(cp.spawn).toHaveBeenCalledWith('npm', ['run', 'test', '--'], expect.objectContaining({
-            cwd: expect.stringContaining('_site')
+            cwd: expect.stringContaining('site')
         }));
     });
 
diff --git a/test/unit/utils/environment.test.ts b/test/unit/utils/environment.test.ts

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ export default class BuildCommand extends BaseCommand {`
`13`	`13`	`return;`
`14`	`14`	`}`
`15`	`15`
`16`		`- const siteDir = path.resolve(this.projectRoot, '_site');`
	`16`	`+ const siteDir = path.resolve(this.projectRoot, 'site');`
`17`	`17`
`18`	`18`	`try {`
`19`	`19`	logger.debug(`Preparing environment at: ${this.projectRoot}`);
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ export default class DevCommand extends BaseCommand {`
`15`	`15`	`return;`
`16`	`16`	`}`
`17`	`17`
`18`		`- const siteDir = path.resolve(this.projectRoot, '_site');`
	`18`	`+ const siteDir = path.resolve(this.projectRoot, 'site');`
`19`	`19`
`20`	`20`	`this.info('Initializing ephemeral build environment...');`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ export default class RunCommand extends BaseCommand {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`await linkEnvironment(this.projectRoot!);`
`35`		`- const siteDir = path.resolve(this.projectRoot!, '_site');`
	`35`	`+ const siteDir = path.resolve(this.projectRoot!, 'site');`
`36`	`36`
`37`	`37`	`logger.debug('Run command context:', { script, args: scriptArgs, siteDir });`
`38`	`38`