Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds makefile and define single word command. #6

Open
wants to merge 18 commits into
base: master
Choose a base branch
from

Conversation

CTHULHU-Jesus
Copy link

Added a makefile that creates the words file that is as up to date as possible with the system.
Also adds a command and function that define a singe word.
Added a Build badge for the makefile with Github Actions.

Copy link
Owner

@Avi-D-coder Avi-D-coder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general I don't think the make dependency is needed here.

I like the idea of custom word lists. We should use vim's spell file (for me that's ~/.config/nvim/spell/en.utf-8.add), rather than our own, but also support additional files in a xdg config dir. Using the vim files adding a word is just zg.

Generating the words from the user's wordnet install is going to be difficult.
ls /*/*/*/index.[anv]* won't work on my nixos machine, since it's dir structures are different.
You could produce the file using the GitHub action and then periodical commit it. That would also have the benefit of updating the wordnet file via standard vim plugin managers.

Thanks for your PR.

.gitignore Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
bin/spell Outdated Show resolved Hide resolved
plugin/wordnet.vim Outdated Show resolved Hide resolved
@CTHULHU-Jesus
Copy link
Author

Personally I don't like the idea of using vim's spell file. At first I redirected words to "/usr/share/dict/words" on my Ubuntu machine and ran into the issue that word net not having definitions for everything in that file. I think the same thing would happen if we used the spell file. I should also mention that my use-case for this plugin is to make sure I am using words correctly (e.x. effect v.s. affect) not to replace vim's normal spelling system. That is the reason that "DefineWord" is the way that it is. I will move the makefile over to being used for building the wordfile though a GitHub action though. That seems the the best solution.
Thank you for taking the time to go over my code. This is my first time contributing to an opensource project. It has been really fun so far.

@Avi-D-coder
Copy link
Owner

Avi-D-coder commented Jul 29, 2021

I'll try and take another look this weekend., as soon as I can find time, (thanks for the great PR).

@Avi-D-coder Avi-D-coder self-assigned this Oct 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants