Plugin development heaven - yeoman generator

93 views
Skip to first unread message

Danielo Rodríguez

unread,
Apr 9, 2017, 11:14:50 AM4/9/17
to TiddlyWiki
Hey!

Hello everyone.
I know this is a better fit for tiddlywikiDev, but I hope that having this tool more regular people will try to start developing tw5 plugins.

During my first years of experience with tiddlywiki, the hardest part about plugin programming was how to start:
  •  Which tools do I need ?
  •  How should I configure them?
  • What's the required folder structure?
  • How is the structure of x tiddlywiki module? Which are the correct fields? Headers?
  • Which names should I give to my files? Which extensions are acceptable ?
  • How can I build an index page? Where can I publish it?
  • Which plugins do I need ? What are the basic ones? 
  • What are the available themes ?

etc, etc

I just published a yeoman generator for scaffolding tiddlywiki 5 plugins. It bootstraps a nodejs dev environment.
It includes the following features:

  • Very comfortable developer experience
  • Use latest Javascript ES6 features thanks to Babel
  • Automatic github pages publishing using Travis-CI
  • Easy management using npm scripts
  • Automatic code rebuild and server restart on changes using nodemon
  • Add plugins just by selecting them from a list of official ones
  • Add themes just by selecting them from a list of official ones
  • Add languages just by selecting them from a list of official ones
  • Scaffolding of tiddlywiki's Javascript modules (just during project generation at the moment)
    • startup module
    • javascript macro
    • javascript library

Future features
  • Scaffolding of all kind of tiddlywiki Javascript modules using subgenerators at any time (not only during first bootstrap)
I know that one generator exists already, but this one is focused specifically on plugin development, while the other is more about a regular tiddlywiki on nodejs. 
I think both have their target audience.

I want to give special credit to Felixhayasi, the creator of tiddlymap. He is the author of the original gulpfile that is used.


For more information about installation and usage: https://www.npmjs.com/package/generator-tw5-plugin
For contributtions and feature requests: https://github.com/danielo515/generator-tw5-plugin

Hope more people starts developing plugins after this

Mat

unread,
Apr 9, 2017, 2:29:40 PM4/9/17
to TiddlyWiki
Danielo, thanks for kicking ass :-)

<:-)
Reply all
Reply to author
Forward
0 new messages