fixed another bug with global modules

Author: CodingAP

.github/workflows/publish.yml

@@ -1,32 +1,32 @@
 name: Publish
 on:
-  push:
-    branches:
-      - main
+    push:
+        branches:
+            - main
 
 jobs:
-  publish:
-    runs-on: ubuntu-latest
+    publish:
+        runs-on: ubuntu-latest
 
-    permissions:
-      contents: read
-      id-token: write
+        permissions:
+            contents: read
+            id-token: write
 
-    steps:
-      - name: Clone repository
-        uses: actions/checkout@v4
+        steps:
+            - name: Clone repository
+              uses: actions/checkout@v4
 
-      - name: Install Deno
-        uses: denoland/setup-deno@v2
-        with:
-          deno-version: v2.x
+            - name: Install Deno
+              uses: denoland/setup-deno@v2
+              with:
+                  deno-version: v2.x
 
-      - name: Format and lint
-        run: deno task format
+            - name: Format and lint
+              run: deno task format
 
-      - name: Run tests
-        run: deno task test
+            - name: Run tests
+              run: deno task test
 
-      - name: Publish package
-        if: success()
-        run: deno publish --allow-dirty
+            - name: Publish package
+              if: success()
+              run: deno publish --allow-dirty

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
     "deno.enable": true,
-    "deno.lint": true,
-}
+    "deno.lint": true
+}

README.md

@@ -1,47 +1,52 @@
 ## STEVE
+
 `STEVE` is a configurable template engine that allows JavaScript to run in files to create files. It has a plugin system to allow for custom generation and a built-in site generator.
 
-***ST***atic Sit***E*** Generator (***VE***ry cool)
+***ST***atic Sit_**E**_ Generator (***VE***ry cool)
 
 ### by AP
+
 #### Last Modified 11/18/24
 
 ## Features
 
 `STEVE` supports many features including:
+
 - Template engine that uses JavaScript to process the text
 - Built-in site generator plugin with highly customizable options
 - Plugin support to create different types of generators
 
 ## About The Project
+
 I wanted to make a more official repository as my original goal, but I also wanted to create a file generator that I can use and expand upon because I do file generation a lot more than I thought I would. The product of this is `STEVE`, which has a template engine and plugin system.
 
 ### Documentation
