Class RipgrepSearchInWorkspaceServer

Protected Readonlylogger

Protected ReadonlyrawProcessFactory

Protected ReadonlyrgPath

ProtectedaddGlobArgs

• addGlobArgs(args: Set<string>, patterns: string[], exclude?: boolean): void

  Add glob patterns to ripgrep's arguments

  Parameters

  • args: Set<string>

    ripgrep set of arguments

  • patterns: string[]

    patterns to include as globs

  • exclude: boolean = false

    whether to negate the glob pattern or not

  Returns void

ProtectedextractSearchPathsFromIncludes

• extractSearchPathsFromIncludes(
      rootPaths: string[],
      options: SearchInWorkspaceOptions,
  ): Promise<string[]>

  The default search paths are set to be the root paths associated to a workspace however the search scope can be further refined with the include paths available in the search options. This method will replace the searching paths to the ones specified in the 'include' options but as long as the 'include' paths can be successfully validated as existing.

  Therefore the returned array of paths can be either the workspace root paths or a set of validated paths derived from the include options which can be used to perform the search.

  Any pattern that resulted in a valid search path will be removed from the 'include' list as it is provided as an equivalent search path instead.

  Parameters

  • rootPaths: string[]
  • options: SearchInWorkspaceOptions

  Returns Promise<string[]>

ProtectedgetAbsolutePathFromPattern

• getAbsolutePathFromPattern(
      root: string,
      pattern: string,
  ): Promise<undefined | string>

  Transform include/exclude option patterns from relative patterns to absolute patterns. E.g. './abc/foo.' to '${root}/abc/foo.', the transformation does not validate the pattern against the file system as glob suffixes remain.

  Parameters

  • root: string
  • pattern: string

  Returns Promise<undefined | string>

  undefined if the pattern cannot be converted into an absolute path.

ProtectedgetArgs

• getArgs(options?: SearchInWorkspaceOptions): string[]

  Parameters

  • Optionaloptions: SearchInWorkspaceOptions

  Returns string[]

ProtectedisPatternRelative

• isPatternRelative(pattern: string): boolean

  Tests if the pattern is relative and should/can be made absolute.

  Parameters

  • pattern: string

  Returns boolean

ProtectedreplaceRelativeToAbsolute

• replaceRelativeToAbsolute(roots: string[], patterns?: string[]): string[]

  Transforms relative patterns to absolute paths, one for each given search path. The resulting paths are not validated in the file system as the pattern keeps glob information.

  Parameters

  • roots: string[]
  • patterns: string[] = []

  Returns string[]

  The resulting list may be larger than the received patterns as a relative pattern may resolve to multiple absolute patterns up to the number of search paths.