check-geojson - GitLite

KO | EN

gitlite — search

#hacktoberfest #llm #go #golang #linux #docker #java #windows #kubernetes #vue #pytorch #mcp #openai #open-source

check-geojson

(★ 86)

a checker for the geojson format. goes beyond a schema, checking semantics and producing character-level warnings.

File Explorer

Download Latest Version (.zip)

- - main.yml
- pre-commit
- - highlight.css
  - icons.css
  - icons.png
  - icons@2x.png
  - main.js
  - search.js
  - style.css
  - widgets.png
  - widgets@2x.png
- - HintError.html
- - HintIssue.html
- .nojekyll
- CNAME
- index.html
- modules.html
- array_is_numbers.ts
- check_duplicate_keys.ts
- enforce_bbox.ts
- enforce_position.ts
- enforce_position_array.ts
- enforce_same_position.ts
- errors.ts
- forbid_confusing_properties.ts
- get_array.ts
- get_member_value.ts
- get_object.ts
- get_type.ts
- index.ts
- types.ts
- bad.test.ts
- good.test.ts
- scavenge.test.ts
- momoa.d.ts
.deepsource.toml
.eslintrc.js
.gitattributes
.gitignore
CHANGELOG.md
CNAME
LICENSE
mise.toml
package.json
pnpm-lock.yaml
README.md
tsconfig.json
typedoc.json

# Installation Guide

1. Get the code

git clone https://github.com/placemark/check-geojson

Downloads the entire project code from GitHub to your computer.

cd check-geojson

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

pnpm add @placemarkio/check-geojson

Type this command into your terminal and run it.

yarn add @placemarkio/check-geojson

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# check-geojson

A spiritual successor to [geojsonhint](https://github.com/mapbox/geojsonhint), which is no longer maintained.

check-geojson is a parser and validator for GeoJSON strings. It is tailored to the use cases of validating user-generated GeoJSON content, or troubleshooting GeoJSON that you've received.

_Note: the API is not yet stable._

## [📕 API Documentation](http://check-geojson.docs.placemark.io/)

### Main differences from geojsonhint

- Actively maintained
- Written in TypeScript and includes types
- Uses [momoa](https://github.com/humanwhocodes/momoa) to parse JSON instead of a homemade
  parser. This is probably the biggest one. jsonlint-lines was a hack, which I created
  because I could not find a single parser that actually parsed JSON and gave line numbers
  for values. momoa is much better than that hack, and using it makes line-level errors
  much cleaner.

Unlike geojsonhint, this checker _only_ produces errors, not warnings. So things
that geojsonhint would warn about, like:

- excessive coordinate precision
- right-hand rule compliance

This does not check for. Additionally, the `crs` member is ignored by this tool: as of
the latest GeoJSON specification, this is [not used](https://datatracker.ietf.org/doc/html/rfc7946#appendix-B.1).

We're using the same test fixtures as geojsonhint as a starter.

### Install

```shell
pnpm add @placemarkio/check-geojson
yarn add @placemarkio/check-geojson
```

### Usage

```ts
import { check } from "@placemarkio/check-geojson"

let geojsonObject;
try {
  geojsonObject = check('… geojson string …')
} catch (e) {
  /// e.issues
}
```

If your GeoJSON is already an object, you will need to convert it to a string first. geojson-check will re-parse it. You should consider the performance penalty of this.

```ts
const issues = getIssues(JSON.stringify(geojsonObject));
if (issues.length > 0) {
  // ...
}
```

---

[![Maintainability](https://api.codeclimate.com/v1/badges/0a1d1c0755b9e67406f1/maintainability)](https://codeclimate.com/repos/60a64f6aa449b13bc40002bd/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/0a1d1c0755b9e67406f1/test_coverage)](https://codeclimate.com/repos/60a64f6aa449b13bc40002bd/test_coverage)