search

rajgoel / reveal.js-plugins

Plugins for reveal.js
MIT License
730 stars 248 forks source link

Include module versions #117

Open ryzokuken opened 3 years ago

ryzokuken commented 3 years ago

Include versions of the plugins that won't pollute the window namespace and instead are exposed as ES Modules. Folks could use bundlers like webpack in order to import and use the plugins cleanly then.

rajgoel commented 3 years ago

@ryzokuken: Thanks for bringing this to my attention. Unfortunately, I do not have a clue about what you are talking (no experience with ES modules/bundlers so far). More details would be great or even a PR?

ryzokuken commented 3 years ago

I mean a major release of the package could export the different plugins as JavaScript modules instead of setting to the window object.

so instead of window.RevealChart = ..., you'd have export default RevealChart and folks can import them using import statements (import RevealChart from 'reveal.js-plugins/chart';).

rajgoel commented 3 years ago

Ok, I get the idea. Could you create a PR (at least for one of the plugins)? So that I can review a tested version to see whether there are any side-effects?

ryzokuken commented 3 years ago

@rajgoel sure, I'll try to do that ASAP.

rajgoel commented 3 years ago

perfect, thanks!

ryzokuken commented 3 years ago

Now that I think about it, given that each plugin has different "versions" and since they're not dependent on each other (are they?), why isn't each plugin a separate module?

rajgoel commented 3 years ago

They are all in the same repository for (personal) convenience reasons, so that I always have all my plugins in one place. The "versions" of the plugins are more or less arbitrary: Concering the release number of the repository, the first two digits are now aligned with the reveal.js-release, the last digit is a counter. This might not be the best choice, but it evolved this way and I would need a strong argument to change this.

ryzokuken commented 3 years ago

@rajgoel I understand completely, I was just intrigued.

I've been only starting to dive deep into reveal.js and its close ecosystem for a couple of days now and it feels really interesting! For better or for worse, JS devs write code very differently these days, and you might like to update the project to reflect that. You don't have to though, but maybe it'll be helpful. I will try to quickly make an opinionated PR for a single plugin so you could review and give your thoughts.

Regarding keeping things together, I certainly understand. You don't have to necessarily split the repo though, you can also keep multiple npm packages inside a single repo, but it will take away the ability of users to install the package directly from GitHub.

rajgoel commented 3 years ago

I am always open to learn about JS ecosystems, but at the same time have little time to invest in this side-project and focus mostly on functionality. Anything that eases my learning process is very welcome :-)

ryzokuken commented 3 years ago

@rajgoel totally understandable! Check out https://exploringjs.com/impatient-js/ch_modules.html.

RKelln commented 2 years ago

I'm new to JS modules too, but took a stab at a first pass for the audio-slideshow plugin which I'm attempting to use with revealjs-vite project. You can see some of the work here: https://github.com/RKelln/reveal.js-plugins/commit/1527c9d905a743b07cd3f9e680148f6d17040d6b