Merge pull request #241 from jaredwray/moving-to-an-ESM-module

moving to an ESM module

bin/writr.mjs

@@ -0,0 +1,8 @@
+#!/usr/bin/env ts-node
+
+import * as process from 'node:process';
+import Writr from '../dist/writr.js';
+
+const writr = new Writr();
+
+await writr.execute(process);

init/writr.config.js → init/writr.config.cjs

@@ -1,4 +1,4 @@
-export const writrOptions = {
+module.exports.options = {
 	templatePath: './template',
 	outputPath: './dist',
 	sitePath: './site',

package.json

@@ -2,6 +2,7 @@
   "name": "writr",
   "version": "2.0.0",
   "description": "Beautiful Website for Your Projects",
+  "type": "module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "repository": "https://github.com/jaredwray/writr.git",
@@ -28,12 +29,12 @@
   ],
   "scripts": {
     "clean": "rimraf ./dist ./coverage ./node_modules ./package-lock.json ./yarn.lock",
-    "build": "rimraf ./dist && tsc --project ./tsconfig.build.json",
+    "build": "rimraf ./dist && tsc",
     "test": "xo --fix && vitest run --coverage",
     "prepare": "yarn run build"
   },
   "bin": {
-    "writr": "./bin/writr.js"
+    "writr": "./bin/writr.mjs"
   },
   "dependencies": {
     "axios": "^1.6.2",
@@ -63,7 +64,8 @@
   "xo": {
     "ignores": [
       "writr.config.*",
-      "vitest.config.mjs"
+      "vitest.config.mjs",
+      "bin/writr.js"
     ]
   },
   "files": [

site/variables.css

@@ -1,30 +1,30 @@
 :root {
-    --font-family: 'Open Sans', sans-serif;
-  
-    --color-primary:  #322d3c;
-    --color-secondary: #8cdc00;
-    --color-secondary-dark: #8cdc00;
-    --color-text: #322d3c;
-  
-    --background: #ffffff;
-    --home-background: #ffffff;
-    --header-background: #ffffff;
-  
-    --sidebar-background: #ffffff;
-    --sidebar-text: #322d3c;
-    --sidebar-text-active: #7d7887;
-  
-    --border: rgba(238,238,245,1);
-  
-    --background-search-highlight: var(--color-secondary-dark);
-    --color-search-highlight: #ffffff;
-    --search-input-background: var(--header-background);
-  
-    --code: rgba(238,238,245,1);
-  
-    --pagefind-ui-text: var(--color-text) !important;
-    --pagefind-ui-font: var(--font-family) !important;
-    --pagefind-ui-background: var(--background) !important;
-    --pagefind-ui-border: var(--border) !important;
-    --pagefind-ui-scale: .9 !important;
-  }
+  --font-family: 'Open Sans', sans-serif;
+
+  --color-primary:  #08c2ff;
+  --color-secondary: #bd72d1;
+  --color-secondary-dark: #af34d0;
+  --color-text: #322d3c;
+
+  --background: #ffffff;
+  --home-background: #F0F2FA;
+  --header-background: #fbfbfb;
+
+  --sidebar-background: #ffffff;
+  --sidebar-text: #322d3c;
+  --sidebar-text-active: #08c2ff;
+
+  --border: rgba(238,238,245,1);
+
+  --background-search-highlight: var(--color-secondary-dark);
+  --color-search-highlight: #ffffff;
+  --search-input-background: var(--header-background);
+
+  --code: rgba(238,238,245,1);
+
+  --pagefind-ui-text: var(--color-text) !important;
+  --pagefind-ui-font: var(--font-family) !important;
+  --pagefind-ui-background: var(--background) !important;
+  --pagefind-ui-border: var(--border) !important;
+  --pagefind-ui-scale: .9 !important;
+}

site/writr.config.cjs

@@ -0,0 +1,7 @@
+module.exports.options = {
+	templatePath: './template',
+	githubPath: 'jaredwray/writr',
+	siteTitle: 'Writr',
+	siteDescription: 'Beautiful Website for Your Projects',
+	siteUrl: 'https://writr.org',
+};

src/builder.ts

@@ -67,6 +67,28 @@ export class WritrBuilder {
 		// Build the robots.txt (/robots.txt)
 		await this.buildRobotsPage(this.options);
 
+		const siteRelativePath = this.options.sitePath;
+
+		// Copy over favicon
+		if (await fs.pathExists(`${siteRelativePath}/favicon.ico`)) {
+			await fs.copy(`${siteRelativePath}/favicon.ico`, `${this.options.outputPath}/favicon.ico`);
+		}
+
+		// Copy over logo
+		if (await fs.pathExists(`${siteRelativePath}/logo.png`)) {
+			await fs.copy(`${siteRelativePath}/logo.png`, `${this.options.outputPath}/logo.png`);
+		}
+
+		// Copy over css
+		if (await fs.pathExists(`${this.options.templatePath}/css`)) {
+			await fs.copy(`${this.options.templatePath}/css`, `${this.options.outputPath}/css`);
+		}
+
+		// Copy over variables
+		if (await fs.pathExists(`${siteRelativePath}/variables.css`)) {
+			await fs.copy(`${siteRelativePath}/variables.css`, `${this.options.outputPath}/css/variables.css`);
+		}
+
 		const endTime = Date.now();
 
 		const executionTime = endTime - startTime;

src/console.ts

@@ -1,3 +1,6 @@
+import path from 'node:path';
+import process from 'node:process';
+
 export class WritrConsole {
 	log(message: string): void {
 		console.log(message);
@@ -103,6 +106,7 @@ export class WritrConsole {
 				case '-o':
 				case '--output': {
 					args.output = argv[i + 1];
+					args.output = path.join(process.cwd(), args.output);
 					break;
 				}
 
@@ -115,12 +119,14 @@ export class WritrConsole {
 				case '-s':
 				case '--site': {
 					args.sitePath = argv[i + 1];
+					args.sitePath = path.join(process.cwd(), args.sitePath);
 					break;
 				}
 
 				case '-t':
 				case '--templatePath': {
 					args.templatePath = argv[i + 1];
+					args.templatePath = path.join(process.cwd(), args.templatePath);
 					break;
 				}
 			}

src/options.ts

@@ -1,3 +1,5 @@
+import path from 'node:path';
+import process from 'node:process';
 
 export class WritrOptions {
 	public templatePath = './template';
@@ -18,14 +20,17 @@ export class WritrOptions {
 	public parseOptions(options: Record<string, any>) {
 		if (options.templatePath) {
 			this.templatePath = options.templatePath as string;
+			this.templatePath = path.join(process.cwd(), this.templatePath);
 		}
 
 		if (options.outputPath) {
 			this.outputPath = options.outputPath as string;
+			this.githubPath = path.join(process.cwd(), this.outputPath);
 		}
 
 		if (options.sitePath) {
 			this.sitePath = options.sitePath as string;
+			this.sitePath = path.join(process.cwd(), this.sitePath);
 		}
 
 		if (options.githubPath) {

src/writr.ts

@@ -1,9 +1,10 @@
 import type http from 'node:http';
+import path from 'node:path';
+import process from 'node:process';
 import fs from 'fs-extra';
 import updateNotifier from 'update-notifier';
 import express from 'express';
 import {register} from 'ts-node';
-import packageJson from '../package.json';
 import {WritrOptions} from './options.js';
 import {WritrConsole} from './console.js';
 import {WritrBuilder} from './builder.js';
@@ -37,9 +38,26 @@ export default class Writr {
 		return this._configFileModule;
 	}
 
+	public checkForUpdates(): void {
+		const packageJsonPath = path.join(process.cwd(), 'package.json');
+		if (fs.existsSync(packageJsonPath)) {
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+			const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+			updateNotifier({pkg: packageJson}).notify();
+		}
+	}
+
 	public async execute(process: NodeJS.Process): Promise<void> {
 		// Check for updates
-		updateNotifier({pkg: packageJson}).notify();
+		this.checkForUpdates();
+
+		const consoleProcess = this._console.parseProcessArgv(process.argv);
+
+		// Update options
+		if (consoleProcess.args.sitePath) {
+			this.options.sitePath = consoleProcess.args.sitePath;
+		}
 
 		// Load the Config File
 		await this.loadConfigFile(this.options.sitePath);
@@ -50,20 +68,13 @@ export default class Writr {
 		}
 
 		// Run the onPrepare function
-		try {
-			if (this._configFileModule.onPrepare) {
+		if (this._configFileModule.onPrepare) {
+			try {
 				// eslint-disable-next-line @typescript-eslint/no-unsafe-call
 				await this._configFileModule.onPrepare(this.options);
+			} catch (error) {
+				this._console.error((error as Error).message);
 			}
-		} catch (error) {
-			this._console.error((error as Error).message);
-		}
-
-		const consoleProcess = this._console.parseProcessArgv(process.argv);
-
-		// Update options
-		if (consoleProcess.args.sitePath) {
-			this.options.sitePath = consoleProcess.args.sitePath;
 		}
 
 		if (consoleProcess.args.output) {
@@ -73,7 +84,7 @@ export default class Writr {
 		switch (consoleProcess.command) {
 			case 'init': {
 				const isTypescript = fs.existsSync('./tsconfig.json') ?? false;
-				this.generateInit(this.options.sitePath, isTypescript);
+				this.generateInit(this.options.sitePath);
 				break;
 			}
 
@@ -112,15 +123,15 @@ export default class Writr {
 		return files.length === 0;
 	}
 
-	public generateInit(sitePath: string, isTypescript: boolean): void {
+	public generateInit(sitePath: string): 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'}`);
+		const writrConfigFile = './init/writr.config.cjs';
+		fs.copyFileSync(writrConfigFile, `${sitePath}/writr.config.cjs`);
 
 		// Add in the image and favicon
 		fs.copyFileSync('./init/logo.png', `${sitePath}/logo.png`);
@@ -141,15 +152,8 @@ export default class Writr {
 
 	public async loadConfigFile(sitePath: string): Promise<void> {
 		if (fs.existsSync(sitePath)) {
-			const isTypescript = fs.existsSync(`${sitePath}/writr.config.ts`);
-			const configFile = isTypescript ? `${sitePath}/writr.config.ts` : `${sitePath}/writr.config.js`;
-			if (isTypescript) {
-				// Typescript
-				register({transpileOnly: true});
-				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-				this._configFileModule = await import(configFile);
-			} else {
-				// Javascript
+			const configFile = `${sitePath}/writr.config.cjs`;
+			if (fs.existsSync(configFile)) {
 				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 				this._configFileModule = await import(configFile);
 			}

test/builder.test.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
 import {afterEach, beforeEach, expect, it, describe, vi} from 'vitest';
 import * as fs from 'fs-extra';
 import axios from 'axios';
@@ -61,7 +62,7 @@ describe('WritrBuilder', () => {
 		try {
 			await builder.build();
 		} finally {
-			await fs.remove(builder.options.outputPath);
+			await fs.rm(builder.options.outputPath, {recursive: true});
 		}
 
 		expect(consoleMessage).toContain('Build');