henkan 0.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+---
+
+## Submitting Pull Requests
+
+1. **Fork** the repo.
+2. Create a branch off `main` named `fix/<short-description>` or `feat/<short-description>`.
+3. Make your changes against that branch and push everything to the remote forked repo.
+4. Submit a PR from that new branch and link any relevant issue(s).
+
+### Your PR should include:
+
+- A clear title, describing your changes in as very little details as possible.
+- A description of **what** you changed and **why**.
+- Screenshots or examples of the changes. *(if applicable)*
+
+## **Security vulnerabilities**
+  - See [Security Policy](https://github.com/Ronokof/Henkan/security/policy).
+
+---
+
+## License & Code of Conduct
+  - By contributing, you agree that your work will be licensed under and must comply with this repository’s [LICENSE.md](LICENSE.md).
+  - Please also respect the [Code of Conduct](CODE_OF_CONDUCT.md).

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ronokof
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# henkan
+
+A Node.JS library that helps you convert any dictionary from [EDRDG](https://www.edrdg.org/), transform their entries into more user-friendly schemas and create Anki notes from the them.
+
+> The library is used for the [Full Japanese Study Deck](https://ankiweb.net/shared/info/1407096987), so some features might be tailored specifically to the deck.
+
+[![npm](https://img.shields.io/npm/v/henkan.svg)](https://www.npmjs.com/package/henkan) [![license](https://img.shields.io/github/license/Ronokof/Henkan)]()
+
+---
+
+# Table of contents
+
+- [Install](#install)
+- [Features](#features)
+- [Example](#example)
+- [API](#api)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+# Install
+
+```bash
+# npm
+npm install henkan
+
+# or yarn
+yarn add henkan
+
+# or pnpm
+pnpm add henkan
+```
+
+# Features
+ - JMdict, KANJIDIC, Tanaka Corpus, RADK and KRAD conversion
+ - User-friendly schemas for dictionary entries
+ - Anki note generation
+ - Other useful tools (AWS Polly audio generation, Japanese RegExps, array checking etc.)
+
+---
+
+# Example
+
+Download the [JMdict_e.gz](http://ftp.edrdg.org/pub/Nihongo/JMdict_e.gz) archive and extract `JMdict_e` from it.
+
+```js
+import fs from 'fs';
+import { convertJMdict, generateAnkiNotesFile, getWord } from 'henkan';
+//const fs = require('fs');
+//const { convertJMdict, generateAnkiNotesFile, getWord } = require('henkan');
+
+const dictPath = './JMdict_e';
+const dictContent = fs.readFileSync(dictPath, 'utf-8');
+
+const dictWords = convertJMdict(dictContent);
+
+const noteTypeName = 'Word';
+const deckName = 'Japanese::Vocabulary::No kanji form words';
+
+const noKanjiFormWords = dictWords
+    .filter(word => word.kanjiForms === undefined)
+    .map(word => getWord(undefined, undefined, undefined, undefined, word, noteTypeName, deckName));
+
+const ankiNotesFile = generateAnkiNotesFile(noKanjiFormWords);
+
+if (ankiNotesFile) fs.writeFileSync('./nokfwords.json', ankiNotesFile, 'utf-8');
+```
+
+# API
+
+See [API README](docs/api/README.md)
+
+---
+
+# Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)
+
+# License
+
+This library is licensed under the [MIT License](LICENSE.md).

package/SECURITY.md

@@ -0,0 +1,20 @@
+# Security
+
+This project takes security seriously. Report any vulnerability or security issue regarding the library to *ronokoffjsd@gmail.com*. **Please do not open a public issue!**
+
+### The report should include:
+  - A clear and detailed description of the issue
+  - Steps to reproduce
+  - Any PoC or sample files (if applicable)
+
+---
+
+## Supported Versions
+
+Always consider the [latest version](https://github.com/Ronokof/Henkan/releases/latest) as the **only** supported version.
+
+---
+
+## License
+
+By using this project you agree to the repository's [LICENSE.md](LICENSE.md).