chore: Use stats and await to ensure the history file is created. Also, add doc comments

Author: joeyguerra

configuration/Config.mjs

@@ -1,3 +1,12 @@
+// Description:
+//   Configuration
+//
+// Commands:
+//
+// Notes:
+//   This is a test script.
+//
+
 export default async robot => {
   robot.config = {}
 }

src/adapters/Shell.mjs

@@ -1,6 +1,7 @@
 'use strict'
 
 import fs from 'node:fs'
+import { stat, writeFile, unlink } from 'node:fs/promises'
 import readline from 'node:readline'
 import Adapter from '../Adapter.mjs'
 import { TextMessage } from '../Message.mjs'
@@ -44,12 +45,15 @@ class Shell extends Adapter {
   }
 
   async run () {
-    const stats = fs.statSync(historyPath)
-    if (stats.size > historySize) {
-      fs.unlinkSync(historyPath)
-    }
-    if (!fs.existsSync(historyPath)) {
-      fs.writeFileSync(historyPath, '')
+    try {
+      const stats = await stat(historyPath)
+      if (stats.size > historySize) {
+        await unlink(historyPath)
+        await writeFile(historyPath, '')
+      }
+    } catch (error) {
+      console.log(error)
+      await writeFile(historyPath, '')
     }
 
     this.#rl = readline.createInterface({

test/DataStore_test.mjs

@@ -5,7 +5,7 @@ import assert from 'node:assert/strict'
 import InMemoryDataStore from '../src/datastores/Memory.mjs'
 import Brain from '../src/Brain.mjs'
 
-describe.skip('Datastore', () => {
+describe('Datastore', () => {
   let robot = null
   beforeEach(() => {
     robot = {

test/Shell_test.mjs

@@ -7,7 +7,7 @@ import stream from 'node:stream'
 import fs from 'node:fs'
 import { writeFile } from 'node:fs/promises'
 
-describe.skip('Shell history file test', () => {
+describe('Shell history file test', () => {
   it('History file is > 1024 bytes when running does not throw an error', async () => {
     const robot = new Robot('Shell', false, 'TestHubot')
     robot.stdin = new stream.Readable()

test/ordered-scripts/01-PFirst.mjs

@@ -1,3 +1,12 @@
+// Description:
+//   First one
+//
+// Commands:
+//
+// Notes:
+//   This is a test script.
+//
+
 export default async robot => {
   robot.loadedScripts = []
   robot.loadedScripts.push('01-First')

test/ordered-scripts/02-SetupBotConfig.mjs

@@ -1,3 +1,12 @@
+// Description:
+//   Setup bot configuration
+//
+// Commands:
+//
+// Notes:
+//   This is a test script.
+//
+
 export default async robot => {
   robot.loadedScripts.push('02-Second')
 }

test/ordered-scripts/WebSetup.mjs

@@ -1,3 +1,12 @@
+// Description:
+//   Third one
+//
+// Commands:
+//
+// Notes:
+//   This is a test script.
+//
+
 export default async robot => {
   robot.loadedScripts.push('03-Third')
 }