Kekule.js icon indicating copy to clipboard operation
Kekule.js copied to clipboard

publish the build system

Open mytskine opened this issue 6 years ago • 5 comments

Unless I'm mistaken, there is no canonical way to update the dist/ directory from the sources files. This makes contributing to the project hard. I believe the build system that updates files under dist/ should be part of the repository, along with instructions in the README or documentation.

If the present build system can't be published, I'd gladly help with configuring Webpack for Kekule.js. I had a quick glance at it on a fork, but lacked the information to go further.

mytskine avatar Dec 18 '18 15:12 mytskine

We have a webpack version of the master branch that we use in our fork, although we have some tight couplings to our own project in the branch we used the most. But I believe this branch is unsullied by any of our couplings and includes webpack.

@AaronLlanos can you confirm?

https://github.com/AaronLlanos/Kekule.js/compare/master...kekule-master

MrDarkHorse avatar Dec 18 '18 15:12 MrDarkHorse

This one is a little behind, and needs to be updated with the latest code from master

MrDarkHorse avatar Dec 18 '18 15:12 MrDarkHorse

From a quick glance, your webpack branch only builds kekule.min.js. Aren't there many other files in dist/ that should be updated too?

mytskine avatar Dec 18 '18 15:12 mytskine

@mytskine I built this out and can explain.

Webpack, while we can output a similar tree how @partridgejiang does, we don't because we use all of the functionality in Kekule, excluding 3D rendering. As a result, all of the files in kekule/src are compiled into our kekule.min.js file. As stated above, we don't include all of the 3D work in our webpack build but we believe all of the 2D rendering functionality is there. If you think you can improve our repo, please feel free to submit a pull request against kekule-master in my repo.

Please view this comment for further explanation of how I have conventionalized my branches on my fork.

Thanks!

AaronLlanos avatar Dec 18 '18 16:12 AaronLlanos

We used to use a quite "old" toolchain to compress js files and publish them into the dist directory. The toolchain includes the js compression tools and some auto-generated batch files. Such a system has been used from the beginning of the development of Kekule.js several years before and worked well since then. Nowadays it is really outdated. So I have written a simple node.js tool in recent days to minify and publish js files of Kekule.js. With this command line tool, you may build your own package with only the essential modules. Please refer to https://github.com/partridgejiang/Kekule.js/tree/master/utils/jsMinifier.

partridgejiang avatar Dec 24 '18 12:12 partridgejiang