Configure eslint to allow null assertions in test files

Author: sequba

.eslintrc.js

@@ -143,5 +143,11 @@ module.exports = {
         'sort-keys': ['error', 'asc'],
       }
     },
+    {
+      files: ['**/*.spec.ts'],
+      rules: {
+        '@typescript-eslint/no-non-null-assertion': 'off',
+      }
+    }
   ],
 }

src/DependencyGraph/AddressMapping/AddressMapping.ts

@@ -22,10 +22,19 @@ export interface AddressMappingAddSheetOptions {
   throwIfSheetAlreadyExists: boolean,
 }
 
+export interface AddressMappingGetCellOptions {
+  throwIfSheetNotExists?: boolean,
+  throwIfCellNotExists?: boolean,
+}
+
 /**
  * Manages cell vertices and provides access to vertex by SimpleCellAddress.
  * For each sheet it stores vertices according to AddressMappingStrategy: DenseStrategy or SparseStrategy.
- * It also stores placeholder entries (DenseStrategy(0, 0)) for sheets that are used in formulas but not yet added.
+ *
+ * Pleceholder sheets:
+ * - for placeholders sheets (sheets that are used in formulas but not yet added), it stores placeholder strategy entries (DenseStrategy(0, 0))
+ * - placeholder strategy entries may contain EmptyCellVertex-es but never ValueCellVertex or FormulaVertex as they content is empty
+ * - vertices in placeholder strategy entries are used only for dependency tracking
  */
 export class AddressMapping {
   private mapping: Map<number, AddressMappingStrategy> = new Map()
@@ -37,21 +46,22 @@ export class AddressMapping {
   /**
    * Gets the cell vertex at the specified address.
    */
-  public getCell(address: SimpleCellAddress): Maybe<CellVertex> {
-    const sheetMapping = this.getStrategyForSheetOrThrow(address.sheet)
-    return sheetMapping.getCell(address)
-  }
+  public getCell(address: SimpleCellAddress, options: AddressMappingGetCellOptions = {}): Maybe<CellVertex> {
+    const sheetMapping = this.mapping.get(address.sheet)
+    if (!sheetMapping) {
+      if (options.throwIfSheetNotExists) {
+        throw new NoSheetWithIdError(address.sheet)
+      }
+      return undefined
+    }
 
-  /**
-   * Gets the cell vertex at the specified address or throws an error if not found.
-   */
-  public getCellOrThrowError(address: SimpleCellAddress): CellVertex {
-    const vertex = this.getCell(address)
+    const cell = sheetMapping.getCell(address)
 
-    if (!vertex) {
+    if (!cell && options.throwIfCellNotExists) {
       throw Error('Vertex for address missing in AddressMapping')
     }
-    return vertex
+
+    return cell
   }
 
   /**

src/DependencyGraph/DependencyGraph.ts

@@ -596,11 +596,15 @@ export class DependencyGraph {
   }
 
   public fetchCell(address: SimpleCellAddress): CellVertex {
-    return this.addressMapping.getCellOrThrowError(address)
+    return this.addressMapping.getCell(address, { throwIfCellNotExists: true }) as CellVertex
   }
 
+  /**
+   * Gets the cell vertex at the specified address.
+   * @throws {NoSheetWithIdError} if sheet doesn't exist
+   */
   public getCell(address: SimpleCellAddress): Maybe<CellVertex> {
-    return this.addressMapping.getCell(address)
+    return this.addressMapping.getCell(address, { throwIfSheetNotExists: true })
   }
 
   public getCellValue(address: SimpleCellAddress): InterpreterValue {
@@ -912,9 +916,9 @@ export class DependencyGraph {
             return [dependency.start, this.rangeMapping.getVertexOrThrow(dependency.start, dependency.end)]
           } else if (dependency instanceof NamedExpressionDependency) {
             const namedExpression = this.namedExpressions.namedExpressionOrPlaceholder(dependency.name, address.sheet)
-            return [namedExpression.address, this.addressMapping.getCellOrThrowError(namedExpression.address)]
+            return [namedExpression.address, this.addressMapping.getCell(namedExpression.address, { throwIfCellNotExists: true }) as CellVertex]
           } else {
-            return [dependency, this.addressMapping.getCellOrThrowError(dependency)]
+            return [dependency, this.addressMapping.getCell(dependency, { throwIfCellNotExists: true }) as CellVertex]
           }
         })
       } else {

src/Operations.ts

@@ -925,7 +925,7 @@ export class Operations {
     const targetRange = AbsoluteCellRange.spanFrom(destinationLeftCorner, width, height)
 
     for (const formulaAddress of targetRange.addresses(this.dependencyGraph)) {
-      const vertex = this.addressMapping.getCellOrThrowError(formulaAddress)
+      const vertex = this.addressMapping.getCell(formulaAddress, { throwIfCellNotExists: true })
       if (vertex instanceof ScalarFormulaVertex && formulaAddress.sheet !== sourceLeftCorner.sheet) {
         const ast = vertex.getFormula(this.lazilyTransformingAstService)
         const { dependencies } = this.parser.fetchCachedResultForAst(ast)
@@ -942,7 +942,7 @@ export class Operations {
     }
 
     const addedGlobalNamedExpressions: string[] = []
-    const vertex = this.addressMapping.getCellOrThrowError(targetAddress)
+    const vertex = this.addressMapping.getCell(targetAddress, { throwIfCellNotExists: true }) as CellVertex
 
     for (const namedExpressionDependency of absolutizeDependencies(dependencies, targetAddress)) {
       if (!(namedExpressionDependency instanceof NamedExpressionDependency)) {

src/SimpleRangeValue.ts

@@ -112,7 +112,7 @@ export class SimpleRangeValue {
     const ret = []
     for (let i = 0; i < this._data!.length; i++) {
       for (let j = 0; j < this._data![0].length; j++) {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
         ret.push(this._data![i][j])
       }
     }

src/interpreter/plugin/ConditionalAggregationPlugin.ts

@@ -48,7 +48,7 @@ class AverageResult {
 /** Computes key for criterion function cache */
 function conditionalAggregationFunctionCacheKey(functionName: string): (conditions: Condition[]) => string {
   return (conditions: Condition[]): string => {
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
     const conditionsStrings = conditions.map((c) => `${c.conditionRange.range!.sheet},${c.conditionRange.range!.start.col},${c.conditionRange.range!.start.row}`)
     return [functionName, ...conditionsStrings].join(',')
   }

src/parser/FormulaParser.ts

@@ -831,7 +831,7 @@ export class FormulaParser extends EmbeddedActionsParser {
     }
     if (cellArg.reference.type === CellReferenceType.CELL_REFERENCE_RELATIVE
       || cellArg.reference.type === CellReferenceType.CELL_REFERENCE_ABSOLUTE_ROW) {
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
       absoluteCol = absoluteCol + this.formulaAddress.col
     }
 

test/unit/address-mapping.spec.ts

@@ -16,7 +16,7 @@ const sharedExamples = (builder: (width: number, height: number) => AddressMappi
 
     mapping.setCell(address, vertex)
 
-    expect(mapping.getCellOrThrowError(address)).toBe(vertex)
+    expect(mapping.getCell(address)).toBe(vertex)
   })
 
   it('set and using different reference when get', () => {
@@ -25,7 +25,7 @@ const sharedExamples = (builder: (width: number, height: number) => AddressMappi
 
     mapping.setCell(adr('A1'), vertex)
 
-    expect(mapping.getCellOrThrowError(adr('A1'))).toBe(vertex)
+    expect(mapping.getCell(adr('A1'))).toBe(vertex)
   })
 
   it("get when there's even no column", () => {
@@ -141,8 +141,8 @@ const sharedExamples = (builder: (width: number, height: number) => AddressMappi
 
     mapping.setCell(adr('A2'), vertex1)
 
-    expect(mapping.getCellOrThrowError(adr('A1'))).toBe(vertex0)
-    expect(mapping.getCellOrThrowError(adr('A2'))).toBe(vertex1)
+    expect(mapping.getCell(adr('A1'))).toBe(vertex0)
+    expect(mapping.getCell(adr('A2'))).toBe(vertex1)
   })
 
   it('set overrides old value', () => {
@@ -153,7 +153,7 @@ const sharedExamples = (builder: (width: number, height: number) => AddressMappi
 
     mapping.setCell(adr('A1'), vertex1)
 
-    expect(mapping.getCellOrThrowError(adr('A1'))).toBe(vertex1)
+    expect(mapping.getCell(adr('A1'))).toBe(vertex1)
   })
 
   it("has when there's even no column", () => {
@@ -192,7 +192,7 @@ const sharedExamples = (builder: (width: number, height: number) => AddressMappi
     mapping.addRows(0, 0, 1)
 
     expect(mapping.getCell(adr('A1'))).toBe(undefined)
-    expect(mapping.getCellOrThrowError(adr('A2'))).toEqual(new ValueCellVertex(42, 42))
+    expect(mapping.getCell(adr('A2'))).toEqual(new ValueCellVertex(42, 42))
     expect(mapping.getSheetHeight(0)).toEqual(2)
   })
 
@@ -204,9 +204,9 @@ const sharedExamples = (builder: (width: number, height: number) => AddressMappi
 
     mapping.addRows(0, 1, 1)
 
-    expect(mapping.getCellOrThrowError(adr('A1'))).toEqual(new ValueCellVertex(42, 42))
+    expect(mapping.getCell(adr('A1'))).toEqual(new ValueCellVertex(42, 42))
     expect(mapping.getCell(adr('A2'))).toBe(undefined)
-    expect(mapping.getCellOrThrowError(adr('A3'))).toEqual(new ValueCellVertex(43, 43))
+    expect(mapping.getCell(adr('A3'))).toEqual(new ValueCellVertex(43, 43))
     expect(mapping.getSheetHeight(0)).toEqual(3)
   })
 
@@ -217,7 +217,7 @@ const sharedExamples = (builder: (width: number, height: number) => AddressMappi
 
     mapping.addRows(0, 1, 1)
 
-    expect(mapping.getCellOrThrowError(adr('A1'))).toEqual(new ValueCellVertex(42, 42))
+    expect(mapping.getCell(adr('A1'))).toEqual(new ValueCellVertex(42, 42))
     expect(mapping.getCell(adr('A2'))).toBe(undefined)
     expect(mapping.getSheetHeight(0)).toEqual(2)
   })
@@ -230,11 +230,11 @@ const sharedExamples = (builder: (width: number, height: number) => AddressMappi
 
     mapping.addRows(0, 1, 3)
 
-    expect(mapping.getCellOrThrowError(adr('A1'))).toEqual(new ValueCellVertex(42, 42))
+    expect(mapping.getCell(adr('A1'))).toEqual(new ValueCellVertex(42, 42))
     expect(mapping.getCell(adr('A2'))).toBe(undefined)
     expect(mapping.getCell(adr('A3'))).toBe(undefined)
     expect(mapping.getCell(adr('A4'))).toBe(undefined)
-    expect(mapping.getCellOrThrowError(adr('A5'))).toEqual(new ValueCellVertex(43, 43))
+    expect(mapping.getCell(adr('A5'))).toEqual(new ValueCellVertex(43, 43))
     expect(mapping.getSheetHeight(0)).toEqual(5)
   })
 
@@ -248,12 +248,12 @@ const sharedExamples = (builder: (width: number, height: number) => AddressMappi
 
     mapping.addRows(0, 1, 1)
 
-    expect(mapping.getCellOrThrowError(adr('A1'))).toEqual(new ValueCellVertex(11, 11))
-    expect(mapping.getCellOrThrowError(adr('B1'))).toEqual(new ValueCellVertex(12, 12))
+    expect(mapping.getCell(adr('A1'))).toEqual(new ValueCellVertex(11, 11))
+    expect(mapping.getCell(adr('B1'))).toEqual(new ValueCellVertex(12, 12))
     expect(mapping.getCell(adr('A2'))).toBe(undefined)
     expect(mapping.getCell(adr('B2'))).toBe(undefined)
-    expect(mapping.getCellOrThrowError(adr('A3'))).toEqual(new ValueCellVertex(21, 21))
-    expect(mapping.getCellOrThrowError(adr('B3'))).toEqual(new ValueCellVertex(22, 22))
+    expect(mapping.getCell(adr('A3'))).toEqual(new ValueCellVertex(21, 21))
+    expect(mapping.getCell(adr('B3'))).toEqual(new ValueCellVertex(22, 22))
     expect(mapping.getSheetHeight(0)).toEqual(3)
   })
 

test/unit/build-engine.spec.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
 import {HyperFormula} from '../../src'
 import {plPL} from '../../src/i18n/languages'
 import {adr} from './testUtils'

test/unit/column-index.spec.ts

@@ -35,7 +35,7 @@ describe('ColumnIndex#add', () => {
     const columnMap = index.getColumnMap(0, 1)
 
     expect(columnMap.size).toBe(1)
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
     expect(columnMap.get(1)!.index[0]).toBe(4)
   })
 
@@ -48,7 +48,7 @@ describe('ColumnIndex#add', () => {
     const columnMap = index.getColumnMap(0, 0)
 
     expect(columnMap.size).toBe(1)
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
     expect(columnMap.get(1)!.index[0]).toBe(0)
   })
 
@@ -63,7 +63,7 @@ describe('ColumnIndex#add', () => {
     const columnMap = index.getColumnMap(0, 0)
 
     expect(columnMap.size).toBe(1)
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
     expect(columnMap.get(1)!.index.length).toBe(2)
   })
 
@@ -108,13 +108,11 @@ describe('ColumnIndex#add', () => {
 
     const columnMap = index.getColumnMap(0, 0)
 
-    // eslint-disable @typescript-eslint/no-non-null-assertion
     expect(columnMap.get('a')!.index.length).toBe(3)
     expect(columnMap.get('l')!.index.length).toBe(1)
     expect(columnMap.get('ł')!.index.length).toBe(1)
     expect(columnMap.get('t')!.index.length).toBe(1)
     expect(columnMap.get('ŧ')!.index.length).toBe(1)
-    // eslint-enable @typescript-eslint/no-non-null-assertion
   })
 
   it('should ignore EmptyValue', () => {
@@ -136,7 +134,7 @@ describe('ColumnIndex change/remove', () => {
 
     index.remove(1, adr('A2'))
 
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
     const valueIndex = index.getColumnMap(0, 0).get(1)!
     expect(valueIndex.index.length).toBe(2)
     expect(valueIndex.index).toContain(0)
@@ -151,7 +149,7 @@ describe('ColumnIndex change/remove', () => {
 
     index.remove(undefined, adr('A2'))
 
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
     const valueIndex = index.getColumnMap(0, 0).get(1)!
     expect(valueIndex.index.length).toBe(3)
     expect(valueIndex.index).toContain(0)
@@ -166,7 +164,7 @@ describe('ColumnIndex change/remove', () => {
     index.change(1, 2, adr('A1'))
 
     expect(index.getColumnMap(0, 0).keys()).not.toContain(1)
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
     const valueIndex = index.getColumnMap(0, 0).get(2)!
     expect(valueIndex.index).toContain(0)
   })