feat!: template pulling with npm config

[pierrick-boule]

Description
Use npm config values in arborist in order to inherit form the global config when pulling a template.
This allow to pass config like private registry and proxy-auth.

Related issue(s)
#538

BREAKING CHANGE

This PR drops support for Node versions prior v18.12.0
We know this version of Generator will not work work with Node v12. We also discourage using Node v14 and v16 that are no longer under long time support from Node community. From now on, generator tests run under Node v18 and v20

[github-actions]

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[pierrick-boule]

Hello,
The indent was not to make a dupplicate of #1061 , I was scripting the generator at work this week and been trying to work around the limits of the generator (our ci has no direct acces to the web and to ways : private repository, http proxy with auth). Both are ok with npm because we can config it but not with the generator.
Maybe this PR can help to find a convenient way of using the generator as easily that npm by reusing the same source of configuration.

[derberg]

@pierrick-boule sorry for keeping you waiting with review, but we were all focused on v3 release

Thanks a lot for that PR. I also do not think PR somehow contradicts the other one about private registry. Tbh the more flexible we are with generator the better for people, especially in ci/cd setups.

My proposal is that first we go first with the other PR and then adjust this one to match it, cause we will have to somehow condition which auth should be used: the one passed as options directly to library, or by reusing the existing conf

If you have a private registry you could test against the other PR, that would help out a lot

[aeworxet]

@asyncapi/bounty_team

[derberg]

@pierrick-boule as I wrote before. This #1061 is already merged, so please update your PR with latest private npm support

[pierrick-boule]

Hello @derberg, i updated this PR, was able to test localy :
I put "127.0.0.1 registry.npmjs.org" in /etc/hosts to make it unavailable (to remove later)
set a private registry :
npm config set registry https://private.registry.org/
Run few test OK
used a docker proxy https://hub.docker.com/r/thelebster/docker-squid-simple-proxy/
npm config set proxy http://username:password@localhost:3128
Run few test OK

[pierrick-boule]

Hello, i fixed the code style.
The backwards compatibility with nodeJS 12 is not that easy to get, i will need more time to check the old npm code :-( .

[derberg]

@pierrick-boule there is no strong requirement to be compatible with node 12

we can definitely make this PR trigger major release because of stop of support for node12 - that is completely fine, this is a very old node version:

• just update docs
• package.json requirements
• workflow: https://github.com/asyncapi/generator/blob/master/.github/workflows/pr-testing-with-test-project.yml

I'm more concerned about your custom unix-based solution with replacing paths. I'm pretty sure it will not work with windows. How about using something like https://www.npmjs.com/package/npm-run-path ?

Also, we should find a way how to test it 🤔 should not be hard as tests are already in place https://github.com/asyncapi/generator/blob/master/test/test-project/test-registry.test.js where we simulate npm environment

[pierrick-boule]

Hello,
Yes, I tried few implementation of npm config of npm 12 and it's very different of this PR, it will be verbose to implement a retrocompatible version and not very clear/maintainable, i was also thinking about depreciating it, and maybe introduce the new LTS of node (20) if possible.

I will now focus on this way (taking your proposals).

[derberg]

@pierrick-boule we should support what Node community supports, so minimum is Node 18 that is in maintenance until April next year -> https://nodejs.org/en/about/previous-releases

since we agreed we will run a major release with this PR:

• please update title to feat!
• lets refresh node support so make sure package.json and docs talk about Node 18 as minimum
• make sure testing is also done Node 18 and 20
• make sure package-lock is using lockfileVersion set to 3

[derberg]

@pierrick-boule whenever you're ready for another review round please rerequest review as I do not get notifications that you pushed all required changes.

also please solve conflicts with package-lock.json

[pierrick-boule]

Hello, @derberg it should be ok now.

[derberg]

looking awesome with this new additional integration test - and CI is passing.

you just need to update https://github.com/asyncapi/generator/blob/master/docs/using-private-template.md

there is also issue with unit tests: https://github.com/asyncapi/generator/actions/runs/8701813512/job/23883476282?pr=1069

I think it is because @npm/config is not mocked.

add below file, config.js

with content like

const npmConfig = jest.genMockFromModule('@npmcli/config');

module.exports = npmConfig;

[derberg]

@Florence-Njeri please have a look at docs updates. With this PR we're releasing a new major as we will drop support for older node versions

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[derberg]

@pierrick-boule we are ready to go. I added a note about breaking change to the description. Thanks for all the hard work

[derberg]

/rtm

[asyncapi-bot]

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[derberg]

@all-contributors please add @pierrick-boule for code,test,doc

[allcontributors]

@derberg

I've put up a pull request to add @pierrick-boule! 🎉