use npm to download extension dependencies after installing from registry #10602

zaggino · 2015-02-15T02:29:20Z

Seems to be working fine. Tests included, but currently they are disabled in Gruntfile so they need to be run manually, wasn't investigating what was the reason for disabling the tests.

le717 · 2015-02-15T03:54:16Z

mackenza · 2015-03-17T08:21:09Z

Is this being considered for merging? I think it's a great addition speaking as some who has published a node-based extension with dependencies.

zaggino · 2015-03-17T09:10:15Z

@mackenza not sure if this will make its way into Brackets, but I've been playing with a concept of going around Brackets' extension registry altogether and download whole extensions from npm. It works conceptually, but needs more testing and polishing, see here: https://github.com/zaggino/brackets-npm-registry

mackenza · 2015-03-17T18:36:56Z

ah, I see. That would closely resemble what Atom does with APM wrapping
NPM, yes?

On Tue, Mar 17, 2015 at 5:10 AM, Martin Zagora notifications@github.com
wrote:

@mackenza https://github.com/mackenza not sure if this will make its
way into Brackets, but I've been playing with a concept of going around
Brackets' extension registry altogether and download whole extensions from
npm. It works conceptually, but needs more testing and polishing, see here:
https://github.com/zaggino/brackets-npm-registry

—
Reply to this email directly or view it on GitHub
#10602 (comment).

zaggino · 2015-03-17T22:21:53Z

To be honest, I've no idea what Atom does or doesn't do, never had time to take a closer look at it.

mackenza · 2015-03-17T23:57:54Z

Yeah, basically this is what they do. The have the Atom Package Manager
which seems to add some Atom-specific meta data fields to Package.json and
they use NPM as the actual dependency manager.

Atom is a hot mess, honestly. Truly an editor without an identity.

On Tue, Mar 17, 2015 at 6:22 PM, Martin Zagora notifications@github.com
wrote:

To be honest, I've no idea what Atom does or doesn't do, never had time to
take a closer look at it.

—
Reply to this email directly or view it on GitHub
#10602 (comment).

nethip · 2015-03-18T06:27:15Z

@zaggino Thanks for putting up this PR! Great work and thinking. I like the idea of keeping the node extensions lean and downloading the dependencies using npm.

Couple of things to consider for this PR.

What changes do we need to do for our Registry(like changing validation logic e.t.c)?
I have some concerns about versioning of the dependent npm modules. If an extension developer mentions the version of the dependent module to be something like >0.1.3, what happens if the latest version of that dependent module is buggy and is not compatible with that extension?
What can we do something similar which can help extension developers who do not use node modules?

Talking about the third point, how about downloading the extension itself from just a link? Something like, the registry will only have links (mostly to GitHub repositories) and we download the extension itself from Github repository/external link followed by installing the dependencies(which this PR is about), if any.

CC @ryanstewart @peterflynn

mackenza · 2015-03-18T15:13:54Z

@nethip I would think point 2 is a concern for any dependency manager and not unique to this PR's application of NPM. If a package author doesn't want to "roll the dice" on having package updates break their extension, they should be explicit about the dependency. i.e. 1.0.3 rather than >=1.0.3

On 3, NPM is quickly becoming the dependency manager to rule them all. Certainly it's not restricted to Node modules anymore. I can find most of the modules I use for front end JS in there, as well. I think what @zaggino is suggesting is we use the current package registry to download the actual extension zip (as we do today) but as part of the installation, rather than just unzipping the files, we also run npm install to pick up the dependencies. This sounds like the best of both worlds.

zaggino · 2016-08-16T04:26:01Z

@ficristo @petetnt @abose @ingorichter this would be worth a second look, it's no magic and it'd help a lot for extensions so they wouldn't have to bundle everything in a .zip file

petetnt · 2016-08-16T06:12:49Z

package.json

@@ -12,6 +12,9 @@
        "branch": "",
        "SHA": ""
    },
