Add CI lint and test (#82)

* Add CI * fmt
geoarrow · Nov 22, 2023 · 6a8294c · 6a8294c
1 parent e6b0b70
commit 6a8294c
Show file tree

Hide file tree

Showing 17 changed files with 163 additions and 66 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Volta
+        uses: volta-cli/action@v4
+
+      - name: Get npm cache directory
+        id: npm-cache-dir
+        shell: bash
+        run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}
+
+      - uses: actions/cache@v3
+        id: npm-cache # use this to check for `cache-hit` ==> if: steps.npm-cache.outputs.cache-hit != 'true'
+        with:
+          path: ${{ steps.npm-cache-dir.outputs.dir }}
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Install
+        run: npm install
+
+      - name: Prettier check
+        run: npm run fmt:check
+
+      - name: Type check
+        run: npm run typecheck
+
+      - name: Test
+        run: npm run test
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,5 @@
+{
+  "tabWidth": 2,
+  "semi": true,
+  "trailingComma": "all"
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -22,13 +22,16 @@
     "default": "./dist/dist.es.mjs"
   },
   "scripts": {
-    "build": "npm run build:tsc && npm run build:rollup",
-    "build:tsc": "tsc",
     "build:rollup": "rollup -c rollup.config.js",
+    "build:tsc": "tsc",
+    "build": "npm run build:tsc && npm run build:rollup",
     "clean": "rimraf dist",
-    "watch": "tsc --watch",
+    "fmt:check": "prettier './src/**/*.ts' --check",
+    "fmt": "prettier './src/**/*.ts' --write",
+    "prepublishOnly": "npm run clean && npm run build",
     "test": "vitest run",
-    "prepublishOnly": "npm run clean && npm run build"
+    "typecheck": "tsc --build",
+    "watch": "tsc --watch"
   },
   "files": [
     "dist/",
@@ -54,6 +57,7 @@
     "@rollup/plugin-terser": "^0.4.3",
     "@rollup/plugin-typescript": "^11.1.2",
     "apache-arrow": "^13.0.0",
+    "prettier": "^3.1.0",
     "rimraf": "^5.0.5",
     "rollup": "^3.26.2",
     "rollup-plugin-dts": "^5.3.0",

diff --git a/src/arc-layer.ts b/src/arc-layer.ts
@@ -108,7 +108,7 @@ const defaultProps: DefaultProps<GeoArrowArcLayerProps> = {
 };
 
 export class GeoArrowArcLayer<
-  ExtraProps extends {} = {}
+  ExtraProps extends {} = {},
 > extends CompositeLayer<Required<GeoArrowArcLayerProps> & ExtraProps> {
   static defaultProps = defaultProps;
   static layerName = "GeoArrowArcLayer";

diff --git a/src/column-layer.ts b/src/column-layer.ts
@@ -104,7 +104,7 @@ const defaultProps: DefaultProps<GeoArrowColumnLayerProps> = {
  * coordinates.
  */
 export class GeoArrowColumnLayer<
-  ExtraProps extends {} = {}
+  ExtraProps extends {} = {},
 > extends CompositeLayer<Required<GeoArrowColumnLayerProps> & ExtraProps> {
   static defaultProps = defaultProps;
   static layerName = "GeoArrowColumnLayer";
@@ -130,7 +130,7 @@ export class GeoArrowColumnLayer<
   }
 
   _renderLayersPoint(
-    geometryColumn: PointVector
+    geometryColumn: PointVector,
   ): Layer<{}> | LayersList | null {
     const { data: table } = this.props;
 

diff --git a/src/earcut.ts b/src/earcut.ts
@@ -40,7 +40,7 @@ function earcutSinglePolygon(data: PolygonData, geomIndex: number): number[] {
 
   const slicedFlatCoords = flatCoords.values.subarray(
     coordsBegin * dim,
-    coordsEnd * dim
+    coordsEnd * dim,
   );
 
   const initialCoordIndex = ringOffsets[ringBegin];

diff --git a/src/h3-hexagon-layer.ts b/src/h3-hexagon-layer.ts
@@ -56,7 +56,7 @@ const defaultProps: DefaultProps<GeoArrowH3HexagonLayerProps> = {
 };
 
 export class GeoArrowH3HexagonLayer<
-  ExtraProps extends {} = {}
+  ExtraProps extends {} = {},
 > extends CompositeLayer<Required<GeoArrowH3HexagonLayerProps> & ExtraProps> {
   static defaultProps = defaultProps;
   static layerName = "GeoArrowH3HexagonLayer";

diff --git a/src/heatmap-layer.ts b/src/heatmap-layer.ts
@@ -70,7 +70,7 @@ const defaultProps: DefaultProps<GeoArrowHeatmapLayerProps> = {
 };
 
 export class GeoArrowHeatmapLayer<
-  ExtraProps extends {} = {}
+  ExtraProps extends {} = {},
 > extends CompositeLayer<Required<GeoArrowHeatmapLayerProps> & ExtraProps> {
   static defaultProps = defaultProps;
   static layerName = "GeoArrowHeatmapLayer";
@@ -92,7 +92,7 @@ export class GeoArrowHeatmapLayer<
   }
 
   _renderLayersPoint(
-    geometryColumn: PointVector
+    geometryColumn: PointVector,
   ): Layer<{}> | LayersList | null {
     const { data: table } = this.props;
 

diff --git a/src/path-layer.ts b/src/path-layer.ts
@@ -98,7 +98,7 @@ const defaultProps: DefaultProps<GeoArrowPathLayerProps> = {
  * Render lists of coordinate points as extruded polylines with mitering.
  */
 export class GeoArrowPathLayer<
-  ExtraProps extends {} = {}
+  ExtraProps extends {} = {},
 > extends CompositeLayer<Required<GeoArrowPathLayerProps> & ExtraProps> {
   static defaultProps = defaultProps;
   static layerName = "GeoArrowPathLayer";
@@ -112,15 +112,15 @@ export class GeoArrowPathLayer<
 
     const lineStringVector = getGeometryVector(
       table,
-      EXTENSION_NAME.LINESTRING
+      EXTENSION_NAME.LINESTRING,
     );
     if (lineStringVector !== null) {
       return this._renderLayersLineString(lineStringVector);
     }
 
     const multiLineStringVector = getGeometryVector(
       table,
-      EXTENSION_NAME.MULTILINESTRING
+      EXTENSION_NAME.MULTILINESTRING,
     );
     if (multiLineStringVector !== null) {
       return this._renderLayersMultiLineString(multiLineStringVector);
@@ -139,7 +139,7 @@ export class GeoArrowPathLayer<
   }
 
   _renderLayersLineString(
-    geometryColumn: LineStringVector
+    geometryColumn: LineStringVector,
   ): Layer<{}> | LayersList | null {
     const { data: table } = this.props;
 
@@ -206,7 +206,7 @@ export class GeoArrowPathLayer<
   }
 
   _renderLayersMultiLineString(
-    geometryColumn: MultiLineStringVector
+    geometryColumn: MultiLineStringVector,
   ): Layer<{}> | LayersList | null {
     const { data: table } = this.props;
 

diff --git a/src/picking.ts b/src/picking.ts
@@ -4,7 +4,7 @@ import { GeoArrowPickingInfo } from "./types";
 
 export function getPickingInfo(
   { info, sourceLayer }: GetPickingInfoParams,
-  table: arrow.Table
+  table: arrow.Table,
 ): GeoArrowPickingInfo {
   // Geometry index as rendered
   let index = info.index;

diff --git a/src/scatterplot-layer.ts b/src/scatterplot-layer.ts
@@ -97,7 +97,7 @@ const defaultProps: DefaultProps<GeoArrowScatterplotLayerProps> = {
 };
 
 export class GeoArrowScatterplotLayer<
-  ExtraProps extends {} = {}
+  ExtraProps extends {} = {},
 > extends CompositeLayer<Required<GeoArrowScatterplotLayerProps> & ExtraProps> {
   static defaultProps = defaultProps;
   static layerName = "GeoArrowScatterplotLayer";
@@ -116,7 +116,7 @@ export class GeoArrowScatterplotLayer<
 
     const multiPointVector = getGeometryVector(
       table,
-      EXTENSION_NAME.MULTIPOINT
+      EXTENSION_NAME.MULTIPOINT,
     );
     if (multiPointVector !== null) {
       return this._renderLayersMultiPoint(multiPointVector);
@@ -135,7 +135,7 @@ export class GeoArrowScatterplotLayer<
   }
 
   _renderLayersPoint(
-    geometryColumn: PointVector
+    geometryColumn: PointVector,
   ): Layer<{}> | LayersList | null {
     const { data: table } = this.props;
 
@@ -197,7 +197,7 @@ export class GeoArrowScatterplotLayer<
   }
 
   _renderLayersMultiPoint(
-    geometryColumn: MultiPointVector
+    geometryColumn: MultiPointVector,
   ): Layer<{}> | LayersList | null {
     const { data: table } = this.props;
 

diff --git a/src/solid-polygon-layer.ts b/src/solid-polygon-layer.ts
@@ -101,7 +101,7 @@ const defaultProps: DefaultProps<GeoArrowSolidPolygonLayerProps> = {
 };
 
 export class GeoArrowSolidPolygonLayer<
-  ExtraProps extends {} = {}
+  ExtraProps extends {} = {},
 > extends CompositeLayer<
   Required<GeoArrowSolidPolygonLayerProps> & ExtraProps
 > {
@@ -122,7 +122,7 @@ export class GeoArrowSolidPolygonLayer<
 
     const MultiPolygonVector = getGeometryVector(
       table,
-      EXTENSION_NAME.MULTIPOLYGON
+      EXTENSION_NAME.MULTIPOLYGON,
     );
     if (MultiPolygonVector !== null) {
       return this._renderLayersMultiPolygon(MultiPolygonVector);
@@ -141,7 +141,7 @@ export class GeoArrowSolidPolygonLayer<
   }
 
   _renderLayersPolygon(
-    geometryColumn: PolygonVector
+    geometryColumn: PolygonVector,
   ): Layer<{}> | LayersList | null {
     const { data: table } = this.props;
 
@@ -217,7 +217,7 @@ export class GeoArrowSolidPolygonLayer<
   }
 
   _renderLayersMultiPolygon(
-    geometryColumn: MultiPolygonVector
+    geometryColumn: MultiPolygonVector,
   ): Layer<{}> | LayersList | null {
     const { data: table } = this.props;
 
@@ -322,7 +322,7 @@ export class GeoArrowSolidPolygonLayer<
 
 function encodePickingColors(
   geomToCoordOffsets: Int32Array,
-  encodePickingColor: (id: number, result: number[]) => void
+  encodePickingColor: (id: number, result: number[]) => void,
 ): Uint8ClampedArray {
   const largestOffset = geomToCoordOffsets[geomToCoordOffsets.length - 1];
   const pickingColors = new Uint8ClampedArray(largestOffset);