Fixing git style subcommands on Windows & allowing subcommands to come from dependency modules #604

mateodelnorte · 2017-01-16T19:58:57Z

This PR fixes git style subcommands to work correctly on Windows, and adds logic such that git style subcommands can be inherited from child dependencies, allowing you to break large sets of commands into a multi-repo project. (It should also allow for dynamically varying available subcommands according to what is currently installed under ./node_modules)

I built a command for managing multi-repo projects, which dogfoods this patch to manage its own repos as well: https://github.com/mateodelnorte/meta/blob/master/package.json#L38-L39. meta, itself, has only one command – meta, which loads all child commands by searching through it's node_modules for matching meta-* modules and registering them via their index.js.

This all works fine with the current commander.js, but when attempting to call them commander can't locate them. This patch ensures that commander can find the git subcommands and execute them.

meta --help

  Usage: meta [options] [command]


  Commands:

    git         manage your meta repo and child git repositories 
    npm         run npm commands against your meta and child repositories 
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

The git subcommand, above, is provided by https://github.com/mateodelnorte/meta-git.
The npm subcommand, above, is provided by https://github.com/mateodelnorte/meta-npm

…ncies. enables plugin infrastructure where subcommands can be separated into different modules and repos

mateodelnorte · 2017-01-25T22:47:21Z

Do we actually care that this breaks old (v<=0.0.10) versions of node?

mateodelnorte · 2017-02-15T18:33:41Z

PING PING

Are Node 0.8 and 0.6 support really required in commander.js? The only thing keeping this PR from passing all tests are engine restrictions in some dependencies.

Thanks.

mateodelnorte · 2017-05-12T19:24:21Z

Hi. Howdy. Hello there. This is a pretty popular package. Lots of PR's. Some are months old. Do people respond to them?

abetomo · 2017-07-11T07:44:26Z

@mateodelnorte Would you please resolve the conflict?

mateodelnorte · 2017-07-11T15:37:01Z

Conflicts resolved.

abetomo · 2017-07-12T01:01:31Z

index.js

+      // add executable arguments to spawn
+      args = (process.execArgv || []).concat(args);
+
+      proc = spawn('node', args, { stdio: 'inherit'});


As for 'node', can you do it like https: //github.com/tj/commander.js/blob/master/index.js#L544?

Should be good to go! Take a peek.

abetomo · 2017-07-12T01:02:18Z

Thank you!

mateodelnorte · 2017-07-14T01:38:47Z

Glad to help!

*not sure what's up with npm 5 not installing the single find-module-bin dependency. yarn installs it just fine.

mateodelnorte · 2017-07-24T20:54:15Z

Any timeline on when this will be published to npm? I think a simple rebuild will fix the build errors on node 8. Seemed to be a temporary problem with the registry. The dependency version def exists:

