Publishing Basil.js to npm and Github Package Registry

basiljs / basil.js

An attempt to port the spirit of the Processing visualization language to Adobe Indesign.

http://basiljs.ch/

Other

245 stars 30 forks source link

Publishing Basil.js to npm and Github Package Registry #360

Open ff6347 opened 4 years ago

ff6347 commented 4 years ago

Dear @basiljs/owners I would love to publish basil.js to npm/gh registry under a scoped package @basiljs/basil.js

Pros:

install via npm will not pull all devDependencies (takes quite long)

Any objections?

trych commented 4 years ago

What exactly is the purpose of this? Could you explain what the npm/gh registry is and what it is used for? (I know what npm is, but what is the /gh part about?)

ff6347 commented 4 years ago

but what is the /gh part about?

github has its own package registry now. I think it is a good idea to publish to both. So we can provide alternative installation sources.

Publishing should be done by running a github action on release.

I was playing today with building a yo generator for basil and noted that a npm install basiljs/basil.js#develop -D installs all the development stuff. What we actually need is the basil.js file that's it. With a proper .npmignore we can manage that and don't create clutter.

Also we can run npm install @basiljs/basil.js@2.0.0-beta which is better then just installing the develop branch.

trych commented 4 years ago

Sorry, I still don't understand what I can do with it? Is it an alternative to using git clone or downloading the zip here?

What's a yo generator?

I think for the actual end users we should just provide a download link for the basil.js file on the finished basil site.

ff6347 commented 4 years ago

Is it an alternative to using git clone or downloading the zip here?

It is easier for the build process of the site to install specific versions
We can define postinstall scripts
We can remove all the development stuff from the installed package
We can define prepublish process that does the bundling.

I think for the actual end users we should just provide a download link for the basil.js file on the finished basil site.

It is aimed at pro users who want to do keep track of their used software with proper versioning. We still can provide a link to the latest version from the site but what if someone wants a different version then the latest?

What's a yo generator?

A command line tool that scaffolds projects see --> not important for basil. It's my own thing.

trych commented 4 years ago

It is aimed at pro users who want to do keep track of their used software with proper versioning.

Ok, I still don't understand it 100%, but as long as I can keep my current workflows and this is just an alternative with different options, sure, no objections from my side.

ff6347 commented 4 years ago

Great. The only thing that might change is that we tag a new version more often. :)