Merge pull request #210 from jaredwray/fixing-helpers-to-be-more-func…

…tional fixing helpers to be more functional
jaredwray · Dec 3, 2023 · 8d9a81a · 8d9a81a
2 parents 4026029 + ddced3e
commit 8d9a81a
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 20 deletions.
diff --git a/site/writr.config.ts b/site/writr.config.ts
@@ -1,5 +1,5 @@
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-import writr from '../dist/writr.js';
+
+import writr, {WritrHelpers} from '../dist/writr.js';
 
 export const writrOptions = {
 	templatePath: './template',
@@ -11,15 +11,14 @@ export const writrOptions = {
 	siteUrl: 'https://writr.org',
 };
 
-export async function onPrepare(writrOptions?: any) {
+export function onPrepare(writrOptions?: any) {
 	// Copy the template to the site path
-
-	const removeImage = async (content: string) => content.replace('![Writr](site/logo.png)', '');
-
-	writr.helpers.createDoc(
+	const removeImage = (content: string) => content.replace('![Writr](site/logo.png)', '');
+	const writrHelpers = new WritrHelpers();
+	writrHelpers.createDoc(
 		'../README.md',
 		'./site/README.md',
 		undefined, // No need to set the front matter
-		[removeImage],
+		removeImage,
 	);
 }
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -2,7 +2,7 @@ import fs from 'fs-extra';
 import yaml from 'js-yaml';
 
 export class WritrHelpers {
-	createDoc(path: string, destination: string, frontMatter: Record<string, string>, contentFn?: (content: string) => string): void {
+	createDoc(path: string, destination: string, frontMatter?: Record<string, string>, contentFn?: (content: string) => string): void {
 		const content = fs.readFileSync(path, 'utf8');
 
 		let newContent = this.setFrontMatterInContent(content, frontMatter);
@@ -38,7 +38,11 @@ export class WritrHelpers {
 		fs.writeFileSync(path, newContent, 'utf8');
 	}
 
-	setFrontMatterInContent(content: string, frontMatter: Record<string, string>): string {
+	setFrontMatterInContent(content: string, frontMatter?: Record<string, string>): string {
+		if (!frontMatter) {
+			return content;
+		}
+
 		const match = /^---\r?\n([\s\S]+?)\r?\n---\r?\n([\s\S]*)/.exec(content);
 
 		if (match) {

diff --git a/src/writr.ts b/src/writr.ts
@@ -1,10 +1,8 @@
 import {WritrOptions} from './options.js';
-import {WritrHelpers} from './helpers.js';
 import {WritrConsole} from './console.js';
 
-export class Writr {
+export default class Writr {
 	private _options: WritrOptions = new WritrOptions();
-	private readonly _helpers: WritrHelpers = new WritrHelpers();
 	private readonly _console: WritrConsole = new WritrConsole();
 
 	constructor(options?: WritrOptions) {
@@ -21,10 +19,6 @@ export class Writr {
 		this._options = value;
 	}
 
-	public get helpers(): WritrHelpers {
-		return this._helpers;
-	}
-
 	public execute(process: NodeJS.Process): void {
 		// Get the arguments
 		const args = process.argv.slice(2);
@@ -34,3 +28,5 @@ export class Writr {
 		}
 	}
 }
+
+export {WritrHelpers} from './helpers.js';
diff --git a/test/helpers.test.ts b/test/helpers.test.ts
@@ -62,6 +62,11 @@ describe('WritrHelpers', () => {
 			const newContent = helpers.setFrontMatterInContent('# Hello World', {title: 'Writr1'});
 			expect(newContent).toEqual('---\ntitle: Writr1\n---\n# Hello World');
 		});
+		it('should do nothing with no frontmatter', () => {
+			const helpers = new WritrHelpers();
+			const newContent = helpers.setFrontMatterInContent('# Hello World', undefined);
+			expect(newContent).toEqual('# Hello World');
+		});
 	});
 	describe('setFrontMatterToFile', () => {
 		it('should get and append FrontMatter to new file', () => {

diff --git a/test/writr.test.ts b/test/writr.test.ts
@@ -1,6 +1,6 @@
 import process from 'node:process';
 import {expect, it, describe} from 'vitest';
-import {Writr} from '../src/writr.js';
+import Writr, {WritrHelpers} from '../src/writr.js';
 import {WritrOptions} from '../src/options.js';
 
 const defaultOptions: WritrOptions = new WritrOptions({
@@ -39,11 +39,13 @@ describe('writr', () => {
 	});
 	it('should be able to get the helpers', () => {
 		const writr = new Writr(defaultOptions);
-		expect(writr.helpers).toBeDefined();
+		const writrHelpers = new WritrHelpers();
+		expect(writrHelpers).toBeDefined();
 	});
 	it('should be able to get the helpers via static', () => {
 		const writr = new Writr(defaultOptions);
-		expect(writr.helpers.createDoc).toBeDefined();
+		const writrHelpers = new WritrHelpers();
+		expect(writrHelpers.createDoc).toBeDefined();
 	});
 	it('if no parameters then it should print help', () => {
 		const writr = new Writr(defaultOptions);