Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,28 @@
<p align="right">
<a href="https://npmjs.org/package/math.gl">
<img src="https://img.shields.io/npm/v/math.gl.svg?style=flat-square" alt="version" />
<a href="https://www.npmjs.com/package/math.gl">
<img src="https://img.shields.io/npm/v/math.gl.svg?style=flat-square&label=npm%20package" alt="npm package version" />
</a>
<a href="https://npmjs.org/package/math.gl">
<img src="https://img.shields.io/npm/dm/math.gl.svg?style=flat-square" alt="downloads" />
<a href="https://github.com/visgl/math.gl/blob/master/LICENSE">
<img src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square" alt="MIT license" />
</a>
<a href="https://www.npmjs.com/package/math.gl">
<img src="https://img.shields.io/npm/dm/math.gl.svg?style=flat-square&label=downloads" alt="npm downloads" />
</a>
<a href="https://coveralls.io/github/visgl/math.gl?branch=master">
<img src="https://img.shields.io/coveralls/visgl/math.gl.svg?style=flat-square&label=coverage" alt="coverage" />
</a>
<a href='https://coveralls.io/github/visgl/math.gl'><img src='https://coveralls.io/repos/visgl/math.gl/badge.svg' alt='Coverage Status' /></a>
</p>

<h1 align="center">math.gl | <a href="https://visgl.github.io/math.gl">Docs</a></h1>

<p align="center">
<a href="https://visgl.github.io/math.gl">Documentation</a>
·
<a href="https://visgl.github.io/math.gl/docs/whats-new">What's New</a>
·
<a href="https://visgl.github.io/math.gl/docs/api-reference/overview">API Reference</a>
</p>

# math.gl

