Add utility to retrieve user's home directory #67
Conversation
| ## Usage | ||
|
|
||
| ``` javascript | ||
| var homedir = require( '@stdlib/lib/node_modules/@stdlib/utils/homedir' ); |
There was a problem hiding this comment.
The require statement is incorrect.
|
|
||
| If unable to locate a `home` directory, the module returns `null`. | ||
|
|
||
| ``` javascript |
There was a problem hiding this comment.
I am not sure we should include this example. Could cause issues if we ever perform automated testing of doc examples.
|
|
||
| ## Notes | ||
|
|
||
| * This module primarily checks various [environment variables][environment-variables] to locate a `home` directory. Note that this approach has __security vulnerabilities__, as attackers can tamper with [environment variables][environment-variables]. |
There was a problem hiding this comment.
The implementation primarily checks...
| ## Examples | ||
|
|
||
| ``` javascript | ||
| var homedir = require( '@stdlib/lib/node_modules/@stdlib/utils/homedir' ); |
| t.end(); | ||
| }); | ||
|
|
||
| tape( 'the function returns the `/root` directory if run as `root` in a linux environment', function test( t ) { |
There was a problem hiding this comment.
All instances of linux => Linux in string descriptions.
| t.end(); | ||
| }); | ||
|
|
||
| tape( 'the function returns a home directory in a Mac OSX environment (USERNAME)', function test( t ) { |
There was a problem hiding this comment.
All instances of OSX => OS X in string descriptions.
| // Get the current user account (https://docs.python.org/2/library/getpass.html): | ||
| user = env[ 'LOGNAME' ] || env[ 'USER' ] || env[ 'LNAME' ] || env[ 'USERNAME' ]; | ||
|
|
||
| // If on Mac OSX, use the Mac path convention (http://apple.stackexchange.com/questions/119230/what-is-standard-for-os-x-filesystem-e-g-opt-vs-usr)... |
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
| // e.g., returns '/Users/<username>' | ||
| ``` | ||
|
|
||
| If unable to locate a `home` directory, the module returns `null`. |
kgryte
added
Feature
|
Could you take another look? |
| <!-- /.references --> | ||
|
|
||
|
|
||
| --- |
There was a problem hiding this comment.
CLI docs go above the "references" section.
| t.end(); | ||
| }); | ||
|
|
||
| tape( 'the function supports older Node versions', function test( t ) { |
There was a problem hiding this comment.
How does this test whether the implementation supports older Node versions? Considering how this package works, this should be in the other test file.
kgryte
left a comment
kgryte
left a comment
There was a problem hiding this comment.
Need to confirm test works as intended.
|
|
||
| opts = { | ||
| 'os': { | ||
| 'homedir': void 0 |
There was a problem hiding this comment.
Can you confirm that this works as intended? Possible that proxyquire ignores homedir when set to undefined, falling back to the original implementation. If so, can set to false.
This should be apparent when generating a coverage report and whether all code branches are covered (notably within the main index.js file).
There was a problem hiding this comment.
Yes, can confirm that we reach 100% code coverage for homedir.
There was a problem hiding this comment.
Must be because os does get mocked with an empty object. Makes sense.
Resolves #60 .
Checklist
develop.developbranch.Description
This pull request:
stdlib.Related Issues
This pull request:
Questions
No.
Other
No.
@stdlib-js/reviewers