Rework profile.js to use shellInitScriptChooser() by edsfocci · Pull Request #51 · wbyoung/avn

edsfocci · 2017-01-12T06:47:25Z

Rework 'avn setup' to use .bashrc or .bash_profile according to the algorithm @wbyoung talked about in #50

coveralls · 2017-01-12T07:15:32Z

Coverage decreased (-11.4%) to 88.593% when pulling a4df2f8 on edsfocci:add-bashrc-to-setup-attempt-2 into 24e1b1d on wbyoung:master.

wbyoung

A few first thoughts have been left here. In addition to addressing this feedback, the following needs to be done before this is merged:

Bring back support for .zshrc as well… we probably want to setup both bash as well as zsh.
Address the checklist here
Get all tests passing & write new tests to ensure code coverage is up to the current standard

wbyoung · 2017-01-15T01:02:18Z

lib/setup/profile.js

+    fs.access(bashrcFile, function(err) {
+      bashrcExists = !err;
+      resolve();
+    });


Since we have mz, you should be able to just do:

var bashrcPromise = fs.access(bashrcFile).then(function() { bashrcExists = true; });

wbyoung · 2017-01-15T01:02:26Z

lib/setup/profile.js

+    fs.access(bashProfileFile, function(err) {
+      bashProfileExists = !err;
+      resolve();
+    });


Same as above comment.

wbyoung · 2017-01-15T01:03:32Z

lib/setup/profile.js

+             (bashProfileExists && bashProfileFile);
+    }
+
+    if (bashrcExists && bashProfileExists) {


Again, no need for innerPromise via mz.

wbyoung · 2017-01-15T01:03:41Z

lib/setup/profile.js

+        if (appendFile) {
+          return appendFile;
+        }
+


wbyoung · 2017-01-15T01:08:55Z

lib/setup/profile.js

+          linux:  bashrcFile,
+          darwin: bashProfileFile,
+        };
+


There should probably be a fallback here in case the platform is not in this list.

…ofile

coveralls · 2017-01-18T01:46:44Z

Coverage decreased (-9.2%) to 90.775% when pulling 3a12d2b on edsfocci:add-bashrc-to-setup-attempt-2 into 24e1b1d on wbyoung:master.

coveralls · 2017-01-23T22:41:55Z

Coverage decreased (-8.0%) to 92.015% when pulling 569aa22 on edsfocci:add-bashrc-to-setup-attempt-2 into 24e1b1d on wbyoung:master.

coveralls · 2017-01-23T22:47:56Z

Coverage decreased (-8.0%) to 92.015% when pulling 6441064 on edsfocci:add-bashrc-to-setup-attempt-2 into 24e1b1d on wbyoung:master.

coveralls · 2017-01-23T23:15:49Z

Coverage decreased (-8.0%) to 92.015% when pulling 5bca4a7 on edsfocci:add-bashrc-to-setup-attempt-2 into 24e1b1d on wbyoung:master.

edsfocci · 2017-01-23T23:29:56Z

I made the changes you suggested, and the code currently passes in Travis. I'll work on adding the tests later.

wbyoung · 2017-01-24T20:00:39Z

lib/setup/profile.js

+  .then(function(initScript) {
+    appendFile = initScript;
+
+    if (appendFile === bashProfileFileName) {


What's the purpose of this if/else here?

Why can't it just update both .bash_profile and .zshrc or .bashrc and .zshrc? I know it's uncommon, but some people will use multiple shells, so if they have both config files, why not support them both?

wbyoung · 2017-01-24T20:00:47Z

@edsfocci I just stumbled across this resolution of init scripts by yarn. It seems as though they'd probably have worked out most platform idiosyncrasies and it does seem quite simple.

wbyoung · 2017-01-24T20:01:26Z

lib/setup/profile.js


+var bashProfileFileName = '.bash_profile';
+var bashrcFileName = '.bashrc';
+


Given the comment about removing the branching condition, I think these globals can go away.

wbyoung · 2017-01-24T20:02:41Z

lib/setup/profile.js

    }
  });
+
+  return promise;


This should not change — the returned promise resolution would occur before the final log message is output (which is not desirable & shouldn't be required for this PR).

wbyoung · 2017-01-24T20:04:02Z

lib/setup/profile.js

+  var bashrcNotExist;
+
+  // Notice: will change fs.stat to fs.access in the future
+  // Reason: NodeJS 0.10 doesn't have fs.access (added in NodeJS 0.11.15)


Since avn always uses the active node version, we'll likely support 0.10 for a long time. This comment could be removed.

wbyoung · 2017-01-24T20:09:14Z

lib/setup/profile.js

+      .then(function(data) {
+        // RegExp to detect "~/.bashrc",
+        // "$HOME/.bashrc", or "/home/user/.bashrc"
+        var bashrcRe = new RegExp(' ?source +(\\\\\\n)? *(~\/.bashrc|' +


. is an alias of source

All space checks should probably use \s

Whitespace checks that can span a line should use the multiline workaround of [\s\S]

Checking for the full path seems unnecessary (~ vs $HOME vs /platform/specific/prefix) and error prone… for instance, I could write ${HOME} or ${HOME:/home}.

wbyoung · 2017-01-24T20:10:20Z

lib/setup/profile.js

+ * @function setup.profile.~shellInitScriptChooser
+ * @return {Promise}
+ */
+var shellInitScriptChooser = function() {


Since this is bash specific, let's name it as such.

wbyoung

Looking good!

evenfrost · 2019-04-25T12:30:18Z

Any update on this? Ubuntu uses .profile instead of .bash_profile, and avn doesn't work for me at all until moving scripts to .bashrc.

edsfocci added 4 commits January 12, 2017 00:44

Rework profile.js to use shellInitScriptChooser()

2ec71af

Fix code style errors

62b514b

Fix camelcase

db567c4

Fix code style errors, again

a4df2f8

wbyoung mentioned this pull request Jan 15, 2017

appendScript to .bashrc for Ubuntu-based #50

Closed

wbyoung suggested changes Jan 15, 2017

View reviewed changes

Filename bugfixes; Provide for neither exists, and .zshrc w/ .bash_pr…

3a12d2b

…ofile

edsfocci added 3 commits January 23, 2017 16:25

Treat mz/fs as Promisified

3e4fe81

Fix style: camelcase

5d5c01d

Fix style: if keyword

569aa22

Don't forget to return Promises

6441064

Make NodeJS 0.10 compatible

5bca4a7

wbyoung reviewed Jan 24, 2017

View reviewed changes

wbyoung suggested changes Jan 24, 2017

View reviewed changes

evenfrost mentioned this pull request Nov 13, 2019

Incorrectly creates .bash_profile file on WSL Ubuntu #88

Open

1 task


		var bashProfileFileName = '.bash_profile';
		var bashrcFileName = '.bashrc';

Conversation

edsfocci commented Jan 12, 2017

Uh oh!

coveralls commented Jan 12, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wbyoung left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coveralls commented Jan 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Jan 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Jan 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Jan 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

edsfocci commented Jan 23, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wbyoung commented Jan 24, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wbyoung left a comment

Choose a reason for hiding this comment

Uh oh!

evenfrost commented Apr 25, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coveralls commented Jan 12, 2017 •

edited

Loading

coveralls commented Jan 18, 2017 •

edited

Loading

coveralls commented Jan 23, 2017 •

edited

Loading

coveralls commented Jan 23, 2017 •

edited

Loading

coveralls commented Jan 23, 2017 •

edited

Loading