Rename glob() to globToRegExp(), restructure glob related interfaces

denoland · Sep 28, 2019 · a2e441f · a2e441f
1 parent 4729107
commit a2e441f
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 58 deletions.
diff --git a/fs/glob.ts b/fs/glob.ts
@@ -4,18 +4,12 @@ import { WalkInfo, walk, walkSync } from "./walk.ts";
 const { cwd } = Deno;
 
 export interface GlobOptions {
-  // Allow ExtGlob features
   extended?: boolean;
-  // When globstar is true, '/foo/**' is equivelant
-  // to '/foo/*' when globstar is false.
-  // Having globstar set to true is the same usage as
-  // using wildcards in bash
   globstar?: boolean;
-  // be laissez faire about mutiple slashes
   strict?: boolean;
-  // Parse as filepath for extra path related features
-  filepath?: boolean;
-  // Flag to use in the generated RegExp
+}
+
+export interface GlobToRegExpOptions extends GlobOptions {
   flags?: string;
 }
 
@@ -27,12 +21,12 @@ export interface GlobOptions {
  *
  *     Looking for all the `ts` files:
  *     walkSync(".", {
- *       match: [glob("*.ts")]
+ *       match: [globToRegExp("*.ts")]
  *     })
  *
  *     Looking for all the `.json` files in any subfolder:
  *     walkSync(".", {
- *       match: [glob(join("a", "**", "*.json"),{
+ *       match: [globToRegExp(join("a", "**", "*.json"),{
  *         flags: "g",
  *         extended: true,
  *         globstar: true
@@ -43,12 +37,12 @@ export interface GlobOptions {
  * @param options - Specific options for the glob pattern
  * @returns A RegExp for the glob pattern
  */
-export function glob(glob: string, options: GlobOptions = {}): RegExp {
-  const result = globrex(glob, options);
-  if (options.filepath) {
-    return result.path!.regex;
-  }
-  return result.regex;
+export function globToRegExp(
+  glob: string,
+  options: GlobToRegExpOptions = {}
+): RegExp {
+  const result = globrex(glob, { ...options, filepath: true });
+  return result.path!.regex;
 }
 
 /** Test whether the given string is a glob */
@@ -103,17 +97,15 @@ export async function* expandGlob(
     includeDirs = true,
     extended = false,
     globstar = false,
-    strict = false,
-    filepath = true,
-    flags = ""
+    strict = false
   }: ExpandGlobOptions = {}
 ): AsyncIterableIterator<WalkInfo> {
   const absoluteGlob = isAbsolute(globString)
     ? globString
     : join(root, globString);
-  const globOptions = { extended, globstar, strict, filepath, flags };
+  const globOptions = { extended, globstar, strict };
   yield* walk(root, {
-    match: [glob(absoluteGlob, globOptions)],
+    match: [globToRegExp(absoluteGlob, globOptions)],
     includeDirs
   });
 }
@@ -127,17 +119,15 @@ export function* expandGlobSync(
     includeDirs = true,
     extended = false,
     globstar = false,
-    strict = false,
-    filepath = true,
-    flags = ""
+    strict = false
   }: ExpandGlobOptions = {}
 ): IterableIterator<WalkInfo> {
   const absoluteGlob = isAbsolute(globString)
     ? globString
     : join(root, globString);
-  const globOptions = { extended, globstar, strict, filepath, flags };
+  const globOptions = { extended, globstar, strict };
   yield* walkSync(root, {
-    match: [glob(absoluteGlob, globOptions)],
+    match: [globToRegExp(absoluteGlob, globOptions)],
     includeDirs
   });
 }
diff --git a/fs/glob_test.ts b/fs/glob_test.ts
@@ -5,7 +5,7 @@ import { isWindows } from "./path/constants.ts";
 import {
   ExpandGlobOptions,
   expandGlob,
-  glob,
+  globToRegExp,
   isGlob,
   expandGlobSync
 } from "./glob.ts";
@@ -17,37 +17,37 @@ import { touch, walkArray } from "./walk_test.ts";
 test({
   name: "glob: glob to regex",
   fn(): void {
-    assertEquals(glob("unicorn.*") instanceof RegExp, true);
-    assertEquals(glob("unicorn.*").test("poney.ts"), false);
-    assertEquals(glob("unicorn.*").test("unicorn.py"), true);
-    assertEquals(glob("*.ts").test("poney.ts"), true);
-    assertEquals(glob("*.ts").test("unicorn.js"), false);
+    assertEquals(globToRegExp("unicorn.*") instanceof RegExp, true);
+    assertEquals(globToRegExp("unicorn.*").test("poney.ts"), false);
+    assertEquals(globToRegExp("unicorn.*").test("unicorn.py"), true);
+    assertEquals(globToRegExp("*.ts").test("poney.ts"), true);
+    assertEquals(globToRegExp("*.ts").test("unicorn.js"), false);
     assertEquals(
-      glob(join("unicorn", "**", "cathedral.ts")).test(
+      globToRegExp(join("unicorn", "**", "cathedral.ts")).test(
         join("unicorn", "in", "the", "cathedral.ts")
       ),
       true
     );
     assertEquals(
-      glob(join("unicorn", "**", "cathedral.ts")).test(
+      globToRegExp(join("unicorn", "**", "cathedral.ts")).test(
         join("unicorn", "in", "the", "kitchen.ts")
       ),
       false
     );
     assertEquals(
-      glob(join("unicorn", "**", "bathroom.*")).test(
+      globToRegExp(join("unicorn", "**", "bathroom.*")).test(
         join("unicorn", "sleeping", "in", "bathroom.py")
       ),
       true
     );
     assertEquals(
-      glob(join("unicorn", "!(sleeping)", "bathroom.ts"), {
+      globToRegExp(join("unicorn", "!(sleeping)", "bathroom.ts"), {
         extended: true
       }).test(join("unicorn", "flying", "bathroom.ts")),
       true
     );
     assertEquals(
-      glob(join("unicorn", "(!sleeping)", "bathroom.ts"), {
+      globToRegExp(join("unicorn", "(!sleeping)", "bathroom.ts"), {
         extended: true
       }).test(join("unicorn", "sleeping", "bathroom.ts")),
       false
@@ -61,7 +61,7 @@ testWalk(
     await touch(d + "/a/x.ts");
   },
   async function globInWalk(): Promise<void> {
-    const arr = await walkArray(".", { match: [glob("*.ts")] });
+    const arr = await walkArray(".", { match: [globToRegExp("*.ts")] });
     assertEquals(arr.length, 1);
     assertEquals(arr[0], "a/x.ts");
   }
@@ -76,7 +76,7 @@ testWalk(
     await touch(d + "/b/z.js");
   },
   async function globInWalkWildcardFiles(): Promise<void> {
-    const arr = await walkArray(".", { match: [glob("*.ts")] });
+    const arr = await walkArray(".", { match: [globToRegExp("*.ts")] });
     assertEquals(arr.length, 2);
     assertEquals(arr[0], "a/x.ts");
     assertEquals(arr[1], "b/z.ts");
@@ -92,7 +92,7 @@ testWalk(
   async function globInWalkFolderWildcard(): Promise<void> {
     const arr = await walkArray(".", {
       match: [
-        glob(join("a", "**", "*.ts"), {
+        globToRegExp(join("a", "**", "*.ts"), {
           flags: "g",
           globstar: true
         })
@@ -116,7 +116,7 @@ testWalk(
   async function globInWalkFolderExtended(): Promise<void> {
     const arr = await walkArray(".", {
       match: [
-        glob(join("a", "+(raptor|deno)", "*.ts"), {
+        globToRegExp(join("a", "+(raptor|deno)", "*.ts"), {
           flags: "g",
           extended: true
         })
@@ -136,7 +136,7 @@ testWalk(
   },
   async function globInWalkWildcardExtension(): Promise<void> {
     const arr = await walkArray(".", {
-      match: [glob("x.*", { flags: "g", globstar: true })]
+      match: [globToRegExp("x.*", { flags: "g", globstar: true })]
     });
     assertEquals(arr.length, 2);
     assertEquals(arr[0], "x.js");
@@ -288,14 +288,12 @@ function urlToFilePath(url: URL): string {
   return url.pathname.slice(url.protocol == "file:" && isWindows ? 1 : 0);
 }
 
-const EG_OPTIONS = {
+const EG_OPTIONS: ExpandGlobOptions = {
   root: urlToFilePath(new URL(join("testdata", "glob"), import.meta.url)),
   includeDirs: true,
   extended: false,
   globstar: false,
-  strict: false,
-  filepath: false,
-  flags: ""
+  strict: false
 };
 
 test(async function expandGlobExt(): Promise<void> {

diff --git a/fs/globrex.ts b/fs/globrex.ts
@@ -2,8 +2,6 @@
 // MIT License
 // Copyright (c) 2018 Terkel Gjervig Nielsen
 
-import { GlobOptions } from "./glob.ts";
-
 const isWin = Deno.build.os === "win";
 const SEP = isWin ? `(\\\\+|\\/)` : `\\/`;
 const SEP_ESC = isWin ? `\\\\` : `/`;
@@ -13,6 +11,22 @@ const WILDCARD = `([^${SEP_ESC}/]*)`;
 const GLOBSTAR_SEGMENT = `((?:[^${SEP_ESC}/]*(?:${SEP_ESC}|\/|$))*)`;
 const WILDCARD_SEGMENT = `([^${SEP_ESC}/]*)`;
 
+export interface GlobrexOptions {
+  // Allow ExtGlob features
+  extended?: boolean;
+  // When globstar is true, '/foo/**' is equivelant
+  // to '/foo/*' when globstar is false.
+  // Having globstar set to true is the same usage as
+  // using wildcards in bash
+  globstar?: boolean;
+  // be laissez faire about mutiple slashes
+  strict?: boolean;
+  // Parse as filepath for extra path related features
+  filepath?: boolean;
+  // Flag to use in the generated RegExp
+  flags?: string;
+}
+
 export interface GlobrexResult {
   regex: RegExp;
   path?: {
@@ -41,7 +55,7 @@ export function globrex(
     strict = false,
     filepath = false,
     flags = ""
-  }: GlobOptions = {}
+  }: GlobrexOptions = {}
 ): GlobrexResult {
   let regex = "";
   let segment = "";

diff --git a/prettier/main.ts b/prettier/main.ts
@@ -23,10 +23,14 @@
 // Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.
 // This script formats the given source files. If the files are omitted, it
 // formats the all files in the repository.
-import { ExpandGlobOptions, expandGlob, glob } from "../fs/glob.ts";
-import { isAbsolute, join } from "../fs/path/mod.ts";
-import { WalkInfo } from "../fs/walk.ts";
 import { parse } from "../flags/mod.ts";
+import {
+  ExpandGlobOptions,
+  WalkInfo,
+  expandGlob,
+  globToRegExp
+} from "../fs/mod.ts";
+import { isAbsolute, join } from "../fs/path/mod.ts";
 import { prettier, prettierPlugins } from "./prettier.ts";
 const { args, cwd, exit, readAll, readFile, stdin, stdout, writeFile } = Deno;
 
@@ -308,14 +312,17 @@ async function* getTargetFiles(
     root,
     extended: true,
     globstar: true,
-    filepath: true
+    strict: false
   };
 
   // TODO: We use the `g` flag here to support path prefixes when specifying
   // excludes. Replace with a solution that does this more correctly.
   const excludePathPatterns = exclude.map(
     (s: string): RegExp =>
-      glob(isAbsolute(s) ? s : join(root, s), { ...expandGlobOpts, flags: "g" })
+      globToRegExp(isAbsolute(s) ? s : join(root, s), {
+        ...expandGlobOpts,
+        flags: "g"
+      })
   );
   const shouldInclude = ({ filename }: WalkInfo): boolean =>
     !excludePathPatterns.some((p: RegExp): boolean => !!filename.match(p));

diff --git a/testing/runner.ts b/testing/runner.ts
@@ -1,7 +1,12 @@
 #!/usr/bin/env -S deno -A
 // Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.
 import { parse } from "../flags/mod.ts";
-import { WalkInfo, expandGlob, glob, ExpandGlobOptions } from "../fs/mod.ts";
+import {
+  ExpandGlobOptions,
+  WalkInfo,
+  expandGlob,
+  globToRegExp
+} from "../fs/mod.ts";
 import { isWindows } from "../fs/path/constants.ts";
 import { isAbsolute, join } from "../fs/path/mod.ts";
 import { RunTestsOptions, runTests } from "./mod.ts";
@@ -76,14 +81,17 @@ export async function* findTestModules(
     root,
     extended: true,
     globstar: true,
-    filepath: true
+    strict: false
   };
 
   // TODO: We use the `g` flag here to support path prefixes when specifying
   // excludes. Replace with a solution that does this more correctly.
   const excludePathPatterns = excludePaths.map(
     (s: string): RegExp =>
-      glob(isAbsolute(s) ? s : join(root, s), { ...expandGlobOpts, flags: "g" })
+      globToRegExp(isAbsolute(s) ? s : join(root, s), {
+        ...expandGlobOpts,
+        flags: "g"
+      })
   );
   const excludeUrlPatterns = excludeUrls.map(
     (url: string): RegExp => RegExp(url)