Fix typing

Author: iddan

.github/workflows/ci.yaml

@@ -28,10 +28,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-
       - run: yarn
-      - run: yarn check-format
-      - run: yarn check-typing
-      - run: yarn lint
-      - run: yarn test --coverage
+      - run: yarn ci
       - run: yarn build
         env:
           NODE_ENV: production

package.json

@@ -25,7 +25,8 @@
     "check-typing": "tsc",
     "storybook": "start-storybook -p 6006",
     "build-storybook": "build-storybook",
-    "build-typedoc": "typedoc"
+    "build-typedoc": "typedoc",
+    "ci": "yarn check-format && yarn check-typing && yarn lint && yarn test --coverage"
   },
   "peerDependencies": {
     "react": ">=16.8.0",

src/engine.spec.ts

@@ -10,7 +10,7 @@ const MOCK_FORMULA_PARSER = {
 } as unknown as FormulaParser;
 const EXAMPLE_FORMULA_RESULT = 42;
 const EXAMPLE_FORMULA_ERROR = "EXAMPLE_ERROR";
-const EXAMPLE_FORMULA_CELL = { value: "=A1" };
+const EXAMPLE_FORMULA = "=A1";
 
 describe("getFormulaComputedValue()", () => {
   beforeEach(() => {
@@ -33,11 +33,11 @@ describe("getFormulaComputedValue()", () => {
   test.each(cases)("%s", (name, expected, mockParseReturn) => {
     MOCK_PARSE.mockImplementationOnce(() => mockParseReturn);
     expect(
-      getFormulaComputedValue(EXAMPLE_FORMULA_CELL, ORIGIN, MOCK_FORMULA_PARSER)
+      getFormulaComputedValue(EXAMPLE_FORMULA, ORIGIN, MOCK_FORMULA_PARSER)
     ).toBe(expected);
     expect(MOCK_FORMULA_PARSER.parse).toBeCalledTimes(1);
     expect(MOCK_FORMULA_PARSER.parse).toBeCalledWith(
-      Formula.extractFormula(EXAMPLE_FORMULA_CELL.value),
+      Formula.extractFormula(EXAMPLE_FORMULA),
       { col: 1, row: 1, sheet: "Sheet1" }
     );
   });

src/engine.ts

@@ -6,7 +6,6 @@ import { Point } from "./point";
 import * as pointGraph from "./point-graph";
 import * as pointSet from "./point-set";
 import { CellBase } from "./types";
-import { isFormulaCell } from "./util";
 
 export class Model<Cell extends CellBase> {
   readonly data!: matrix.Matrix<Cell>;
@@ -32,7 +31,7 @@ export function updateCellValue<Cell extends CellBase>(
   cell: Cell
 ): Model<Cell> {
   const nextData = matrix.set(point, cell, model.data);
-  const nextReferenceGraph = isFormulaCell(cell)
+  const nextReferenceGraph = Formula.isFormulaValue(cell.value)
     ? updateReferenceGraph(model.referenceGraph, point, cell, nextData)
     : model.referenceGraph;
 
@@ -102,8 +101,8 @@ function evaluateCell<Cell extends CellBase>(
     () => nextEvaluatedData
   );
 
-  const evaluatedValue = isFormulaCell(cell)
-    ? getFormulaComputedValue(cell, point, formulaParser)
+  const evaluatedValue = Formula.isFormulaValue(cell.value)
+    ? getFormulaComputedValue(cell.value, point, formulaParser)
     : cell.value;
 
   const evaluatedCell = { ...cell, value: evaluatedValue };
@@ -119,8 +118,8 @@ function evaluateCell<Cell extends CellBase>(
     if (!referrerCell) {
       continue;
     }
-    const evaluatedValue = isFormulaCell(referrerCell)
-      ? getFormulaComputedValue(referrerCell, point, formulaParser)
+    const evaluatedValue = Formula.isFormulaValue(referrerCell.value)
+      ? getFormulaComputedValue(referrerCell.value, point, formulaParser)
       : referrerCell.value;
     const evaluatedCell = { ...referrerCell, value: evaluatedValue };
     nextEvaluatedData = matrix.set(referrer, evaluatedCell, nextEvaluatedData);
@@ -139,7 +138,7 @@ export function createReferenceGraph(
 ): pointGraph.PointGraph {
   const entries: Array<[Point, pointSet.PointSet]> = [];
   for (const [point, cell] of matrix.entries(data)) {
-    if (cell && isFormulaCell(cell)) {
+    if (cell && Formula.isFormulaValue(cell.value)) {
       const references = getReferences(
         Formula.extractFormula(cell.value),
         point,
@@ -168,9 +167,9 @@ export function createEvaluatedData<Cell extends CellBase>(
     }
 
     // If the cell is a formula cell, evaluate it
-    if (isFormulaCell(cell)) {
+    if (Formula.isFormulaValue(cell.value)) {
       const evaluatedValue = getFormulaComputedValue(
-        cell,
+        cell.value,
         point,
         formulaParser
       );
@@ -187,10 +186,10 @@ export function createEvaluatedData<Cell extends CellBase>(
 
 /** Get the computed value of a formula cell */
 export function getFormulaComputedValue(
-  cell: CellBase<string>,
+  value: string,
   point: Point,
   formulaParser: FormulaParser
 ): Value {
-  const formula = Formula.extractFormula(cell.value);
+  const formula = Formula.extractFormula(value);
   return Formula.evaluate(formula, point, formulaParser);
 }

src/util.test.ts

@@ -67,9 +67,7 @@ const EXAMPLE_STRING = "EXAMPLE_STRING";
 const EXAMPLE_CELL: Types.CellBase = {
   value: "EXAMPLE_CELL_VALUE",
 };
-const EXAMPLE_FORMULA_CELL: Types.CellBase = {
-  value: "=TRUE()",
-};
+
 const EXAMPLE_EMPTY_COPIED = PointMap.from<Types.CellBase>([]);
 const EXAMPLE_COPIED = PointMap.from([[Point.ORIGIN, EXAMPLE_CELL]]);
 
@@ -291,16 +289,6 @@ describe("writeTextToClipboard()", () => {
   );
 });
 
-describe("isFormulaCell()", () => {
-  const cases = [
-    ["Returns true for formula cell", EXAMPLE_FORMULA_CELL, true],
-    ["Returns true for formula cell", EXAMPLE_CELL, false],
-  ] as const;
-  test.each(cases)("%s", (name, cell, expected) => {
-    expect(util.isFormulaCell(cell)).toBe(expected);
-  });
-});
-
 describe("getCSV()", () => {
   test("Returns given data as CSV", () => {
     expect(util.getCSV(EXAMPLE_DATA)).toBe(

src/util.ts

@@ -5,7 +5,6 @@ import * as PointRange from "./point-range";
 import * as Selection from "./selection";
 import * as PointMap from "./point-map";
 import * as PointSet from "./point-set";
-import * as Formula from "./formula";
 
 export { createEmpty as createEmptyMatrix } from "./matrix";
 
@@ -134,13 +133,6 @@ export function getSelectedDimensions(
     : undefined;
 }
 
-/** Returns whether given cell contains a formula value */
-export function isFormulaCell(
-  cell: Types.CellBase
-): cell is Types.CellBase<string> {
-  return Formula.isFormulaValue(cell.value);
-}
-
 /** Get given data as CSV */
 export function getCSV(data: Matrix.Matrix<Types.CellBase>): string {
   const valueMatrix = Matrix.map((cell) => cell?.value || "", data);