zzarcon / gh-emoji

Github emoji parsing done right :point_up: :pray: :point_up_2: :clap: :ok_hand:
http://zzarcon.github.io/gh-emoji/
MIT License
160 stars 7 forks source link

Better structure for project #16

Closed rpunkfu closed 8 years ago

rpunkfu commented 8 years ago

We should probably move files to lib, bin directories and in future separate it into some modules, same goes for the tests. What do you think @zzarcon?

ryyppy commented 8 years ago

What would you put into the bin directory? Because usually this is a pretty common directory for global node scripts in npm packages

rpunkfu commented 8 years ago

Usually bin is an entry point for npm and all functionality is imported from lib. It was just a loose idea, I'd love to know your opinion @ryyppy :)

ryyppy commented 8 years ago

So usually for ES6 people tend to use the ./src directory... I would also suggest to split functionality of gh-emoji.js up in multiple files as the code grows, so we maybe wanna move the current source to src/index.js and iterate from there

rpunkfu commented 8 years ago

Yes, that's what I proposed yesterday to @zzarcon :)

rpunkfu commented 8 years ago

Will open PR with it later :)

rpunkfu commented 8 years ago

Structure is pretty much improved with #23 & #25. There's going to be a new issue about splitting functionality into multiple modules.