Using Gridsome source code in production instead of NPM

[mklueh]

Hello, I´m looking for a way to build Gridsome from the source code into an "artifact", that I can use in my application. (To clearify, yes I'm aware that js is not compiled but rather packaged :) )

The reason for this is I need a certain feature that is not contained in the latest Gridsome version, as discussed here: #1497.

For example in Java, I would simply build a .jar file out of the library that I then can embed into my application.

I would appreciate any tips on how to do that, without deploying my own npm package to npmjs.org.

[noxify]

You could use yarn link or npm link to reference to your local gridsome sources.

[mklueh]

You could use yarn link or npm link to reference to your local gridsome sources.

I do that locally, but I need to deploy my site somehow via CI (Netlify)

[a-kriya]

@mklueh It doesn't look like Gridsome can be bundled up into an artifact. If you'd like to modify parts of it, I think you can run a script on postinstall of your project that would monkey-patch what you need to under node_modules/gridsome/.

[mklueh]

@mklueh It doesn't look like Gridsome can be bundled up into an artifact. If you'd like to modify parts of it, I think you can run a script on postinstall of your project that would monkey-patch what you need to under node_modules/gridsome/.

Thanks for that great idea, I think I'll try that.

Maybe it's also an option to git clone gridsome from my fork into the node_modules directory in a postinstall script if there are many changes. Otherwise it could get messy patching every single file

[a-kriya]

@mklueh Oh, if you have a public repository, then you can just use that as a dependency npm i --save mklueh/gridsome. This doesn't require publishing to NPM, and will automatically fallback to GitHub. To be explicit, it should be equivalent to npm i --save https://github.com/mklueh/gridsome.

[mklueh]

@a-kriya oh wow thanks, that's amazing. Didn't know this was possible, but it definitely solves my problem :)

[a-kriya]

@mklueh Sweet. I suppose once you've tested it out, this ticket can be marked closed.

[mklueh]

It´s not working and I guess the reason is the actual gridsome package required for installation is not in the root package.

This is what I get:

$ yarn add https://github.com/mklueh/gridsome
yarn add v1.22.4
warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To cle
ar this warning, remove package-lock.json.
[1/4] Resolving packages...
error Can't add undefined: invalid package version undefined.
info Visit https://yarnpkg.com/en/docs/cli/add for documentation about this command.

Something like yarn add https://github.com/mklueh/gridsome/tree/master/gridsome won´t work either

Edit:

I´ve upgraded to yarn berry (yarn 2..), which should support Github subdirectories, but I´m running into this now:

$ yarn add https://github.com/mklueh/gridsome/tree/master/gridsome
Internal Error: Invalid descriptor (https://github.com/mklueh/gridsome/tree/master/gridsome)

trying to install it with npm leads to this error:

npm ERR! code ENOPACKAGEJSON
npm ERR! package.json Non-registry package missing package.json: https://github.com/mklueh/gridsome/tree/master/gridsome.
npm ERR! package.json npm can't find a package.json file in your current directory.

although the package.json is present in the directory

https://stackoverflow.com/questions/67748990/invalid-descriptor-with-yarn-berry-github-subdirectory-install

[a-kriya]

@mklueh npm install 'https://gitpkg.now.sh/mklueh/gridsome/gridsome?master'

https://gitpkg.vercel.app/
https://gitpkg.vercel.app/guide/#advanced-how-this-function-is-implemented

I found it mentioned at https://stackoverflow.com/a/62275259

[a-kriya]

@mklueh Did the above resolve the issue with install?

[djmtype]

@a-kriya

It worked for me locally. However, I didn't test the build on Netlify. Thanks!