odakaui / vocabulist Goto Github PK

Speed up build:

• Remove windows target from travis.
• Only run cargo build --release on tagged commits.
• Run cargo build on all branches.

Right now, nothing happens when the program is run without arguments.

Instead, show help.

Add unit/integration tests for all code.

The error message should read:

"Could not filter definition by POS"

Figure out how the release are going to be distributed.

Through cargo?
Through downloads?
Installer script?

Also add github actions to the project to build and test?

Right now you can only list expressions. It would be nice to be able to list expressions based on POS.

Right now since only one tokenizer is supported it would be jumanpp POS. However if multiple tokenizers are supported in the future this will have to change.

Possibly get the POS values from the POS table in the database?

Implement a GUI for vocabulist.

Pros

• Make it more accessible for non developers.
• Make document syntax highlighting and hover over definitions possible.
• Make it possible to add and edit definitions for terms.

Cons

• Harder to keep cross platform?
• Larger package size.
• More complexity.
• Bloat?

If I do implement a user interface it would probably be something cross platform.
Electron or another cross platform framework.

I also have dreams of an iOS and Android app.

Add the ability to exclude/include expressions based on POS.

Right now you can only exclude/include expressions with a file of expressions separated by a newlines.
Add the ability to exclude/include expressions based on a file of pos separated by newlines.

Only give "cannot be filtered by kanji" if the term also "cannot be filtered by pos".

Right now there is no feedback when the program is generating flashcards.

Implement a progress bar giving the number of flashcards left to generate.

Create separate paths for jmdict.db, vocabulist_rs.db and config.toml for debug vs release code.

This way the user can have the release version installed while still being able to test the new version.

Sync database with Anki.

Right now the user has to manually go into the database using sqlite3 and reset the in_anki, is_learned, and is_excluded fields.
The program should do that with the sync command.
Expressions that are in anki will be marked as in_anki = 1.
Expressions of notes that are suspended in anki will be marked as is_excluded = 1.
Expressions of notes that are mastered will be marked as is_learned = 1.

There might be a problem with marking expressions as is_learned. Anki could potentially have multiple cards per note. It appears that you can search for a card and then get the note for that card. However, it is unclear how anki defines mastered. This is potentially an additional feature that should have its own issue.

Add the ability to parse a file and spit out a report.

The report should list all of the tokens in the file.
The tokens can be filtered based on in_anki, is_learned, and is_excluded.
The definitions for the token and each sentence for the token will be placed under each token.

The report will be able to be printed to the console, markdown, html, and possibly other mediums such as pdf.

Add comments on code. Update README.md. Create a wiki?

Change dependency from Jumanpp to Nagisa.

Decouple code so that a Chinese parser like Lac, Jieba, or HanLP can be used.

When using the generate command. Notes with expressions that do not contain kanji end up with blank readings.

The expected behavior is that the notes will have a reading that is the same as the expression.

The dictionary need to be accessed if a user wants to "reset" the definition of a term.

Originally posted by @odakaui in #30 (comment)

If the definitions are stored in the database along with the terms as in #48, then the user might need to "reset" the definition for single term or all terms.

They might need to do this for one of the following reasons, or another reason altogether.

• They change dictionary. (from a Japanese-English dictionary to a Japanese-Japanese dictionary)
• They add an additional dictionary.
• They sync a definition(s) from Anki.
• They edit or delete a definition.
• They add a definition and want to revert it back to the dictionary definition.

Add Homebrew Instructions to README

When the config file does not contain the correct fields you get this error.

Error: Error { inner: ErrorInner { kind: Custom, line: Some(3), col: 0, at: Some(124), message: "missing field `backend`", key: [] } }

Make the program fail gracefully.

I would like to rewrite the tokenizer in rust so that I do not have to rely on external dependencies.

It will be a separate crate that could be used by itself.
It will be written in rust.
It will use the unidic or another tokenizer dictionary.
It will return the surface string, normalized version and pos of each word.
It will be fast and efficient.
It will be licensed under either the MIT or Apache 2.0 License.

I'll need to do some research.

I already looked at sudachi clone, but it doesn't appear that you can put the dictionary at any path.
I also looked at yoin but I'd like to try my hand at writing it myself for the learning experience.

Create a toml config file to store the settings.

Expressions of notes that are mastered should be marked as is_learned = 1.

There might be a problem with marking expressions as is_learned. Anki could potentially have multiple cards per note. It appears that you can search for a card and then get the note for that card. However, it is unclear how anki defines mastered. This is potentially an additional feature that should have its own issue.

Give the user the ability to choose a different dictionary.

Either a Japanese to Japanese dictionary.
A Chinese dictionary.
Any other type of dictionary.

Create a trait for the dictionaries to decouple the code and make it easier to write different dictionary backends.

Add the ability to parse a text file and then create a deck in anki from it.

The deck name could be the file name or something else.
The expressions in the deck wouldn't be added to the database?
Expressions wouldn't be added to the deck if they already exist in anki?
Expressions wouldn't be added if they are mastered in anki?

Add instructions for installation via Homebrew.

brew install odakaui/vocabulist/vocabulist

Otherwise the path to jmdict.db is incorrect.

I would like to add a table to the database for the definitions of each term.

Pros:

• Allow the user to get the definitions for a term without querying a second database.
• Speed up listing terms with their definitions.
• Allow the user to sync existing definitions for a given term to Anki.
• Allow the user to store definitions from multiple dictionaries for a single term.
• Allow the user to use multiple dictionaries. (#30)

Cons:

• Require changes to the database, specifically the join table.
• Increase the amount of time required during an import operation.
• Require changes to the way dictionaries are queried.

For some reason the sync command is printing three of each term in Anki.

まさか
まさか
まさか
浴びる
浴びる
浴びる

I guess if the note has multiple cards for each note then this will happen.

Solution: Deduplicate the card list.