+    "dependencies": {
+        "npm": "2.15.10"


Have you tested this out with npm@3. I didn't have much issues (if any) from moving to 2->3 when 3 started rolling out but I don't know if it has some troubles with how Brackets resolves the extension dependencies.

No, I could test/fix this to work with 3 but original PR was put together when 2 was latest and I don't think it's worth spending time on it if it won't be merged before npm 4 comes out.

Fair enough. @3 would bring some nice benefits, but I do see how testing for it might be unfeasible at this point. I'd like to see this land sooner than the later though, preferably with 3 😼

The review I asked for is more about the idea of this then the code (I'm happy to fix/update it), when I first put up this PR there wasn't enough will to merge this and potentially deal with problems like invalid dependencies in package.json and etc. But I still believe this would help a lot of extension authors to move forward.

Oh, and npm@3 doesn't play well with node 0.10 so we need to merge two other PRs first.

Yeah, good catch on that one. I'd love to get rid of both of those ancient dependencies at the same time 👍

petetnt · 2016-08-16T06:18:00Z

Looks good to me with some minor nits about personal preferences.

ficristo · 2016-08-16T07:12:39Z

I like the idea but I defer the final decision to others, I'm not confident on how this will interact with the registry. A part the following few questions, LGTM.

I suppose we can start to using dependencies in the root package.json if things aren't extensions, right?
Can you use require instead of JSON.parse(fs.readFileSync...?
The API of npm are really supported? Looking around seems not. Can you use instead an exec command or similar and run npm install --production?
Your npm extension provide a reinstall button, don't we need it?
~~On VSCode by default they are exluding **/.git/object/** instead of .git/**, aren't your git extension affected?~~ (Probably I was thinking to #12647 while writing this...)

zaggino · 2016-08-25T15:39:38Z

@petetnt @ficristo updated the PR per your suggestions.
Tested by installing https://github.com/zaggino/brackets-coffeelint from an URL.

ficristo · 2016-08-25T18:26:16Z

src/extensibility/node/ExtensionManagerDomain.js

+            var packageJson;
+
+            try {
+                packageJson = JSON.parse(fs.readFileSync(path.join(installDirectory, "package.json"), {


Cannot you use require instead of JSON.parse(fs.readFileSync?

ficristo · 2016-08-25T18:34:46Z

I didn't expect to become complex like this, but I believe is better than using npm API. Thank you @zaggino.
From my side looks good.

refactor refactor 2

zaggino · 2017-02-14T01:21:31Z

rebased as requested by @swmitra
added proxy support requested by @ficristo
tested both with and without proxy by installing https://github.com/zaggino/brackets-coffeelint from an URL

note: original bundled request was failing with my proxy but upgrade to the latest version fixed that, so I've added this to my commit even though it was not directly related - request is now managed as npm dependency (it can be in root as it's node-only dependency) and old request committed to the repository was removed

ficristo · 2017-02-14T08:25:06Z

IMHO if we change extensibility/node in this way we should wait for #12933 first.
(Thank you for the update!)

zaggino · 2017-02-14T11:00:33Z

#12933 depends on the access to the registry machine and I don't know what else, so it might take a year or two to fix that...

zaggino · 2017-02-15T01:42:51Z

removed request update which @ficristo complained about, should be ready to merge

swmitra · 2017-02-15T03:46:13Z

Great work as always @zaggino 👍 .
I guess this PR is good to go now and if we merge now, it will give us some additional time for testing as well.

swmitra · 2017-02-15T03:46:29Z

Merging now ...

zaggino · 2017-02-15T04:27:26Z

btw, fun fact: this PR took exactly 2 years to merge

swmitra · 2017-02-15T05:07:51Z

I bet it's better late than never 👍
I hope we will never see a PR raised today getting merged on 15th Feb 2019 😃

zaggino · 2017-03-01T01:48:55Z

Tested this by publishing a copy of archive from npm into brackets registry (TypeScript 0.9.4) and it works great. Thanks a lot guys for getting this to the core.

zaggino changed the title ~~[WIP] use npm to download extension dependencies after installing from registry~~ use npm to download extension dependencies after installing from registry Feb 15, 2015

zaggino mentioned this pull request Mar 2, 2015

[extension-upload] - unable to upload a brackets extension to the registry #7387

Closed

zaggino mentioned this pull request Mar 26, 2015

broken on Windows brackets-userland/brackets-npm-registry#4

Closed

mackenza mentioned this pull request Mar 29, 2015

5MB limit for extensions might be too small #6060

Closed

zaggino mentioned this pull request Apr 13, 2015

Brackets 1.2 deprecation warnings peol/brackets-eslint#13

Closed

zaggino mentioned this pull request Jan 17, 2016

Does not install using standard tools brackets-userland/brackets-eslint#25

Closed

zaggino force-pushed the zaggino/npm-support branch 2 times, most recently from b1ebb31 to 16f4bc8 Compare August 16, 2016 04:24

petetnt reviewed Aug 16, 2016
View reviewed changes

zaggino force-pushed the zaggino/npm-support branch from 16f4bc8 to fdd83da Compare August 25, 2016 15:04

ficristo reviewed Aug 25, 2016
View reviewed changes

zaggino added 9 commits February 14, 2017 10:56

exec npm instead of using internal API

b5dbec4

refactor refactor 2

update npm

14c771d

initialize exitCode

991a163

move fail and finish blocks out

47aace9

do not use ternary ifs

b0e43be

little fix

e7b3c2b

update npm-shrinkwrap

1c3fa56

move npm installation to the package extraction step

74bec9e

consistent function style

3f1ed5d

zaggino force-pushed the zaggino/npm-support branch from 93a5604 to 3f1ed5d Compare February 13, 2017 23:56

add proxy support

66eb334

zaggino force-pushed the zaggino/npm-support branch from d939b00 to 66eb334 Compare February 15, 2017 01:35

zaggino added 2 commits February 15, 2017 12:40

Merge remote-tracking branch 'origin/master' into zaggino/npm-support

c25e2ac

npm-shrinkwrap.json

c96e559

swmitra merged commit 74c5306 into master Feb 15, 2017

zaggino deleted the zaggino/npm-support branch February 15, 2017 03:55

zaggino mentioned this pull request Mar 7, 2017

lots of npm deprecated warnings brackets-userland/brackets-npm-registry#46

Closed

zaggino mentioned this pull request Mar 16, 2017

why my brackets complains about it need new version? brackets-userland/brackets-eslint#56

Closed

zaggino mentioned this pull request Sep 9, 2017

Typos in README Configuration defaults brackets-userland/brackets-eslint#67

Closed

This was referenced Aug 30, 2021

[CLOSED] 5MB limit for extensions might be too small brackets-archive/bracketsIssues#5535

Open

[CLOSED] use npm to download extension dependencies after installing from registry brackets-archive/bracketsIssues#9350

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

use npm to download extension dependencies after installing from registry #10602

use npm to download extension dependencies after installing from registry #10602

zaggino commented Feb 15, 2015

le717 commented Feb 15, 2015

mackenza commented Mar 17, 2015

zaggino commented Mar 17, 2015

mackenza commented Mar 17, 2015

zaggino commented Mar 17, 2015

mackenza commented Mar 17, 2015

nethip commented Mar 18, 2015

mackenza commented Mar 18, 2015

zaggino commented Aug 16, 2016

petetnt Aug 16, 2016

zaggino Aug 16, 2016

petetnt Aug 16, 2016

zaggino Aug 16, 2016

zaggino Aug 16, 2016

petetnt Aug 16, 2016

petetnt commented Aug 16, 2016

ficristo commented Aug 16, 2016 •

edited

Loading

zaggino commented Aug 25, 2016

ficristo Aug 25, 2016

ficristo commented Aug 25, 2016

zaggino commented Feb 14, 2017

ficristo commented Feb 14, 2017 •

edited

Loading

zaggino commented Feb 14, 2017

zaggino commented Feb 15, 2017

swmitra commented Feb 15, 2017

swmitra commented Feb 15, 2017

zaggino commented Feb 15, 2017

swmitra commented Feb 15, 2017

zaggino commented Mar 1, 2017

use npm to download extension dependencies after installing from registry #10602

use npm to download extension dependencies after installing from registry #10602

Conversation

zaggino commented Feb 15, 2015

le717 commented Feb 15, 2015

mackenza commented Mar 17, 2015

zaggino commented Mar 17, 2015

mackenza commented Mar 17, 2015

zaggino commented Mar 17, 2015

mackenza commented Mar 17, 2015

nethip commented Mar 18, 2015

mackenza commented Mar 18, 2015

zaggino commented Aug 16, 2016

petetnt Aug 16, 2016

Choose a reason for hiding this comment

zaggino Aug 16, 2016

Choose a reason for hiding this comment

petetnt Aug 16, 2016

Choose a reason for hiding this comment

zaggino Aug 16, 2016

Choose a reason for hiding this comment

zaggino Aug 16, 2016

Choose a reason for hiding this comment

petetnt Aug 16, 2016

Choose a reason for hiding this comment

petetnt commented Aug 16, 2016

ficristo commented Aug 16, 2016 • edited Loading

zaggino commented Aug 25, 2016

ficristo Aug 25, 2016

Choose a reason for hiding this comment

ficristo commented Aug 25, 2016

zaggino commented Feb 14, 2017

ficristo commented Feb 14, 2017 • edited Loading

zaggino commented Feb 14, 2017

zaggino commented Feb 15, 2017

swmitra commented Feb 15, 2017

swmitra commented Feb 15, 2017

zaggino commented Feb 15, 2017

swmitra commented Feb 15, 2017

zaggino commented Mar 1, 2017

ficristo commented Aug 16, 2016 •

edited

Loading

ficristo commented Feb 14, 2017 •

edited

Loading