language-servers/deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-08-03 10:33:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

make camel case readDir, readLink, realPath (#4995)

Browse source
This commit is contained in:
Ryan Dahl 2020-04-29 16:39:37 -04:00 • committed by GitHub
parent 78e0ae643c
commit bc792c0267
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 80 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

6
cli/js/deno.ts
View file

@ -90,11 +90,11 @@ export {
export { openPlugin } from "./ops/plugins.ts";
export { kill } from "./ops/process.ts";
export { run, RunOptions, Process, ProcessStatus } from "./process.ts";
export { DirEntry, readdirSync, readdir } from "./ops/fs/read_dir.ts";
export { DirEntry, readDirSync, readDir } from "./ops/fs/read_dir.ts";
export { readFileSync, readFile } from "./read_file.ts";
export { readTextFileSync, readTextFile } from "./read_text_file.ts";
export { readlinkSync, readlink } from "./ops/fs/read_link.ts";
export { realpathSync, realpath } from "./ops/fs/realpath.ts";
export { readLinkSync, readLink } from "./ops/fs/read_link.ts";
export { realPathSync, realPath } from "./ops/fs/real_path.ts";
export { removeSync, remove, RemoveOptions } from "./ops/fs/remove.ts";
export { renameSync, rename } from "./ops/fs/rename.ts";
export { resources, close } from "./ops/resources.ts";

28
cli/js/lib.deno.ns.d.ts vendored
View file

@ -1366,25 +1366,25 @@ declare namespace Deno {
*
* // e.g. given /home/alice/file.txt and current directory /home/alice
* Deno.symlinkSync("file.txt", "symlink_file.txt");
* const realPath = Deno.realpathSync("./file.txt");
* const realSymLinkPath = Deno.realpathSync("./symlink_file.txt");
* const realPath = Deno.realPathSync("./file.txt");
* const realSymLinkPath = Deno.realPathSync("./symlink_file.txt");
* console.log(realPath); // outputs "/home/alice/file.txt"
* console.log(realSymLinkPath); // outputs "/home/alice/file.txt"
*
* Requires `allow-read` permission. */
export function realpathSync(path: string): string;
export function realPathSync(path: string): string;
/** Resolves to the absolute normalized path, with symbolic links resolved.
*
* // e.g. given /home/alice/file.txt and current directory /home/alice
* await Deno.symlink("file.txt", "symlink_file.txt");
* const realPath = await Deno.realpath("./file.txt");
* const realSymLinkPath = await Deno.realpath("./symlink_file.txt");
* const realPath = await Deno.realPath("./file.txt");
* const realSymLinkPath = await Deno.realPath("./symlink_file.txt");
* console.log(realPath); // outputs "/home/alice/file.txt"
* console.log(realSymLinkPath); // outputs "/home/alice/file.txt"
*
* Requires `allow-read` permission. */
export function realpath(path: string): Promise<string>;
export function realPath(path: string): Promise<string>;
export interface DirEntry {
name: string;
@ -1396,26 +1396,26 @@ declare namespace Deno {
/** Synchronously reads the directory given by `path` and returns an iterable
* of `Deno.DirEntry`.
*
* for (const dirEntry of Deno.readdirSync("/")) {
* for (const dirEntry of Deno.readDirSync("/")) {
* console.log(dirEntry.name);
* }
*
* Throws error if `path` is not a directory.
*
* Requires `allow-read` permission. */
export function readdirSync(path: string): Iterable<DirEntry>;
export function readDirSync(path: string): Iterable<DirEntry>;
/** Reads the directory given by `path` and returns an async iterable of
* `Deno.DirEntry`.
*
* for await (const dirEntry of Deno.readdir("/")) {
* for await (const dirEntry of Deno.readDir("/")) {
* console.log(dirEntry.name);
* }
*
* Throws error if `path` is not a directory.
*
* Requires `allow-read` permission. */
export function readdir(path: string): AsyncIterable<DirEntry>;
export function readDir(path: string): AsyncIterable<DirEntry>;
/** Synchronously copies the contents and permissions of one file to another
* specified path, by default creating a new file if needed, else overwriting.
@ -1440,22 +1440,22 @@ declare namespace Deno {
/** Returns the full path destination of the named symbolic link.
*
* Deno.symlinkSync("./test.txt", "./test_link.txt");
* const target = Deno.readlinkSync("./test_link.txt"); // full path of ./test.txt
* const target = Deno.readLinkSync("./test_link.txt"); // full path of ./test.txt
*
* Throws TypeError if called with a hard link
*
* Requires `allow-read` permission. */
export function readlinkSync(path: string): string;
export function readLinkSync(path: string): string;
/** Resolves to the full path destination of the named symbolic link.
*
* await Deno.symlink("./test.txt", "./test_link.txt");
* const target = await Deno.readlink("./test_link.txt"); // full path of ./test.txt
* const target = await Deno.readLink("./test_link.txt"); // full path of ./test.txt
*
* Throws TypeError if called with a hard link
*
* Requires `allow-read` permission. */
export function readlink(path: string): Promise<string>;
export function readLink(path: string): Promise<string>;
/** Resolves to a `Deno.FileInfo` for the specified `path`. If `path` is a
* symlink, information for the symlink will be returned instead of what it

4
cli/js/ops/fs/read_dir.ts
View file

@ -16,11 +16,11 @@ function res(response: ReadDirResponse): DirEntry[] {
return response.entries;
}
export function readdirSync(path: string): Iterable<DirEntry> {
export function readDirSync(path: string): Iterable<DirEntry> {
return res(sendSync("op_read_dir", { path }))[Symbol.iterator]();
}
export function readdir(path: string): AsyncIterable<DirEntry> {
export function readDir(path: string): AsyncIterable<DirEntry> {
const array = sendAsync("op_read_dir", { path }).then(res);
return {
async *[Symbol.asyncIterator](): AsyncIterableIterator<DirEntry> {

4
cli/js/ops/fs/read_link.ts
View file

@ -1,10 +1,10 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { sendSync, sendAsync } from "../dispatch_json.ts";
export function readlinkSync(path: string): string {
export function readLinkSync(path: string): string {
return sendSync("op_read_link", { path });
}
export function readlink(path: string): Promise<string> {
export function readLink(path: string): Promise<string> {
return sendAsync("op_read_link", { path });
}

4
cli/js/ops/fs/realpath.ts → cli/js/ops/fs/real_path.ts
View file

@ -1,10 +1,10 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { sendSync, sendAsync } from "../dispatch_json.ts";
export function realpathSync(path: string): string {
export function realPathSync(path: string): string {
return sendSync("op_realpath", { path });
}
export function realpath(path: string): Promise<string> {
export function realPath(path: string): Promise<string> {
return sendAsync("op_realpath", { path });
}

24
cli/js/tests/read_dir_test.ts
View file

@ -14,15 +14,15 @@ function assertSameContent(files: Deno.DirEntry[]): void {
assertEquals(counter, 1);
}
unitTest({ perms: { read: true } }, function readdirSyncSuccess(): void {
const files = [...Deno.readdirSync("cli/tests/")];
unitTest({ perms: { read: true } }, function readDirSyncSuccess(): void {
const files = [...Deno.readDirSync("cli/tests/")];
assertSameContent(files);
});
unitTest({ perms: { read: false } }, function readdirSyncPerm(): void {
unitTest({ perms: { read: false } }, function readDirSyncPerm(): void {
let caughtError = false;
try {
Deno.readdirSync("tests/");
Deno.readDirSync("tests/");
} catch (e) {
caughtError = true;
assert(e instanceof Deno.errors.PermissionDenied);
@ -30,12 +30,12 @@ unitTest({ perms: { read: false } }, function readdirSyncPerm(): void {
assert(caughtError);
});
unitTest({ perms: { read: true } }, function readdirSyncNotDir(): void {
unitTest({ perms: { read: true } }, function readDirSyncNotDir(): void {
let caughtError = false;
let src;
try {
src = Deno.readdirSync("cli/tests/fixture.json");
src = Deno.readDirSync("cli/tests/fixture.json");
} catch (err) {
caughtError = true;
assert(err instanceof Error);
@ -44,12 +44,12 @@ unitTest({ perms: { read: true } }, function readdirSyncNotDir(): void {
assertEquals(src, undefined);
});
unitTest({ perms: { read: true } }, function readdirSyncNotFound(): void {
unitTest({ perms: { read: true } }, function readDirSyncNotFound(): void {
let caughtError = false;
let src;
try {
src = Deno.readdirSync("bad_dir_name");
src = Deno.readDirSync("bad_dir_name");
} catch (err) {
caughtError = true;
assert(err instanceof Deno.errors.NotFound);
@ -58,22 +58,22 @@ unitTest({ perms: { read: true } }, function readdirSyncNotFound(): void {
assertEquals(src, undefined);
});
unitTest({ perms: { read: true } }, async function readdirSuccess(): Promise<
unitTest({ perms: { read: true } }, async function readDirSuccess(): Promise<
void
> {
const files = [];
for await (const dirEntry of Deno.readdir("cli/tests/")) {
for await (const dirEntry of Deno.readDir("cli/tests/")) {
files.push(dirEntry);
}
assertSameContent(files);
});
unitTest({ perms: { read: false } }, async function readdirPerm(): Promise<
unitTest({ perms: { read: false } }, async function readDirPerm(): Promise<
void
> {
let caughtError = false;
try {
await Deno.readdir("tests/")[Symbol.asyncIterator]().next();
await Deno.readDir("tests/")[Symbol.asyncIterator]().next();
} catch (e) {
caughtError = true;
assert(e instanceof Deno.errors.PermissionDenied);

20
cli/js/tests/read_link_test.ts
View file

@ -3,7 +3,7 @@ import { unitTest, assert, assertEquals } from "./test_util.ts";
unitTest(
{ perms: { write: true, read: true } },
function readlinkSyncSuccess(): void {
function readLinkSyncSuccess(): void {
const testDir = Deno.makeTempDirSync();
const target = testDir + "/target";
const symlink = testDir + "/symln";
@ -12,16 +12,16 @@ unitTest(
// See https://github.com/denoland/deno/issues/815.
if (Deno.build.os !== "windows") {
Deno.symlinkSync(target, symlink);
const targetPath = Deno.readlinkSync(symlink);
const targetPath = Deno.readLinkSync(symlink);
assertEquals(targetPath, target);
}
}
);
unitTest({ perms: { read: false } }, function readlinkSyncPerm(): void {
unitTest({ perms: { read: false } }, function readLinkSyncPerm(): void {
let caughtError = false;
try {
Deno.readlinkSync("/symlink");
Deno.readLinkSync("/symlink");
} catch (e) {
caughtError = true;
assert(e instanceof Deno.errors.PermissionDenied);
@ -29,11 +29,11 @@ unitTest({ perms: { read: false } }, function readlinkSyncPerm(): void {
assert(caughtError);
});
unitTest({ perms: { read: true } }, function readlinkSyncNotFound(): void {
unitTest({ perms: { read: true } }, function readLinkSyncNotFound(): void {
let caughtError = false;
let data;
try {
data = Deno.readlinkSync("bad_filename");
data = Deno.readLinkSync("bad_filename");
} catch (e) {
caughtError = true;
assert(e instanceof Deno.errors.NotFound);
@ -44,7 +44,7 @@ unitTest({ perms: { read: true } }, function readlinkSyncNotFound(): void {
unitTest(
{ perms: { write: true, read: true } },
async function readlinkSuccess(): Promise<void> {
async function readLinkSuccess(): Promise<void> {
const testDir = Deno.makeTempDirSync();
const target = testDir + "/target";
const symlink = testDir + "/symln";
@ -53,18 +53,18 @@ unitTest(
// See https://github.com/denoland/deno/issues/815.
if (Deno.build.os !== "windows") {
Deno.symlinkSync(target, symlink);
const targetPath = await Deno.readlink(symlink);
const targetPath = await Deno.readLink(symlink);
assertEquals(targetPath, target);
}
}
);
unitTest({ perms: { read: false } }, async function readlinkPerm(): Promise<
unitTest({ perms: { read: false } }, async function readLinkPerm(): Promise<
void
> {
let caughtError = false;
try {
await Deno.readlink("/symlink");
await Deno.readLink("/symlink");
} catch (e) {
caughtError = true;
assert(e instanceof Deno.errors.PermissionDenied);

32
cli/js/tests/realpath_test.ts → cli/js/tests/real_path_test.ts
View file

@ -1,9 +1,9 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { unitTest, assert } from "./test_util.ts";
unitTest({ perms: { read: true } }, function realpathSyncSuccess(): void {
unitTest({ perms: { read: true } }, function realPathSyncSuccess(): void {
const incompletePath = "cli/tests/fixture.json";
const realPath = Deno.realpathSync(incompletePath);
const realPath = Deno.realPathSync(incompletePath);
if (Deno.build.os !== "windows") {
assert(realPath.startsWith("/"));
} else {
@ -17,22 +17,22 @@ unitTest(
ignore: Deno.build.os === "windows",
perms: { read: true, write: true },
},
function realpathSyncSymlink(): void {
function realPathSyncSymlink(): void {
const testDir = Deno.makeTempDirSync();
const target = testDir + "/target";
const symlink = testDir + "/symln";
Deno.mkdirSync(target);
Deno.symlinkSync(target, symlink);
const targetPath = Deno.realpathSync(symlink);
const targetPath = Deno.realPathSync(symlink);
assert(targetPath.startsWith("/"));
assert(targetPath.endsWith("/target"));
}
);
unitTest({ perms: { read: false } }, function realpathSyncPerm(): void {
unitTest({ perms: { read: false } }, function realPathSyncPerm(): void {
let caughtError = false;
try {
Deno.realpathSync("some_file");
Deno.realPathSync("some_file");
} catch (e) {
caughtError = true;
assert(e instanceof Deno.errors.PermissionDenied);
@ -40,10 +40,10 @@ unitTest({ perms: { read: false } }, function realpathSyncPerm(): void {
assert(caughtError);
});
unitTest({ perms: { read: true } }, function realpathSyncNotFound(): void {
unitTest({ perms: { read: true } }, function realPathSyncNotFound(): void {
let caughtError = false;
try {
Deno.realpathSync("bad_filename");
Deno.realPathSync("bad_filename");
} catch (e) {
caughtError = true;
assert(e instanceof Deno.errors.NotFound);
@ -51,11 +51,11 @@ unitTest({ perms: { read: true } }, function realpathSyncNotFound(): void {
assert(caughtError);
});
unitTest({ perms: { read: true } }, async function realpathSuccess(): Promise<
unitTest({ perms: { read: true } }, async function realPathSuccess(): Promise<
void
> {
const incompletePath = "cli/tests/fixture.json";
const realPath = await Deno.realpath(incompletePath);
const realPath = await Deno.realPath(incompletePath);
if (Deno.build.os !== "windows") {
assert(realPath.startsWith("/"));
} else {
@ -69,24 +69,24 @@ unitTest(
ignore: Deno.build.os === "windows",
perms: { read: true, write: true },
},
async function realpathSymlink(): Promise<void> {
async function realPathSymlink(): Promise<void> {
const testDir = Deno.makeTempDirSync();
const target = testDir + "/target";
const symlink = testDir + "/symln";
Deno.mkdirSync(target);
Deno.symlinkSync(target, symlink);
const targetPath = await Deno.realpath(symlink);
const targetPath = await Deno.realPath(symlink);
assert(targetPath.startsWith("/"));
assert(targetPath.endsWith("/target"));
}
);
unitTest({ perms: { read: false } }, async function realpathPerm(): Promise<
unitTest({ perms: { read: false } }, async function realPathPerm(): Promise<
void
> {
let caughtError = false;
try {
await Deno.realpath("some_file");
await Deno.realPath("some_file");
} catch (e) {
caughtError = true;
assert(e instanceof Deno.errors.PermissionDenied);
@ -94,12 +94,12 @@ unitTest({ perms: { read: false } }, async function realpathPerm(): Promise<
assert(caughtError);
});
unitTest({ perms: { read: true } }, async function realpathNotFound(): Promise<
unitTest({ perms: { read: true } }, async function realPathNotFound(): Promise<
void
> {
let caughtError = false;
try {
await Deno.realpath("bad_filename");
await Deno.realPath("bad_filename");
} catch (e) {
caughtError = true;
assert(e instanceof Deno.errors.NotFound);

2
cli/js/tests/test_util.ts
View file

@ -332,7 +332,7 @@ unitTest(function permissionsMatches(): void {
unitTest(
{ perms: { read: true } },
function assertAllUnitTestFilesImported(): void {
const directoryTestFiles = [...Deno.readdirSync("./cli/js/tests/")]
const directoryTestFiles = [...Deno.readDirSync("./cli/js/tests/")]
.map((k) => k.name)
.filter(
(file) =>

2
cli/js/tests/unit_tests.ts
View file

@ -42,7 +42,7 @@ import "./net_test.ts";
import "./os_test.ts";
import "./permissions_test.ts";
import "./process_test.ts";
import "./realpath_test.ts";
import "./real_path_test.ts";
import "./read_dir_test.ts";
import "./read_text_file_test.ts";
import "./read_file_test.ts";