Skip to content

Commit

Permalink
Add userHomeDir
Browse files Browse the repository at this point in the history
  • Loading branch information
ekaragodin committed Jun 24, 2019
1 parent 1365d28 commit 80d8194
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 0 deletions.
15 changes: 15 additions & 0 deletions os/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# os

Module provide platform-independent interface to operating system functionality.

## Usage

### userHomeDir

Returns the current user's home directory. On Unix, including macOS, it returns the $HOME environment variable. On Windows, it returns %USERPROFILE%.

```ts
import { userHomeDir } from "https://deno.land/std/os/mod.ts";

userHomeDir();
```
25 changes: 25 additions & 0 deletions os/mod.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.

/**
* Returns the current user's home directory.
* On Unix, including macOS, it returns the $HOME environment variable.
* On Windows, it returns %USERPROFILE%.
*
* Ported from Go: https://github.com/golang/go/blob/go1.12.5/src/os/file.go#L389
*/
export function userHomeDir(): string {
let env = "HOME";
let envErr = "$HOME";

if (Deno.platform.os === "win") {
env = "USERPROFILE";
envErr = "%USERPROFILE%";
}

const value = Deno.env()[env];
if (value !== "") {
return value;
}

throw new Error(`Environment variable '${envErr}' is not defined.`);
}
8 changes: 8 additions & 0 deletions os/test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.
import { test } from "../testing/mod.ts";
import { assertNotEquals } from "../testing/asserts.ts";
import { userHomeDir } from './mod.ts';

test(function testUserHomeDir(): void {
assertNotEquals(userHomeDir(), "");
});
1 change: 1 addition & 0 deletions test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import "./textproto/test.ts";
import "./util/test.ts";
import "./ws/test.ts";
import "./encoding/test.ts";
import "./os/test.ts";

import { xrun } from "./prettier/util.ts";
import { red, green } from "./colors/mod.ts";
Expand Down

0 comments on commit 80d8194

Please sign in to comment.