+
 All the features and explanations are in the documentation markdown file.
 [Documentation Link](https://github.com/CodingAP/steve/blob/main/documentation.md)
 
 ## How to Run
 
-Node installation:
-`npx jsr add @codingap/steve`
+Node installation: `npx jsr add @codingap/steve`
+
+Deno installation: `deno add jsr:@codingap/steve`
 
-Deno installation:
-`deno add jsr:@codingap/steve`
+Bun installation: `bunx jsr add @codingap/steve`
 
-Bun installation:
-`bunx jsr add @codingap/steve`
-   
 ### Usage
 
 ```javascript
 import { STEVE } from '@codingap/steve';
 
-STEVE.render('Hello <steve> return steve.data.name; </steve>!', { name: 'STEVE' });
+STEVE.render('Hello <steve> return steve.data.name; </steve>!', {
+    name: 'STEVE',
+});
 ```
 
 Output:
+
 ```
 Hello STEVE!
 ```
 
-To see more instances of `STEVE` being used, go to the [Documentation](https://github.com/CodingAP/steve/blob/main/documentation.md)
+To see more instances of `STEVE` being used, go to the [Documentation](https://github.com/CodingAP/steve/blob/main/documentation.md)

deno.json

@@ -1,6 +1,6 @@
 {
     "name": "@codingap/steve",
-    "version": "2.0.4",
+    "version": "2.0.5",
     "exports": "./index.ts",
     "description": "STEVE is a configurable template engine that allows JavaScript to run in files to create files. It has a plugin system to allow for custom generation and a built-in site generator.",
     "tasks": {
@@ -13,6 +13,7 @@
     },
     "fmt": {
         "indentWidth": 4,
-        "singleQuote": true
+        "singleQuote": true,
+        "exclude": ["*.md"]
     }
 }

deno.lock

@@ -184,11 +184,16 @@ class STEVE {
             augment = this.plugins[this.activePlugin].augment();
         }
 
+        const globalSTEVE: { [key: string]: unknown } = {
+            include,
+            data: _data,
+        };
+
         Object.keys(augment).forEach((key) => {
             const value = augment[key];
             if (typeof value === 'function') {
                 // replace all instances of 'this' with 'this.plugins[this.activePlugin]'
-                augment[key] = eval(
+                globalSTEVE[key] = eval(
                     value.toString().replace(
                         /this/g,
                         'this.plugins[this.activePlugin]',
@@ -197,12 +202,6 @@ class STEVE {
             }
         });
 
-        const globalSTEVE: { [key: string]: unknown } = {
-            include,
-            data: _data,
-            ...augment,
-        };
-
         return globalSTEVE;
     }
 

src/core/steve.ts

@@ -160,7 +160,9 @@ class SiteGenerator extends STEVEPlugin {
         if (existsSync(this.#outputDirectory)) {
             for (const file of walkSync(this.#outputDirectory)) {
                 if (
-                    this.#ignoredFiles?.filter(filename => resolve(file.path).includes(filename)).length > 0 ||
+                    this.#ignoredFiles?.filter((filename) =>
+                            resolve(file.path).includes(filename)
+                        ).length > 0 ||
                     file.name.startsWith('.') ||
                     resolve(this.#outputDirectory) === file.path
                 ) continue;
@@ -268,6 +270,13 @@ class SiteGenerator extends STEVEPlugin {
          * @returns the URL to the static file
          */
         const staticFile = (file: string): string => {
+            const existsSync = STEVE.globalModules.existsSync as (
+                path: string,
+            ) => boolean;
+            const join = STEVE.globalModules.join as (
+                ...paths: string[]
+            ) => string;
+
             if (!this.staticDirectory) {
                 throw new Error(
                     "there is no 'staticDirectory' defined to get static file!",
@@ -285,12 +294,15 @@ class SiteGenerator extends STEVEPlugin {
         };
 
         /**
-         * joins paths together, ensuring a valid and consistent file 
+         * joins paths together, ensuring a valid and consistent file
          *
          * @param paths - the list of path segments to join
          * @returns the final joined path
          */
         const joinPaths = (...paths: string[]): string => {
+            const join = STEVE.globalModules.join as (
+                ...paths: string[]
+            ) => string;
             return join(...paths);
         };
 

src/plugin/site-generator.ts

@@ -9,7 +9,7 @@
 
 import { assertEquals, assertThrows } from 'jsr:@std/assert';
 import { ensureDir, exists } from 'jsr:@std/fs';
-import { GeneratorRoute, SingleRoute, SiteGenerator } from '../index.ts';
+import { GeneratorRoute, SingleRoute, SiteGenerator, STEVE } from '../index.ts';
 
 // ~~~~~ SingleRoute testing ~~~~~
 Deno.test('SingleRoute: generates a single route with render content', () => {
@@ -277,10 +277,8 @@ Deno.test('SiteGenerator: handles ignored files correctly', async () => {
 
     // Create SiteGenerator instance
     const generator = new SiteGenerator({
-        staticDirectory: '',
         outputDirectory: outputDir,
         ignoredFiles: ['ignore.txt'],
-        showExtension: false,
     });
 
     // Define routes (empty for simplicity)
@@ -330,3 +328,30 @@ Deno.test('SiteGenerator: throws error when outputDirectory is not provided', ()
         "please provide an 'outputDirectory' for the files to go to!",
     );
 });
+
+Deno.test('SiteGenerator: check to see if global modules work', async () => {
+    const tempDir = await Deno.makeTempDir();
+    const outputDir = `${tempDir}/output`;
+
+    // Create SiteGenerator instance
+    STEVE.addPlugin(
+        new SiteGenerator({
+            outputDirectory: outputDir,
+        }),
+    );
+
+    // Generate the site
+    STEVE.generate({
+        root: new SingleRoute({
+            render:
+                '<steve> return steve.joinPaths(...steve.data.paths); </steve>',
+            data: { paths: ['hello', 'world'] },
+        }),
+    });
+
+    const text = await Deno.readTextFile(`${outputDir}/index.html`);
+    assertEquals(text.includes('hello\\world'), true);
+
+    // Cleanup
+    await Deno.remove(tempDir, { recursive: true });
+});