add autoUpdateReadme

Author: beakerandjake

src/tables/autoUpdateReadme.js

@@ -0,0 +1,14 @@
+import { statsAction } from '../commands/stats.js';
+import { getConfigValue } from '../config.js';
+import { logger } from '../logger.js';
+
+/**
+ * If readme auto updates are enabled, will update the progress table of the readme
+ */
+export const autoUpdateReadme = async () => {
+  if (getConfigValue('disableReadmeAutoSaveProgress')) {
+    logger.verbose('not updating readme file, auto update disabled');
+    return;
+  }
+  await statsAction({ save: true });
+};

tests/tables/autoUpdateReadme.test.js

@@ -0,0 +1,53 @@
+import { describe, jest, test, afterEach } from '@jest/globals';
+import { mockLogger, easyMock, easyResolve, mockConfig } from '../mocks.js';
+
+// setup mocks
+const easyMocks = [['src/commands/stats.js', ['statsAction']]];
+easyMock(easyMocks);
+mockLogger();
+const { getConfigValue } = mockConfig();
+
+// import after mocks set up.
+const { statsAction } = await easyResolve(easyMocks);
+const { autoUpdateReadme } = await import(
+  '../../src/tables/autoUpdateReadme.js'
+);
+
+describe('autoUpdateReadme()', () => {
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  test('does not update readme if not configured to do so', async () => {
+    getConfigValue.mockImplementation((key) => {
+      if (key === 'disableReadmeAutoSaveProgress') {
+        return true;
+      }
+      throw new Error('unknown key');
+    });
+    await autoUpdateReadme();
+    expect(statsAction).not.toHaveBeenCalled();
+  });
+
+  test('update readme if configured to do so', async () => {
+    getConfigValue.mockImplementation((key) => {
+      if (key === 'disableReadmeAutoSaveProgress') {
+        return false;
+      }
+      throw new Error('unknown key');
+    });
+    await autoUpdateReadme();
+    expect(statsAction).toHaveBeenCalled();
+  });
+
+  test('passes save option to statsAction', async () => {
+    getConfigValue.mockImplementation((key) => {
+      if (key === 'disableReadmeAutoSaveProgress') {
+        return false;
+      }
+      throw new Error('unknown key');
+    });
+    await autoUpdateReadme();
+    expect(statsAction).toHaveBeenCalledWith({ save: true });
+  });
+});