Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide package.json and JSONCrush in a cjs, es, umd module variants #12

Closed
darcyparker opened this issue Jan 8, 2021 · 6 comments
Closed

Comments

@darcyparker
Copy link

This has been asked in various ways in:

Having cjs, es, umd variants that people can choose from would be very helpful.

Perhaps the previous pull requests are doing too much or aren't the right approach for your taste? But there's still the challenge of getting started quickly with JSONCrush in various JS environments.

Maybe a more amicable approach would be to create a simple build script to wrap JSONCrush.js in these 3 module types? Before I put in the effort, would you consider such a pull request?

(Things like babel/typescript are nice... so some meta data in the package.json to help those tools would be nice. But in my opinion, its not critical to provide many builds JSONCrush in ES3/ES5 and minified flavors. That can be left to build tools the downstream users setup. But having a few of the standard module formats would be helpful for someone who wants to quickly import the module to evaluate it.)

@KilledByAPixel
Copy link
Owner

the next step that i am comfortable with is getting back control of the npm and adding modules and package.json, after that maybe more but i think i need to start there.,

@darcyparker darcyparker mentioned this issue Jan 8, 2021
@antialias
Copy link

the next step that i am comfortable with is getting back control of the npm

Did you ever have control of "the npm"? Looks like @dprothero cloned this repo and published your package for you because you never did.

and adding ... package.json

run npm init and you're done.

Since it's been over six months since this issue was opened, consider publishing from your own namespace in order to un-block this ticket.

@antialias
Copy link

The ask in this ticket can be accomplished with a rollup config and a prepublish script in your (currently nonexistent) package.json. It's a 10 minute job.

@darcyparker
Copy link
Author

#13 solves it... The pull request just needs to be reviewed / merged.

@KilledByAPixel
Copy link
Owner

Just pushed out a major update to JSONCrush that wraps it in a module, adds package.json, and is now updated on NPM!

https://www.npmjs.com/package/jsoncrush

@antialias
Copy link

Just pushed out a major update to JSONCrush that wraps it in a module, adds package.json, and is now updated on NPM!

well that's a start, but if there is any intention for this package to be maintained we really need the build script to be included in this repository and for it to automatically run whenever npm publish is run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants