djtb/hatsuon

Japanese pitch accent utils

発音 hatsuon

Japanese pitch accent tools

Why?

Japanese dictionaries often display the pitch accent of a word with a single number that determines where the pitch falls. This can be difficult to mentally visualize without counting through the mora of the word. This library provides useful tools for generating pitch patterns which can then be easily displayed via SVG.

Installation

npm install --save hatsuon

Demo

Visualization Example

Usage

import { hatsuon } from 'hatsuon';

hatsuon({ reading: 'ちゅうがっこう', pitchNum: 3 });
// =>
{
  reading: 'ちゅうがっこう',
  pitchNum: 3,
  morae: ['ちゅ', 'う', 'が', 'っ', 'こ', 'う'],
  // low, high, high, low, low, low, low*
  // *following particle (は、が, の etc) pitch
  pattern: [0, 1, 1, 0, 0, 0, 0],
  patternName: '中高', // nakadaka
}

Extra available utils (see source for documentation):

import {
  isDigraph,
  getMorae,
  getMoraCount,
  makePitchPattern,
  getPitchPatternName,
  getPitchNumFromPattern,
} from 'hatsuon';

Related

WanaKana : Japanese romaji <-> kana transliteration library

Contributors

Thanks goes to these people (emoji key):

Duncan Bay 💻 📖 🚇 🎨

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT © Duncan Bay

hatsuon's Issues

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

The push permission to the Git repository is required.

semantic-release cannot push the version tag to the branch master on remote Git repository.

Please refer to the authentication configuration documentation to configure the Git credentials on your CI environment.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