https://github.com/tmcw/parse-gedcom

A simple GEDCOM parser that focuses on translating GEDCOM structure into JSON.
https://github.com/tmcw/parse-gedcom

Last synced: 2 months ago
JSON representation

A simple GEDCOM parser that focuses on translating GEDCOM structure into JSON.

• Host: GitHub
• URL: https://github.com/tmcw/parse-gedcom
• Owner: tmcw
• License: isc
• Created: 2015-01-04T19:12:01.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-01-24T16:21:02.000Z (9 months ago)
• Last Synced: 2024-07-29T00:54:51.094Z (2 months ago)
• Language: TypeScript
• Homepage: https://tmcw.github.io/parse-gedcom/live/
• Size: 300 KB
• Stars: 158
• Watchers: 11
• Forks: 31
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-gedcom - parse-gedcom - A simple GEDCOM parser that focuses on translating GEDCOM structure into JSON (Parsers / JavaScript/Node.js)

README

        
# gedcom

A small, simple parser for [GEDCOM](http://en.wikipedia.org/wiki/GEDCOM) 5.5.1.

# [API Documentation](./docs/README.md)

### Installation

The `gedcom` package can be added as a dependency to use in your code, or

if you'd like to just use the CLI, install it globallly:

```

npm install -g gedcom

```

### CLI

```

Usage

$ parse-gedcom 

	Options

	  --type, -s   Output type (json, d3.json, dot)

	Examples

	  $ gedcom input.ged output.json

```

### Caveats

- The GEDCOM specification allows use of an ANSEL character encoding - a nearly-unknown

  predecessor to UTF-8. This parser doesn't currently handle ANSEL encoding, so it

  may behave oddly with files in ANSEL. However, it appears that most programs that

  export GEDCOM default to or at least support UTF-8, which is recommended instead.

- The GEDCOM standard is ubiquitous and practical, but has [embedded cultural biases](./GEDCOM_BIAS.md).

  This parser allows "non-standard" input in places where GEDCOM is bigoted, like

  the `SEX_VALUE` field.