@tykok/cedict-dictionary

A simple chinese dictionary based on the Cedict

https://github.com/tykok/cedict-chinese-transformation

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary

Keywords

cedict chinese cli typescript
Last synced: 4 months ago · JSON representation ·

Repository

A simple chinese dictionary based on the Cedict

Basic Info
Statistics
  • Stars: 10
  • Watchers: 0
  • Forks: 1
  • Open Issues: 0
  • Releases: 14
Topics
cedict chinese cli typescript
Created about 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License Code of conduct Citation Codeowners

README.md

 

Cedict Dictionary

![GitHub License](https://img.shields.io/github/license/tykok/cedict-chinese-transformation?style=plastic) ![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/tykok/cedict-chinese-transformation/main?style=plastic) ![GitHub top language](https://img.shields.io/github/languages/top/tykok/cedict-chinese-transformation?style=plastic)

GitHub Workflow


GitHub Workflow Status (with branch) GitHub Workflow Status (with branch) GitHub Workflow Status (with branch)



The Cedict Dictionary was created to use the Chinese dictionary easily.

With this library, you can use the many methods to search :

  1. Chinese character
  2. Simplified Chinese character
  3. Intonation in "Pinyin"
  4. English traduction

Or you can simply create tour own methods with the Cedict JSON file which will be updated every time a new version of the Cedict appear.

To know more about the Cedict, go on this page.

Table of Contents

Getting Started

First to use the library, you should use this command into your project :

shell npm i @tykok/cedict-dictionary

Cedict

How to use the Cedict class in your project ? Simple, you just need to import it where you want with :

ts import Cedict from '@tykok/cedict-dictionary'

Next, you can use some static functions like :

ts Cedict.getByPinyin('ni3')

To know all about this class, go on the documentation.

Next features

Maybe, I'll:

  • Implement a CLI command for Cedict.
  • Implement a Cedict database generation.

Contributing

Development happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements.

Read below to learn how you can take part in improving this Cedict Dictionary.

Code of Conduct

We adopted a Code of Conduct that we expect Cedict Dictionary participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to our Cedict Dictionary.

Owner

  • Name: Tykok
  • Login: Tykok
  • Kind: user
  • Location: Toulouse
  • Company: Pictarine

The difference between the "possible" and "the impossible" is determination. ("Gandhi")

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Treport"
  given-names: "Treport Elie"
title: "Cedict dictionary"
version: 1.5.0
date-released: 2023-01-27
url: "https://github.com/Tykok/cedict-chinese-transformation"

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 120
  • Total Committers: 5
  • Avg Commits per committer: 24.0
  • Development Distribution Score (DDS): 0.458
Top Committers
Name Email Commits
Tykok t****2@g****m 65
CI ci@g****m 35
Tykok 5****k@u****m 8
dependabot[bot] 4****]@u****m 6
CI c****n@g****m 6
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 5 months ago

All Time
  • Total issues: 25
  • Total pull requests: 139
  • Average time to close issues: 2 months
  • Average time to close pull requests: 9 days
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.24
  • Average comments per pull request: 0.48
  • Merged pull requests: 67
  • Bot issues: 0
  • Bot pull requests: 83
Past Year
  • Issues: 0
  • Pull requests: 24
  • Average time to close issues: N/A
  • Average time to close pull requests: 9 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.63
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 20
Top Authors
Issue Authors
  • Tykok (24)
  • dengel29 (1)
Pull Request Authors
  • dependabot[bot] (106)
  • Tykok (58)
Top Labels
Issue Labels
feature (19) doc (4) ci (4) bug (1)
Pull Request Labels
bot (105) dependencies (1)

Packages

  • Total packages: 3
  • Total downloads:
    • npm 87 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 19
  • Total maintainers: 1
npmjs.org: cedict-dictionary

The cedict dictionary get and format the cedict to a JSON file

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 7 Last month
Rankings
Dependent repos count: 5.9%
Forks count: 12.0%
Stargazers count: 14.4%
Average: 19.1%
Dependent packages count: 23.0%
Downloads: 40.1%
Maintainers (1)
Last synced: 5 months ago
npmjs.org: @tykok/cedict-dictionary

The Cedict dictionary get and format the cedict to a JSON file

  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 42 Last month
Rankings
Downloads: 8.3%
Forks count: 20.5%
Average: 21.8%
Stargazers count: 22.1%
Dependent repos count: 25.3%
Dependent packages count: 32.9%
Maintainers (1)
Last synced: 5 months ago
npmjs.org: @tykok/cedict-dictionnary

The cedict dictionnary get and format the cedict to a JSON file

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 38 Last month
Rankings
Forks count: 14.3%
Stargazers count: 17.1%
Dependent packages count: 22.0%
Average: 25.5%
Dependent repos count: 26.3%
Downloads: 48.0%
Maintainers (1)
Last synced: 5 months ago

Dependencies

package.json npm
  • @types/node ^18.11.9 development
  • @types/superagent ^4.1.15 development
  • concurrently ^7.5.0 development
  • nodemon ^2.0.20 development
  • typescript ^4.9.3 development
  • extract-zip ^2.0.1
  • superagent ^8.0.3
  • unzip ^0.1.11
.github/workflows/cron.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v3 composite
.github/workflows/on-push-main.yml actions
  • actions/checkout v2 composite
  • actions/checkout v3 composite
  • actions/create-release v1 composite
  • actions/setup-node v3 composite
  • martinbeentjes/npm-get-version-action main composite
.github/workflows/unpublish.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/auto-approve.yml actions
  • hmarr/auto-approve-action v3 composite
.github/workflows/auto-merge.yml actions
  • peter-evans/enable-pull-request-automerge v2 composite
.github/workflows/on-pr-on-main.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/run-check.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite