graphile-postgis 0.1.1 โ†’ 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -12
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -8,20 +8,29 @@
8
8
  <a href="https://github.com/launchql/launchql/actions/workflows/run-tests.yaml">
9
9
  <img height="20" src="https://github.com/launchql/launchql/actions/workflows/run-tests.yaml/badge.svg" />
10
10
  </a>
11
- <a href="https://github.com/launchql/launchql/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
12
- <a href="https://www.npmjs.com/package/graphile-postgis"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/launchql?filename=graphile%2Fgraphile-postgis%2Fpackage.json"/></a>
11
+ <a href="https://github.com/launchql/launchql/blob/main/LICENSE">
12
+ <img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/>
13
+ </a>
14
+ <a href="https://www.npmjs.com/package/graphile-postgis">
15
+ <img height="20" src="https://img.shields.io/github/package-json/v/launchql/launchql?filename=graphile%2Fgraphile-postgis%2Fpackage.json"/>
16
+ </a>
13
17
  </p>
14
18
 
15
- PostGIS helpers for PostGraphile/Graphile. This plugin registers GeoJSON scalars, PostGIS
16
- geometry/geography GraphQL types, and convenience fields for common spatial types.
19
+ **`graphile-postgis`** registers GeoJSON scalars, PostGIS geometry/geography GraphQL types, and convenience fields for common spatial columns in PostGraphile/Graphile schemas.
17
20
 
18
- ## Install
21
+ ## ๐Ÿš€ Installation
19
22
 
20
23
  ```sh
21
24
  pnpm add graphile-postgis
22
25
  ```
23
26
 
24
- ## Usage
27
+ ## โœจ Features
28
+
29
+ - Registers GeoJSON scalars and PostGIS `geometry` / `geography` GraphQL types
30
+ - Convenience fields for common spatial column types
31
+ - Works with PostGraphile CLI or library usage
32
+
33
+ ## ๐Ÿ“ฆ Usage
25
34
 
26
35
  ### CLI
27
36
 
@@ -41,14 +50,11 @@ const options = {
41
50
  };
42
51
  ```
43
52
 
44
- ## Testing
45
-
46
- Tests run against a real Postgres/PostGIS instance using the `graphile-test` and
47
- `pgsql-test` harnesses. The suite seeds the database from `sql/schema.sql`.
53
+ ## ๐Ÿงช Testing
48
54
 
49
55
  ```sh
50
- psql -U postgres -f sql/schema.sql postgres
51
- pnpm test --filter graphile-postgis
56
+ # requires a local Postgres with PostGIS available (defaults to postgres/password@localhost:5432)
57
+ pnpm --filter graphile-postgis test
52
58
  ```
53
59
 
54
60
  ---
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "graphile-postgis",
3
- "version": "0.1.1",
3
+ "version": "0.1.3",
4
4
  "description": "Graphile/PostGraphile PostGIS integration plugin",
5
5
  "author": "Dan Lynch <pyramation@gmail.com>",
6
6
  "homepage": "https://github.com/launchql/launchql",
@@ -39,9 +39,9 @@
39
39
  },
40
40
  "devDependencies": {
41
41
  "@types/geojson": "^7946.0.14",
42
- "graphile-test": "^2.8.9",
42
+ "graphile-test": "^2.8.11",
43
43
  "makage": "^0.1.6",
44
- "pgsql-test": "^2.14.12"
44
+ "pgsql-test": "^2.14.14"
45
45
  },
46
46
  "dependencies": {
47
47
  "graphile-build": "^4.14.1",
@@ -50,5 +50,5 @@
50
50
  "graphql": "15.10.1",
51
51
  "pg": "^8.16.0"
52
52
  },
53
- "gitHead": "3812f24a480b2035b3413ec7fecfe492f294e590"
53
+ "gitHead": "00c90828cab8d3e306ebb2bc6053aab4aa9ae807"
54
54
  }