gleo - npm Package Compare versions

Comparing version 0.0.0-alpha0 to 0.1.0

package.json

 {
 	"name": "gleo",
-	"version": "0.0.0-alpha0",
+	"version": "0.1.0",
 	"description": "WebGL-powered geographical maps.",
-	"main": "src/index.mjs",
+	"module": "src/index.mjs",
 	"scripts": {
-		"docs": "npm run docs-api && npm run docs-uml",
-		"docs-api": "leafdoc -t build/leafdoc-templates/plain -o docs/api-reference.html -c \"@\" src/*.leafdoc src/*.mjs src/**/*.mjs -e true",
-		"docs-uml": "leafdoc -t build/leafdoc-templates/graphviz-class-diagram -o docs/class-diagram.dot -c \"@\" src/**/*.leafdoc src/*.mjs src/**/*.mjs",
-		"test": "jasmine",
-		"lintfix": "prettier src/**.mjs src/**/**.mjs spec/**.mjs spec/**/**.mjs spec/**/**/**.mjs browser-demos/*.html *.json --write"
+		"docs": "npm run docs-api && npm run docs-uml-bare && npm run docs-uml-bare-symbols && npm run docs-uml-full",
+		"docs-api": "leafdoc -t build/leafdoc-templates/apidocs -o website/apidoc/api-reference.html -c \"@\" src/index.leafdoc src/**/*.leafdoc src/*.mjs src/**/*.mjs -e true",
+		"docs-uml-full": "leafdoc -t build/leafdoc-templates/graphviz-uml-full -o website/apidoc/class-diagram-full.dot -c \"@\" src/index.leafdoc src/**/*.leafdoc src/*.mjs src/**/*.mjs",
+		"docs-uml-bare": "leafdoc -t build/leafdoc-templates/graphviz-uml-bare -o website/apidoc/class-diagram-bare.dot -c \"@\" src/index.leafdoc src/**/*.leafdoc src/*.mjs src/**/*.mjs",
+		"docs-uml-bare-symbols": "leafdoc -t build/leafdoc-templates/graphviz-uml-bare -o website/apidoc/class-diagram-bare-symbols.dot -c \"@\" src/*.mjs src/symbols/*.mjs src/acetates/*.mjs src/symboldecorators/*.mjs src/symboldecorators/*.leafdoc",
+		"test": "npm run test-node && npm run test-puppeteer",
+		"test-node": "jasmine",
+		"test-puppeteer": "node spec/launch-puppeteer.mjs",
+		"lintfix": "prettier `git ls-tree --full-tree -r --name-only HEAD | grep -v 3rd-party | grep -v yml$ | grep -v png$ | grep -v assets | grep -v src/glii | grep -v src/arrugator | grep -v leafdoc-templates | grep -v geojson$` --write",
+		"start": "serve --symlinks",
+		"prepare": "husky install"
 	},
@@ -20,5 +26,2 @@ "keywords": [
 	"license": "GPL-3.0",
-	"dependencies": {
-		"glii": "0.0.0-alpha.8"
-	},
 	"prettier": {
@@ -32,7 +35,21 @@ "printWidth": 90,
 	"devDependencies": {
-		"jasmine": "^3.7.0",
+		"@napi-rs/canvas": "^0.1.22",
+		"gl": "^5.0.3",
+		"husky": "^8.0.2",
+		"jasmine": "^4.0.2",
 		"leafdoc": "^2.3.0",
-		"livereload": "^0.9.3",
-		"prettier": "^2.2.1"
+		"lint-staged": "^13.1.0",
+		"pngjs": "^6.0.0",
+		"prettier": "^2.2.1",
+		"prosthetic-hand": "^1.4.0",
+		"puppeteer": "^19.4.0",
+		"serve": "^14.1.2",
+		"serve-handler": "^6.1.3"
+	},
+	"hooks": {
+		"pre-commit": "lint-staged"
+	},
+	"lint-staged": {
+		"*.(js|mjs|html)": "prettier --write"
 	}
 }

README.md

@@ -5,6 +5,48 @@ # GLeo
 
+Gleo is a library for displaying geographical maps (and map-like things on cartesian planes), leveraging WebGL1 via the [Glii](https://gitlab.com/IvanSanchez/glii) abstraction library. It aims to cover the use cases of Leaflet, OpenLayers or MapboxGL/MaplibreGL, but since it's a one-man project, it's not quite there yet.
 
+### I want to see it working!
 
+Go to https://ivansanchez.gitlab.io/gleo/ , then.
 
+### Trying out
 
+1. Clone the repo
+2. Run a `git submodule init` plus `git submodule update`
+  - This pulls the `glii` and `arrugator` dependencies from their git repos
+3. Spin up a local webserver
+4. Browse the demos in `/browser-demos`
 
+No bundling needed! Gleo leverages the magic of ES6 modules.
+
+### Documentation
+
+Running `npm install` then `npm run docs` will build the API documentation and the graphviz UML diagram.
+
+### Legalese
+
+Gleo itself is licensed under a GPL license. See the `LICENSE.md` file for details.
+
+Gleo depends on some javascript libraries, which are bundled under `src/3rd-party`:
+
+-   [`shelf-pack` by Bryan Housel](https://github.com/mapbox/shelf-pack/), ISC licensed.
+-   [`css-color-parser` by Dean McNamee](https://github.com/deanm/css-color-parser-js), MIT licensed.
+-   [`earcut` by Vladimir Agafonkin](https://github.com/mapbox/earcut), ISC licensed.
+-   [`glmatrix` by Brandon Jones, Catto Petter, _et al_](https://github.com/toji/gl-matrix), MIT licensed.
+-   [`point-geometry` by Tom McWright, _et al_](https://github.com/mapbox/point-geometry), ISC licensed.
+-   [`rbush-knn` by Vladimir Agafonkin](https://github.com/mourner/rbush-knn), ISC licensed, plus dependencies:
+    -   [`rbush` by Vladimir Agafonkin](https://github.com/mourner/rbush), MIT licensed.
+    -   [`tinyqueue` by Vladimir Agafonkin](https://github.com/mourner/tinyqueue), ISC licensed.
+    -   [`quickselect` by Vladimir Agafonkin](https://github.com/mourner/quickselect), ISC licensed.
+-   [`vector-tile-js` by Vladimir Agafonkin, John Firebaugh, Tom McWright, _et al_](https://github.com/mapbox/vector-tile-js), BSD-3 licensed, plus dependencies:
+    -   [`pbf` by Vladimir Agafonkin](https://github.com/mapbox/pbf), BSD-3 licensed.
+    -   [`ieee754` by Feross Aboukhadijeh](https://github.com/feross/ieee754), BSD-3 licensed.
+
+As well, Gleo uses some geographical data, assets and non-required javascript libraries in the demos:
+
+-   [proj4js](http://proj4js.org/)
+-   Natural Earth
+-   [geoboundaries](https://www.geoboundaries.org/)
+-   [OpenStreetMap](https://osm.org) data in several forms
+-   [Leaflet.ExtraMarkers](https://github.com/coryasilva/Leaflet.ExtraMarkers) spritesheet
+-   [geographiclib](https://geographiclib.sourceforge.io/)

src/3rd-party/earcut/README.md

@@ -1,2 +0,1 @@
-
 This directory contains a copy of Vladimir Agafonkin's "earcut" library, trivially adapted as a ES module.
@@ -7,2 +6,1 @@
 See https://github.com/mapbox/earcut
-

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1855839

increased by272.3%

Dependency count

0

decreased by-100%

Number of package files

249

increased by141.75%

Lines of code

43713

increased by784.52%

Number of lines in readme file

52

increased by420%

Worsened metrics

Dev dependency count

12

increased by200%

Number of medium supply chain risk alerts

10

increased by900%

Dependency changes

• - Removedglii@0.0.0-alpha.8

• - Removedglii@0.0.0-alpha.8(transitive)