> This page is a brief summary only. Please refer to the extensive online [documentation](https://visgl.github.io/math.gl).
Expand Down
12 changes: 4 additions & 8 deletions docs/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,13 @@
</tbody>
</table>

## v5.0 (In planning)

Release Date: TBD, maybe Q2, 2025.

Goal: Stronger type guarantees for math classes via the new sized array types.

## v4.2 (In development)

Release Date: TBD, maybe Q1, 2024.
Target Release Date: Q2, 2026.

Highlights:

Goal: Minor functionality additions, as required.
- TypeScript 6 compatibility.

## v4.1

Expand Down
4 changes: 2 additions & 2 deletions modules/core/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -10,4 +10,4 @@
"references": [
{"path": "../types"}
]
}
}
4 changes: 2 additions & 2 deletions modules/culling/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -11,4 +11,4 @@
{"path": "../types"},
{"path": "../core"}
]
}
}
4 changes: 2 additions & 2 deletions modules/dggs-geohash/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -11,4 +11,4 @@
{"path": "../types"},
{"path": "../web-mercator"}
]
}
}
4 changes: 2 additions & 2 deletions modules/dggs-quadkey/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -10,4 +10,4 @@
"references": [
{"path": "../types"}
]
}
}
4 changes: 2 additions & 2 deletions modules/dggs-s2/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -10,4 +10,4 @@
"references": [
{"path": "../types"}
]
}
}
4 changes: 2 additions & 2 deletions modules/geoid/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -11,4 +11,4 @@
{"path": "../types"},
{"path": "../core"}
]
}
}
4 changes: 2 additions & 2 deletions modules/geospatial/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -12,4 +12,4 @@
{"path": "../core"},
{"path": "../culling"}
]
}
}
4 changes: 2 additions & 2 deletions modules/main/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -11,4 +11,4 @@
{"path": "../types"},
{"path": "../core"}
]
}
}
4 changes: 2 additions & 2 deletions modules/polygon/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -10,4 +10,4 @@
"references": [
{"path": "../core"}
]
}
}
4 changes: 2 additions & 2 deletions modules/proj4/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -11,4 +11,4 @@
{"path": "../types"},
{"path": "../core"}
]
}
}
4 changes: 2 additions & 2 deletions modules/sun/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -10,4 +10,4 @@
"references": [
{"path": "../types"}
]
}
}
4 changes: 2 additions & 2 deletions modules/types/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -8,4 +8,4 @@
"outDir": "dist"
},
"references": []
}
}
4 changes: 2 additions & 2 deletions modules/web-mercator/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.json",
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
Expand All @@ -11,4 +11,4 @@
"references": [
{"path": "../types"}
]
}
}
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
"scripts": {
"bootstrap": "yarn && ocular-bootstrap && npm run build",
"build": "ocular-clean && time ocular-build",
"cover": "ocular-test cover",
"cover": "TS_NODE_PROJECT=tsconfig.test-node.json ocular-test cover",
"lint": "ocular-lint",
"metrics": "ocular-metrics",
"publish-beta": "ocular-publish version-only-beta",
"publish-prod": "ocular-publish version-only-prod",
"test": "ocular-test",
"test-pre-commit": "ocular-lint && ocular-test node"
"test": "TS_NODE_PROJECT=tsconfig.test-node.json ocular-test",
"test-pre-commit": "ocular-lint && TS_NODE_PROJECT=tsconfig.test-node.json ocular-test node"
},
"devDependencies": {
"@probe.gl/bench": "^4.0.0",
Expand Down
74 changes: 74 additions & 0 deletions tsconfig.base.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
{
"compilerOptions": {
"target": "es2020",
"allowJs": true,
"checkJs": false,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"rootDir": ".",
"useDefineForClassFields": false,

// BEGIN TYPE CHECK SETTINGS
"skipLibCheck": true,

"strict": false,

"noImplicitAny": false,
"noImplicitThis": true,
"strictBindCallApply": true,
"strictFunctionTypes": true,
"useUnknownInCatchVariables": true,
// "strictNullChecks": true,
// "strictPropertyInitialization": true,

// "exactOptionalPropertyTypes": true, - requires strictNullChecks
"noFallthroughCasesInSwitch": true,
"noImplicitOverride": true,
"noImplicitReturns": true,
"noPropertyAccessFromIndexSignature": true,
"noUncheckedIndexedAccess": true,
"noUnusedLocals": true,
"noUnusedParameters": false,
// END TYPE CHECK SETTINGS

"paths": {
"@math.gl/core/*": ["./modules/core/src/*"],
"@math.gl/core/test/*": ["./modules/core/test/*"],
"@math.gl/culling/*": ["./modules/culling/src/*"],
"@math.gl/culling/test/*": ["./modules/culling/test/*"],
"@math.gl/dggs-pgeohash/*": ["./modules/dggs-pgeohash/src/*"],
"@math.gl/dggs-pgeohash/test/*": ["./modules/dggs-pgeohash/test/*"],
"@math.gl/dggs-s2/*": ["./modules/dggs-s2/src/*"],
"@math.gl/dggs-s2/test/*": ["./modules/dggs-s2/test/*"],
"@math.gl/dggs-quadkey/*": ["./modules/dggs-quadkey/src/*"],
"@math.gl/dggs-quadkey/test/*": ["./modules/dggs-quadkey/test/*"],
"@math.gl/geoid/*": ["./modules/geoid/src/*"],
"@math.gl/geoid/test/*": ["./modules/geoid/test/*"],
"@math.gl/geospatial/*": ["./modules/geospatial/src/*"],
"@math.gl/geospatial/test/*": ["./modules/geospatial/test/*"],
"@math.gl/polygon/*": ["./modules/polygon/src/*"],
"@math.gl/polygon/test/*": ["./modules/polygon/test/*"],
"@math.gl/proj4/*": ["./modules/proj4/src/*"],
"@math.gl/proj4/test/*": ["./modules/proj4/test/*"],
"@math.gl/sun/*": ["./modules/sun/src/*"],
"@math.gl/sun/test/*": ["./modules/sun/test/*"],
"@math.gl/types/*": ["./modules/types/src/*"],
"@math.gl/types/test/*": ["./modules/types/test/*"],
"@math.gl/web-mercator/*": ["./modules/web-mercator/src/*"],
"@math.gl/web-mercator/test/*": ["./modules/web-mercator/test/*"],
"test/*": ["./test/*"]
},
"plugins": [
{
"transform": "@vis.gl/ts-plugins/ts-transform-append-extension",
"extensions": [".js"],
"after": true
},
{
"transform": "@vis.gl/ts-plugins/ts-transform-append-extension",
"extensions": [".js"],
"afterDeclarations": true
}
]
}
}
10 changes: 10 additions & 0 deletions tsconfig.build.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": "./tsconfig.base.json",
"compilerOptions": {
// Library builds target standard ESM output instead of Node-specific emit.
"module": "es2020",
// Bundler resolution avoids deprecated legacy node resolution while keeping
// package builds compatible with extensionless source imports.
"moduleResolution": "bundler"
}
}
Loading
Loading