{ name: 'find-module-bin',
  description: 'scan known node_modules directories to find installation directory of a particular bin file',
  'dist-tags': { latest: '0.0.2' },
  versions: [ '0.0.0', '0.0.1', '0.0.2' ],

mateodelnorte · 2017-11-21T16:15:00Z

When is this going to be merged? The error happening in this build was a bug in npm5.

mateodelnorte · 2017-11-21T16:21:31Z

I've fixed the merge issue that happened in package.json as a result of this not being merged since January. Looks like a re-run of the builds works completely (because it was a bug in npm5).

Can we get this merged?

Thx

mateodelnorte · 2018-03-28T18:43:22Z

@abetomo Can we please slate this for merge? It's been well over a year.

abetomo · 2018-03-29T01:40:36Z

@mateodelnorte
It was awaiting @vanesyan's approval.

@vanesyan
Could you please review it?

mateodelnorte · 2018-04-24T22:02:40Z

So... I updated this from upstream again. @abetomo @vanesyan

Can we get this merged?

Fix issues tj#37 - Running any subcommand throws SyntaxError on Windows

mateodelnorte · 2018-04-30T17:05:42Z

ping ping

roman-vanesyan · 2018-05-01T14:11:35Z

index.js

@@ -544,26 +545,23 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
  if (exists(localBin + '.js')) {
    bin = localBin + '.js';
    isExplicitJS = true;
-  } else if (exists(localBin)) {
+  } else if (process.platform === 'win32' ? exists(localBin + '.cmd') : exists(localBin)) {


Can you please put it to own variable, for readability purpose

Sure thing.

roman-vanesyan · 2018-05-01T14:12:38Z

index.js

@@ -5,6 +5,7 @@
 var EventEmitter = require('events').EventEmitter;
 var spawn = require('child_process').spawn;
 var path = require('path');
+var findModuleBin = require('find-module-bin');


Can you please inline the module, we trying to keep commander.js dependencies-free

As a curiosity – What's the reason for wanting no dependencies?

find-module-bin uses global-modules, to look up the appropriate os-dependent location of globally installed node modules. this won't be a simple pull-function-up refactor, as the os-specific logic is hidden in here.

perhaps we can merge this and set the refactoring as tech-debt?

personally, I think the reuse is better for the community. you don't want a massive explosion of dependencies, but having well managed dependencies can make your code more DRY and keeps the potential for the dependent packages to continue to evolve and solidify.

@vanesyan I don't think it makes sense to inline all of this.

This PR has been ready for merge for about a year and six months.

Hi @vanesyan @abetomo
My team is also interested in this fix.

Is there any reason why this can not be included with the dependency?

roman-vanesyan · 2018-05-01T14:15:21Z

Hello there! Sorry for make you waiting. Can you, please, resolve the comments in the review, thanks!

mateodelnorte · 2018-12-24T14:17:25Z

Git style subcommands are still broken on Windows in master. This PR fixes them.

Is there any plan to merge? Is the fact this is not merged because it's more important to have zero dependencies than to fix a glaring bug?

shadowspawn · 2019-04-11T07:25:19Z

@codyaverett What aspect of this Pull Request is your team interested in?

shadowspawn · 2019-04-11T08:04:46Z

@mateodelnorte Sorry this has been open for so long, but unfortunately I think I see why. There are some good and interesting ideas here (thanks!), but multiple potential problems from the point of view of a cautious maintainer. To be clear, I am not willing to recommend this Pull Request be accepted in its current form based on my current understanding.

Some initial comments and questions, but I warn you and apologise in advance there will be more! If you don't want to invest in engaging with a new maintainer that is ok, you proposed this a long time ago. I see ideas in here I want to consider further whether or not you abandon this Pull Request.

Side notes:

I suggest you don't put effort into resolving the conflicts yet unless you want to.
I would like to add a CONTRIBUTING guide, and some of this discussion might end up there.

This is more a comment than a question or call for action. If you are addressing an issue or adding an enhancement that other people are asking for, it helps to link to the related issues. Otherwise the maintainers are judging the merit of the Pull Request just on your comments and what we recall of the issues we have seen in the past.

Are you doing one thing in this Pull Request or two? Do you consider the Windows "fix" to be separate, or is it an additional lookup method for binaries like the node_modules search?
In what way are Git style subcommands still broken on Windows? Are you referring to *.cmd or a wider issue? (I saw bat mentioned in a commit comment.)

shadowspawn · 2019-04-11T10:11:57Z

Is there any reason why this can not be included with the dependency?

This is going to come up again with Pull Requests. My favourite two challenging images:

Commander currently has zero dependencies. That isn't a requirement, but is a simple story. It does mean every suggested dependency will be critically evaluated.

And some insight into what this dependency pulls in:

mateodelnorte · 2019-04-11T12:55:32Z

This PR was made LONG before Commander had zero dependencies.

Yes, this PR 1) fixed git style subcommands on Windows and 2) introduced the ability for dependencies to supply git style subcommands. However, this was all done two years before the CONTRIBUTING guide you're proposing and I put in the effort to make PR merge-able multiple times.

All well and good if you don't want to merge, but this entire process has been extremely disheartening.

mateodelnorte · 2019-04-11T12:57:43Z

Frankly, I don't care if this code gets merged. But I would love to see the two issues be fixed.

codyaverett · 2019-04-12T03:41:15Z

@shadowspawn Thank you for your time and detailed response.

My motive is directly correlated with this other old issue. mateodelnorte/meta#46

I believe I can work around it, but I wasn't successful in my first attempts. I am still hopeful though. 😅

I will report future related issues in the meta project directly. Thanks!

shadowspawn · 2019-04-14T23:18:36Z

Thanks for info @mateodelnorte and @codyaverett

Sorry you had a rough time with this one @mateodelnorte.

I'm closing this Pull Request as problematic, but have noted it in #944 for future reference.

(I think the next direction we want to explore with git-style commands is more control over how the commands are found. Source file naming and directory layout is one form of that, but search paths where the commands are looked for is another as in this Pull Request. i.e. installed node_modules, search path for commands like npm uses, etc.)

Matt Walters added 3 commits December 15, 2016 12:09

adding ability to specify git style submodules inherited from depende…

7be74e2

…ncies. enables plugin infrastructure where subcommands can be separated into different modules and repos

adding find-module-bin dependency

dc70f71

bumping find-module-bin

3109d57

Matt Walters added 2 commits February 7, 2017 14:57

fixing git subcommands on windows

42a9d8e

bumping find-module-bin for es5 compat

fc6c364

mateodelnorte changed the title ~~Allow git style subcommands to come from dependencies~~ Fixing git style subcommands on Windows & allowing subcommands to come from dependency modules Feb 7, 2017

abetomo requested review from abetomo and roman-vanesyan July 11, 2017 07:44

Merge branch 'master' into master

7368f37

abetomo requested changes Jul 12, 2017

View reviewed changes

using current convention for spawn

3f5e2a9

abetomo approved these changes Jul 14, 2017

View reviewed changes

Merge branch 'master' into master

9a628f0

mateodelnorte mentioned this pull request Nov 21, 2017

"commander": "mateodelnorte/commander.js" issue mateodelnorte/meta#26

Closed

Merge branch 'master' into master

ee4c7bf

Matt Walters added 2 commits April 24, 2018 15:12

