Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

chore: typecheck Vite examples in CI (#3650)

Igor Dykhtaf33e93b4975d
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 6a8ccec48..15b099782 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -69,3 +69,21 @@ jobs:
continue-on-error: true
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
+
+ typecheck-examples:
+ name: Typecheck ${{ matrix.example }}
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ example: [get-started-vite, duckdb-vite]
+
+ steps:
+ - uses: actions/checkout@v4
+ - uses: volta-cli/action@v4
+
+ - name: Install and typecheck
+ working-directory: examples/${{ matrix.example }}
+ run: |
+ yarn install
+ yarn tsc -b --pretty false --noEmit
diff --git a/examples/duckdb-vite/.yarnrc.yml b/examples/duckdb-vite/.yarnrc.yml
new file mode 100644
index 000000000..19e3db2fd
--- /dev/null
+++ b/examples/duckdb-vite/.yarnrc.yml
@@ -0,0 +1,4 @@
+# https://yarnpkg.com/configuration/yarnrc
+nodeLinker: node-modules
+# Define the registry to use when fetching packages.
+npmRegistryServer: 'https://registry.yarnpkg.com'
diff --git a/examples/duckdb-vite/src/main.tsx b/examples/duckdb-vite/src/main.tsx
index 41545f0da..40d655097 100644
--- a/examples/duckdb-vite/src/main.tsx
+++ b/examples/duckdb-vite/src/main.tsx
@@ -62,7 +62,7 @@ const middleWares = enhanceReduxMiddleware([]);
const enhancers = applyMiddleware(...middleWares);
const store = createStore(reducers, {}, compose(enhancers));
-const KeplerGl = injectComponents([replaceMapControl()]);
+const KeplerGl = injectComponents([replaceMapControl()] as any);
const StyledResizeHandle = styled(PanelResizeHandle)`
background-color: ${panelBorderColor};
@@ -93,8 +93,8 @@ const App = () => {
const mapContainerRef = useRef<HTMLDivElement>(null);
const [mapDimensions, setMapDimensions] = useState({width: 0, height: 0});
- const isSqlPanelOpen = useSelector(
- (state: any) => Boolean(state?.keplerGl?.map?.uiState?.mapControls?.sqlPanel?.active)
+ const isSqlPanelOpen = useSelector((state: any) =>
+ Boolean(state?.keplerGl?.map?.uiState?.mapControls?.sqlPanel?.active)
);
useEffect(() => {
diff --git a/examples/duckdb-vite/src/map-control.tsx b/examples/duckdb-vite/src/map-control.tsx
index 8fbede417..73813bcb3 100644
--- a/examples/duckdb-vite/src/map-control.tsx
+++ b/examples/duckdb-vite/src/map-control.tsx
@@ -7,10 +7,12 @@ import {MapControlFactory} from '@kepler.gl/components';
import SqlPanelControlFactory from './sql-panel-control';
-CustomMapControlFactory.deps = [SqlPanelControlFactory, ...MapControlFactory.deps];
+CustomMapControlFactory.deps = [SqlPanelControlFactory, ...(MapControlFactory.deps ?? [])];
function CustomMapControlFactory(SqlPanelControl: React.ComponentType<any>, ...deps: any[]) {
- const MapControl = MapControlFactory(...deps);
+ const MapControl = (
+ MapControlFactory as (...args: any[]) => ReturnType<typeof MapControlFactory>
+ )(...deps);
const actionComponents = [...(MapControl.defaultActionComponents ?? []), SqlPanelControl];
const CustomMapControl = (props: any) => (
diff --git a/examples/duckdb-vite/src/sql-panel-control.tsx b/examples/duckdb-vite/src/sql-panel-control.tsx
index fc7cfee05..52db14161 100644
--- a/examples/duckdb-vite/src/sql-panel-control.tsx
+++ b/examples/duckdb-vite/src/sql-panel-control.tsx
@@ -4,10 +4,14 @@
import React, {useCallback} from 'react';
import {MapControlButton, MapControlTooltipFactory} from '@kepler.gl/components';
-import {MapControls} from '@kepler.gl/types';
+import {MapControlItem, MapControls} from '@kepler.gl/types';
+
+type MapControlsWithSqlPanel = MapControls & {
+ sqlPanel?: MapControlItem;
+};
export type SqlPanelControlProps = {
- mapControls: MapControls;
+ mapControls: MapControlsWithSqlPanel;
onToggleMapControl: (control: string) => void;
};
diff --git a/examples/get-started-vite/.yarnrc.yml b/examples/get-started-vite/.yarnrc.yml
new file mode 100644
index 000000000..19e3db2fd
--- /dev/null
+++ b/examples/get-started-vite/.yarnrc.yml
@@ -0,0 +1,4 @@
+# https://yarnpkg.com/configuration/yarnrc
+nodeLinker: node-modules
+# Define the registry to use when fetching packages.
+npmRegistryServer: 'https://registry.yarnpkg.com'
diff --git a/src/types/reducers.d.ts b/src/types/reducers.d.ts
index 4544d8df2..f0bacc20c 100644
--- a/src/types/reducers.d.ts
+++ b/src/types/reducers.d.ts
@@ -524,6 +524,7 @@ export type MapControls = {
mapTheme?: MapControlItem;
effect?: MapControlItem;
annotation?: MapControlItem;
+ sqlPanel?: MapControlItem;
aiAssistant?: MapControlItem;
};