0.0.1 • Published 7 months ago

parse-german v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

parse-german

Build Coverage Downloads Size

A natural language parser for the German language, that produces nlcst. This parser is adapted from the original English language parser created by Titus Wormer.

Contents

What is this?

This package exposes a parser that takes German natural language and produces a syntax tree. It is an adaptation of the parse-english parser created by Titus Wormer.

When should I use this?

If you need to handle German natural language as syntax trees manually, this is for you. It’s specifically tailored to handle the nuances and structures of the German language.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install parse-german

In browsers with esm.sh:

<script type="module">
  import {ParseGerman} from 'https://esm.sh/parse-german?bundle'
</script>

Use

Example usage of the parser:

import {ParseGerman} from 'parse-german'
import {inspect} from 'unist-util-inspect'

const tree = new ParseGerman().parse('Dies ist ein einfacher deutscher Satz.')

console.log(inspect(tree))

This yields a syntax tree structure that represents the sentence, breaking down its grammatical components and their hierarchical relationships.

API

ParseGerman()

Create a new parser for the German language. Adapted from the ParseEnglish parser, and extends ParseLatin.

Algorithm

Incorporates all features of parse-latin, with additional support for German language-specific elements like compound nouns, umlauts, and special characters, ensuring a more accurate parsing of the German language.

Types

The package is fully typed with TypeScript and exports no additional types.

Compatibility

Compatible with maintained versions of Node.js.

Security

This package is safe to use.

Related

Contribute

Contributions are welcome! See How to Contribute to Open Source.

License

MIT © Dennis Ollhoff

Acknowledgement

This parser is an adaptation of the parse-english parser created by Titus Wormer. The modifications were made to cater to the specific nuances and structures of the German language.