updating with upstream changes, again

09ee7b2

fixing lint errors. adding lint:fix target

245bc4c

jsuhard and others added 5 commits April 30, 2018 11:27

In Windows, "bat" scripts don't need interpreter

7e22105

Merge code for win32 and others platforms which is the same now

ca9d8c6

Style

3cb9f00

Merge pull request #1 from jsuhard/master

73a0e7f

Fix issues tj#37 - Running any subcommand throws SyntaxError on Windows

fixing tab->spaces to pass eslint

57b5e93

mateodelnorte mentioned this pull request Apr 30, 2018

Fix issues #37 - Running any subcommand throws SyntaxError on Windows mateodelnorte/commander.js#1

Merged

roman-vanesyan requested changes May 1, 2018

View reviewed changes

refactoring win32 platform test to variable for readability

fc217f4

jsuhard mentioned this pull request May 2, 2018

Running any subcommand throws SyntaxError on Windows mateodelnorte/meta#37

Closed

ruslantalpa mentioned this pull request Sep 27, 2018

init script not working on windows subzerocloud/subzero-cli#32

Closed

mateodelnorte mentioned this pull request Oct 2, 2018

meta/commander.js is not downloadable mateodelnorte/meta#46

Closed

mateodelnorte mentioned this pull request Dec 11, 2018

consider using another argv parser mateodelnorte/meta#77

Closed

abetomo requested a review from shadowspawn April 10, 2019 22:31

shadowspawn added the needs discussion label Apr 11, 2019

shadowspawn mentioned this pull request Apr 11, 2019

Triage: Git-style subcommands #944

Closed

shadowspawn closed this Apr 14, 2019

mateodelnorte mentioned this pull request Sep 20, 2022

commander is outdated mateodelnorte/meta#299

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixing git style subcommands on Windows & allowing subcommands to come from dependency modules #604

Fixing git style subcommands on Windows & allowing subcommands to come from dependency modules #604

mateodelnorte commented Jan 16, 2017 •

edited

mateodelnorte commented Jan 25, 2017 •

edited

mateodelnorte commented Feb 15, 2017

mateodelnorte commented May 12, 2017

abetomo commented Jul 11, 2017

mateodelnorte commented Jul 11, 2017

abetomo Jul 12, 2017

mateodelnorte Jul 13, 2017

abetomo commented Jul 12, 2017

mateodelnorte commented Jul 14, 2017 •

edited

mateodelnorte commented Jul 24, 2017

mateodelnorte commented Nov 21, 2017

mateodelnorte commented Nov 21, 2017

mateodelnorte commented Mar 28, 2018

abetomo commented Mar 29, 2018

mateodelnorte commented Apr 24, 2018

mateodelnorte commented Apr 30, 2018

roman-vanesyan May 1, 2018

mateodelnorte May 1, 2018

roman-vanesyan May 1, 2018

mateodelnorte May 1, 2018

mateodelnorte May 1, 2018

mateodelnorte May 4, 2018

mateodelnorte Oct 2, 2018

codyaverett Apr 10, 2019

roman-vanesyan commented May 1, 2018

mateodelnorte commented Dec 24, 2018

shadowspawn commented Apr 11, 2019

shadowspawn commented Apr 11, 2019 •

edited

shadowspawn commented Apr 11, 2019

mateodelnorte commented Apr 11, 2019

mateodelnorte commented Apr 11, 2019 •

edited

codyaverett commented Apr 12, 2019

shadowspawn commented Apr 14, 2019

Fixing git style subcommands on Windows & allowing subcommands to come from dependency modules #604

Fixing git style subcommands on Windows & allowing subcommands to come from dependency modules #604

Conversation

mateodelnorte commented Jan 16, 2017 • edited

mateodelnorte commented Jan 25, 2017 • edited

mateodelnorte commented Feb 15, 2017

mateodelnorte commented May 12, 2017

abetomo commented Jul 11, 2017

mateodelnorte commented Jul 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abetomo commented Jul 12, 2017

mateodelnorte commented Jul 14, 2017 • edited

mateodelnorte commented Jul 24, 2017

mateodelnorte commented Nov 21, 2017

mateodelnorte commented Nov 21, 2017

mateodelnorte commented Mar 28, 2018

abetomo commented Mar 29, 2018

mateodelnorte commented Apr 24, 2018

mateodelnorte commented Apr 30, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

roman-vanesyan commented May 1, 2018

mateodelnorte commented Dec 24, 2018

shadowspawn commented Apr 11, 2019

shadowspawn commented Apr 11, 2019 • edited

shadowspawn commented Apr 11, 2019

mateodelnorte commented Apr 11, 2019

mateodelnorte commented Apr 11, 2019 • edited

codyaverett commented Apr 12, 2019

shadowspawn commented Apr 14, 2019

mateodelnorte commented Jan 16, 2017 •

edited

mateodelnorte commented Jan 25, 2017 •

edited

mateodelnorte commented Jul 14, 2017 •

edited

shadowspawn commented Apr 11, 2019 •

edited

mateodelnorte commented Apr 11, 2019 •

edited