Merge pull request #212 from jaredwray/adding-in-init-generation

adding in init generation

init/writr.config.js

@@ -0,0 +1,10 @@
+export const writrOptions = {
+	templatePath: './template',
+	outputPath: './dist',
+	sitePath: './site',
+	githubPath: 'jaredwray/writr',
+	siteTitle: 'Writr',
+	siteDescription: 'Beautiful Website for Your Projects',
+	siteUrl: 'https://writr.org',
+};
+

init/writr.config.ts

@@ -0,0 +1,9 @@
+export const writrOptions = {
+	templatePath: './template',
+	outputPath: './dist',
+	sitePath: './site',
+	githubPath: 'jaredwray/writr',
+	siteTitle: 'Writr',
+	siteDescription: 'Beautiful Website for Your Projects',
+	siteUrl: 'https://writr.org',
+};

package.json

@@ -58,6 +58,7 @@
   },
   "files": [
     "dist",
+    "init",
     "bin"
   ]
 }

src/writr.ts

@@ -38,6 +38,24 @@ export default class Writr {
 		const files = fs.readdirSync(docsPath);
 		return files.length === 0;
 	}
+
+	public generateInit(sitePath: string, isTypescript: boolean): void {
+		// Check if the site path exists
+		if (!fs.existsSync(sitePath)) {
+			fs.mkdirSync(sitePath);
+		}
+
+		// Add the writr.config file based on js or ts
+		const writrConfigFile = isTypescript ? './init/writr.config.ts' : './init/writr.config.js';
+		fs.copyFileSync(writrConfigFile, `${sitePath}/writr.config.${isTypescript ? 'ts' : 'js'}`);
+
+		// Add in the image and favicon
+		fs.copyFileSync('./init/logo.png', `${sitePath}/logo.png`);
+		fs.copyFileSync('./init/favicon.svg', `${sitePath}/favicon.svg`);
+
+		// Output the instructions
+		this._console.log(`Writr initialized. Please update the ${writrConfigFile} file with your site information. In addition, you can replace the image, favicon, and stype the site with site.css file.`);
+	}
 }
 
 export {WritrHelpers} from './helpers.js';

test/writr.test.ts

@@ -1,5 +1,6 @@
 import process from 'node:process';
 import {expect, it, describe} from 'vitest';
+import fs from 'fs-extra';
 import Writr, {WritrHelpers} from '../src/writr.js';
 import {WritrOptions} from '../src/options.js';
 
@@ -68,4 +69,52 @@ describe('writr', () => {
 		expect(writr.isSinglePageWebsite(singlePageSite)).toEqual(true);
 		expect(writr.isSinglePageWebsite(multiPageSite)).toEqual(false);
 	});
+	it('should generate the site init files and folders', () => {
+		const writr = new Writr(defaultOptions);
+		const consoleLog = console.log;
+		let consoleMessage = '';
+		const temporarySitePath = './temp-site';
+		console.log = message => {
+			/* eslint-disable-next-line @typescript-eslint/no-unsafe-assignment */
+			consoleMessage = message;
+		};
+
+		try {
+			writr.generateInit(temporarySitePath, true);
+
+			expect(consoleMessage).toContain('Writr initialized.');
+			console.log = consoleLog;
+
+			expect(fs.existsSync(temporarySitePath)).toEqual(true);
+			expect(fs.existsSync(`${temporarySitePath}/writr.config.ts`)).toEqual(true);
+			expect(fs.existsSync(`${temporarySitePath}/logo.png`)).toEqual(true);
+			expect(fs.existsSync(`${temporarySitePath}/favicon.svg`)).toEqual(true);
+		} finally {
+			fs.rmdirSync(temporarySitePath, {recursive: true});
+		}
+	});
+	it('should generate the site init files and folders for javascript', () => {
+		const writr = new Writr(defaultOptions);
+		const consoleLog = console.log;
+		let consoleMessage = '';
+		const temporarySitePath = './temp-site-js';
+		console.log = message => {
+			/* eslint-disable-next-line @typescript-eslint/no-unsafe-assignment */
+			consoleMessage = message;
+		};
+
+		try {
+			writr.generateInit(temporarySitePath, false);
+
+			expect(consoleMessage).toContain('Writr initialized.');
+			console.log = consoleLog;
+
+			expect(fs.existsSync(temporarySitePath)).toEqual(true);
+			expect(fs.existsSync(`${temporarySitePath}/writr.config.js`)).toEqual(true);
+			expect(fs.existsSync(`${temporarySitePath}/logo.png`)).toEqual(true);
+			expect(fs.existsSync(`${temporarySitePath}/favicon.svg`)).toEqual(true);
+		} finally {
+			fs.rmdirSync(temporarySitePath, {recursive: true});
+		}
+	});
 });