facade lib + test reset

dearlordylord · dearlordylord · commit 8d0732b0d838 · 2024-01-07T16:19:57.000+07:00
diff --git a/README.md b/README.md
@@ -1 +1 @@
-TODO keywords: persistent, (optionally) deterministic
+TODO keywords: immutable/functional, (optionally) deterministic, 0 dependency
diff --git a/facade/.eslintrc.json b/facade/.eslintrc.json
@@ -0,0 +1,25 @@
+{
+  "extends": ["../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    }
+  ]
+}
diff --git a/facade/README.md b/facade/README.md
@@ -0,0 +1 @@
+npm facade for the project
diff --git a/facade/jest.config.ts b/facade/jest.config.ts
@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'facade',
+  preset: '../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../coverage/facade',
+};
diff --git a/facade/package.json b/facade/package.json
@@ -0,0 +1,11 @@
+{
+  "name": "@jikan/facade",
+  "version": "0.0.1",
+  "dependencies": {
+    "tslib": "^2.3.0",
+    "@jikan/fsm": "*"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts"
+}
diff --git a/facade/project.json b/facade/project.json
@@ -0,0 +1,30 @@
+{
+  "name": "facade",
+  "$schema": "../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "facade/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/facade",
+        "main": "facade/src/index.ts",
+        "tsConfig": "facade/tsconfig.lib.json",
+        "assets": ["facade/*.md"]
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "outputs": ["{options.outputFile}"]
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "facade/jest.config.ts"
+      }
+    }
+  },
+  "tags": []
+}
diff --git a/facade/src/index.ts b/facade/src/index.ts
@@ -0,0 +1,13 @@
+export {
+  empty,
+  State,
+  QueueItem,
+  isEmpty,
+  current,
+  currentNE,
+  tick,
+  push,
+  pop,
+  restart,
+  reset,
+} from '@jikan/fsm';
diff --git a/facade/tsconfig.json b/facade/tsconfig.json
@@ -0,0 +1,22 @@
+{
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}
diff --git a/facade/tsconfig.lib.json b/facade/tsconfig.lib.json
@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}
diff --git a/facade/tsconfig.spec.json b/facade/tsconfig.spec.json
@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}
diff --git a/fsm/README.md b/fsm/README.md
@@ -1,11 +1,3 @@
-# fsm
+core logic for timers
 
-This library was generated with [Nx](https://nx.dev).
-
-## Building
-
-Run `nx build fsm` to build the library.
-
-## Running unit tests
-
-Run `nx test fsm` to execute the unit tests via [Jest](https://jestjs.io).
+implemented as a queue of intervals and a tick(number)
diff --git a/fsm/src/lib/fsm.spec.ts b/fsm/src/lib/fsm.spec.ts
@@ -4,6 +4,7 @@ import {
   isEmpty,
   pop,
   push,
+  restart,
   QueueItem,
   showPrintDuration0QueueItemError,
   State,
@@ -91,7 +92,6 @@ describe('fsm', () => {
         {
           kind: 'd',
           duration: 1,
-
         },
         // @ts-expect-error type 'd' won't be accepted here
       ])(empty<'a' | 'b' | 'c'>());
@@ -206,6 +206,48 @@ describe('fsm', () => {
       expect(s2).toEqual(empty());
     });
   });
+  describe('restart', () => {
+    it('noops', () => {
+      const s0 = empty<'a'>();
+      const s1 = push([
+        {
+          kind: 'a',
+          duration: 2,
+        },
+        {
+          kind: 'b',
+          duration: 3,
+        },
+      ])(s0);
+      expect(s1.duration).toBe(2);
+      const s2 = restart(s1);
+      expect(s2.duration).toBe(2);
+    });
+    it('noops on state0', () => {
+      const s0 = empty<'a'>();
+      expect(s0.duration).toBe(0);
+      const s1 = restart(s0);
+      expect(s1.duration).toBe(0);
+    });
+    it('restarts the current item', () => {
+      const s0 = empty<'a'>();
+      const s1 = push([
+        {
+          kind: 'a',
+          duration: 2,
+        },
+        {
+          kind: 'b',
+          duration: 3,
+        },
+      ])(s0);
+      expect(s1.duration).toBe(2);
+      const s2 = tick(1)(s1)[0];
+      expect(s2.duration).toBe(1);
+      const s3 = restart(s2);
+      expect(s3.duration).toBe(2);
+    });
+  });
   describe('raw simulation', () => {
     const naiveSimulationTest = (program: QueueItem<string>[]) => {
       const [state, runLog] = program.reduce<
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -16,6 +16,7 @@
     "skipDefaultLibCheck": true,
     "baseUrl": ".",
     "paths": {
+      "@jikan/facade": ["facade/src/index.ts"],
       "@jikan/fsm": ["fsm/src/index.ts"],
       "@jikan/utils": ["utils/src/index.ts"]
     }

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-TODO keywords: persistent, (optionally) deterministic`
	`1`	`+TODO keywords: immutable/functional, (optionally) deterministic, 0 dependency`