Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate common.getUserHome, advise using os.homedir instead #725

Merged
merged 2 commits into from May 31, 2017

Conversation

freitagbr
Copy link
Contributor

Deprecates common.getUserHome and provides a warning about the deprecation. Also replaces all of the internal uses of common.getUserHome with os.homedir.

Fixes #683

@freitagbr freitagbr added the breaking Breaking change label May 28, 2017
@freitagbr freitagbr added this to the v0.8.0 milestone May 28, 2017
@codecov-io
Copy link

codecov-io commented May 28, 2017

Codecov Report

Merging #725 into dev will increase coverage by 0.07%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev     #725      +/-   ##
==========================================
+ Coverage   96.63%   96.71%   +0.07%     
==========================================
  Files          33       33              
  Lines        1160     1156       -4     
==========================================
- Hits         1121     1118       -3     
+ Misses         39       38       -1
Impacted Files Coverage Δ
src/cd.js 100% <100%> (ø) ⬆️
src/common.js 98.83% <100%> (+0.53%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e7bebba...3520f81. Read the comment docs.

src/common.js Outdated
@@ -157,6 +158,8 @@ function ShellString(stdout, stderr, code) {

exports.ShellString = ShellString;

// DEPRECATED: Use os.homedir instead
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't deprecate internal functions, just remove them. We only explicitly export the functions listed here:

https://github.com/shelljs/shelljs/blob/master/plugin.js#L7

Copy link
Member

@nfischer nfischer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for cleaning this up!

@freitagbr freitagbr merged commit 908acd7 into dev May 31, 2017
@freitagbr freitagbr deleted the os-homedir branch May 31, 2017 23:03
nfischer pushed a commit that referenced this pull request Jun 7, 2017
* Deprecate common.getUserHome, advise using os.homedir instead

* Remove common.getUserHome
@nfischer nfischer mentioned this pull request Jun 7, 2017
nfischer pushed a commit that referenced this pull request Jun 7, 2017
* Deprecate common.getUserHome, advise using os.homedir instead

* Remove common.getUserHome
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants