https://github.com/hexenq/kuroshiro-analyzer-kuromoji

Kuromoji morphological analyzer for kuroshiro.
https://github.com/hexenq/kuroshiro-analyzer-kuromoji

analyzer hiragana japanese kanji katakana kuromoji kuroshiro language morphology romaji

Last synced: 5 months ago
JSON representation

Kuromoji morphological analyzer for kuroshiro.

• Host: GitHub
• URL: https://github.com/hexenq/kuroshiro-analyzer-kuromoji
• Owner: hexenq
• License: mit
• Created: 2018-03-09T09:34:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-02-20T09:33:06.000Z (over 3 years ago)
• Last Synced: 2024-12-11T14:05:21.520Z (6 months ago)
• Topics: analyzer, hiragana, japanese, kanji, katakana, kuromoji, kuroshiro, language, morphology, romaji
• Language: JavaScript
• Homepage:
• Size: 110 KB
• Stars: 57
• Watchers: 5
• Forks: 27
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kuroshiro-analyzer-kuromoji

 

[![Build Status](https://travis-ci.com/hexenq/kuroshiro-analyzer-kuromoji.svg?branch=master)](https://travis-ci.org/hexenq/kuroshiro-analyzer-kuromoji)

[![Coverage Status](https://coveralls.io/repos/github/hexenq/kuroshiro-analyzer-kuromoji/badge.svg?branch=master)](https://coveralls.io/github/hexenq/kuroshiro-analyzer-kuromoji?branch=master)

[![npm version](https://badge.fury.io/js/kuroshiro-analyzer-kuromoji.svg)](http://badge.fury.io/js/kuroshiro-analyzer-kuromoji)

    

        Package

        kuroshiro-analyzer-kuromoji

    

    

        Description

        Kuromoji morphological analyzer for kuroshiro.

    

    

        Compatibility

        Node

        ✓ (>=6)

    

    

        Browser

        ✓

    

## Install

```sh

$ npm install kuroshiro-analyzer-kuromoji

```

*For legacy frontend workflows, you could include `dist/kuroshiro-analyzer-kuromoji.min.js` in your page and the exported name is `KuromojiAnalyzer`. (you may first build it from source with `npm run build` after `npm install`)*

## Usage with kuroshiro

### Configure analyzer

This analyzer utilizes [kuromoji.js](https://github.com/takuyaa/kuromoji.js). 

You could specify the path of your dictionary files with `dictPath` param. 

```js

import KuromojiAnalyzer from "kuroshiro-analyzer-kuromoji";

const analyzer = new KuromojiAnalyzer();

await kuroshiro.init(analyzer);

```

### Initialization Parameters

__Example:__

```js

const analyzer = new KuromojiAnalyzer({

    dictPath: "url/to/dictionary_files"

});

```

- `dictPath`: *Optional* Path of the dictionary files