/* @internal */

namespace ts.Completions.PathCompletions {

export function getStringLiteralCompletionsFromModuleNames(sourceFile: SourceFile, node: LiteralExpression, compilerOptions: CompilerOptions, host: LanguageServiceHost, typeChecker: TypeChecker): CompletionEntry[] {

const literalValue = normalizeSlashes(node.text);

const scriptPath = node.getSourceFile().path;

const scriptDirectory = getDirectoryPath(scriptPath);

const span = getDirectoryFragmentTextSpan((<StringLiteral>node).text, node.getStart(sourceFile) + 1);

if (isPathRelativeToScript(literalValue) || isRootedDiskPath(literalValue)) {

const extensions = getSupportedExtensions(compilerOptions);

if (compilerOptions.rootDirs) {

return getCompletionEntriesForDirectoryFragmentWithRootDirs(

compilerOptions.rootDirs, literalValue, scriptDirectory, extensions, /*includeExtensions*/ false, span, compilerOptions, host, scriptPath);

}

else {

return getCompletionEntriesForDirectoryFragment(

literalValue, scriptDirectory, extensions, /*includeExtensions*/ false, span, host, scriptPath);

}

}

else {

// Check for node modules

return getCompletionEntriesForNonRelativeModules(literalValue, scriptDirectory, span, compilerOptions, host, typeChecker);

}

}

/**

* Takes a script path and returns paths for all potential folders that could be merged with its

* containing folder via the "rootDirs" compiler option

*/

function getBaseDirectoriesFromRootDirs(rootDirs: string[], basePath: string, scriptPath: string, ignoreCase: boolean): string[] {

// Make all paths absolute/normalized if they are not already

rootDirs = rootDirs.map(rootDirectory => normalizePath(isRootedDiskPath(rootDirectory) ? rootDirectory : combinePaths(basePath, rootDirectory)));

// Determine the path to the directory containing the script relative to the root directory it is contained within

const relativeDirectory = firstDefined(rootDirs, rootDirectory =>

containsPath(rootDirectory, scriptPath, basePath, ignoreCase) ? scriptPath.substr(rootDirectory.length) : undefined);

// Now find a path for each potential directory that is to be merged with the one containing the script

return deduplicate(

rootDirs.map(rootDirectory => combinePaths(rootDirectory, relativeDirectory)),

equateStringsCaseSensitive,

compareStringsCaseSensitive);

}

function getCompletionEntriesForDirectoryFragmentWithRootDirs(rootDirs: string[], fragment: string, scriptPath: string, extensions: ReadonlyArray<string>, includeExtensions: boolean, span: TextSpan, compilerOptions: CompilerOptions, host: LanguageServiceHost, exclude?: string): CompletionEntry[] {

const basePath = compilerOptions.project || host.getCurrentDirectory();

const ignoreCase = !(host.useCaseSensitiveFileNames && host.useCaseSensitiveFileNames());

const baseDirectories = getBaseDirectoriesFromRootDirs(rootDirs, basePath, scriptPath, ignoreCase);

const result: CompletionEntry[] = [];

for (const baseDirectory of baseDirectories) {

getCompletionEntriesForDirectoryFragment(fragment, baseDirectory, extensions, includeExtensions, span, host, exclude, result);

}

return result;

}

/**

* Given a path ending at a directory, gets the completions for the path, and filters for those entries containing the basename.

*/

function getCompletionEntriesForDirectoryFragment(fragment: string, scriptPath: string, extensions: ReadonlyArray<string>, includeExtensions: boolean, span: TextSpan, host: LanguageServiceHost, exclude?: string, result: CompletionEntry[] = []): CompletionEntry[] {

if (fragment === undefined) {

fragment = "";

}

fragment = normalizeSlashes(fragment);

/**

* Remove the basename from the path. Note that we don't use the basename to filter completions;

* the client is responsible for refining completions.

*/

fragment = getDirectoryPath(fragment);

if (fragment === "") {

fragment = "." + directorySeparator;

}

fragment = ensureTrailingDirectorySeparator(fragment);

const absolutePath = normalizeAndPreserveTrailingSlash(isRootedDiskPath(fragment) ? fragment : combinePaths(scriptPath, fragment));

const baseDirectory = getDirectoryPath(absolutePath);

const ignoreCase = !(host.useCaseSensitiveFileNames && host.useCaseSensitiveFileNames());

if (tryDirectoryExists(host, baseDirectory)) {

// Enumerate the available files if possible

const files = tryReadDirectory(host, baseDirectory, extensions, /*exclude*/ undefined, /*include*/ ["./*"]);

if (files) {

/**

* Multiple file entries might map to the same truncated name once we remove extensions

* (happens iff includeExtensions === false)so we use a set-like data structure. Eg:

*

* both foo.ts and foo.tsx become foo

*/

const foundFiles = createMap<true>();

for (let filePath of files) {

filePath = normalizePath(filePath);

if (exclude && comparePaths(filePath, exclude, scriptPath, ignoreCase) === Comparison.EqualTo) {

continue;

}

const foundFileName = includeExtensions ? getBaseFileName(filePath) : removeFileExtension(getBaseFileName(filePath));

if (!foundFiles.has(foundFileName)) {

foundFiles.set(foundFileName, true);

}

}

forEachKey(foundFiles, foundFile => {

result.push(createCompletionEntryForModule(foundFile, ScriptElementKind.scriptElement, span));

});

}

// If possible, get folder completion as well

const directories = tryGetDirectories(host, baseDirectory);

if (directories) {

for (const directory of directories) {

const directoryName = getBaseFileName(normalizePath(directory));

result.push(createCompletionEntryForModule(directoryName, ScriptElementKind.directory, span));

}

}

}

return result;

}

/**

* Check all of the declared modules and those in node modules. Possible sources of modules:

* Modules that are found by the type checker

* Modules found relative to "baseUrl" compliler options (including patterns from "paths" compiler option)

* Modules from node_modules (i.e. those listed in package.json)

* This includes all files that are found in node_modules/moduleName/ with acceptable file extensions

*/

function getCompletionEntriesForNonRelativeModules(fragment: string, scriptPath: string, span: TextSpan, compilerOptions: CompilerOptions, host: LanguageServiceHost, typeChecker: TypeChecker): CompletionEntry[] {

const { baseUrl, paths } = compilerOptions;

const result: CompletionEntry[] = [];

const fileExtensions = getSupportedExtensions(compilerOptions);

if (baseUrl) {

const projectDir = compilerOptions.project || host.getCurrentDirectory();

const absolute = isRootedDiskPath(baseUrl) ? baseUrl : combinePaths(projectDir, baseUrl);

getCompletionEntriesForDirectoryFragment(fragment, normalizePath(absolute), fileExtensions, /*includeExtensions*/ false, span, host, /*exclude*/ undefined, result);

for (const path in paths) {

const patterns = paths[path];

if (paths.hasOwnProperty(path) && patterns) {

for (const pathCompletion of getCompletionsForPathMapping(path, patterns, fragment, baseUrl, fileExtensions, host)) {

// Path mappings may provide a duplicate way to get to something we've already added, so don't add again.

if (!result.some(entry => entry.name === pathCompletion)) {

result.push(createCompletionEntryForModule(pathCompletion, ScriptElementKind.externalModuleName, span));

}

}

}

}

}

if (compilerOptions.moduleResolution === ts.ModuleResolutionKind.NodeJs) {

forEachAncestorDirectory(scriptPath, ancestor => {

const nodeModules = combinePaths(ancestor, "node_modules");

if (host.directoryExists(nodeModules)) {

getCompletionEntriesForDirectoryFragment(fragment, nodeModules, fileExtensions, /*includeExtensions*/ false, span, host, /*exclude*/ undefined, result);

}

});

}

getCompletionEntriesFromTypings(host, compilerOptions, scriptPath, span, result);

for (const moduleName of enumeratePotentialNonRelativeModules(fragment, scriptPath, compilerOptions, typeChecker, host)) {

result.push(createCompletionEntryForModule(moduleName, ScriptElementKind.externalModuleName, span));

}

return result;

}

function getCompletionsForPathMapping(

path: string, patterns: ReadonlyArray<string>, fragment: string, baseUrl: string, fileExtensions: ReadonlyArray<string>, host: LanguageServiceHost,

): string[] {

if (!endsWith(path, "*")) {

// For a path mapping "foo": ["/x/y/z.ts"], add "foo" itself as a completion.

return !stringContains(path, "*") && startsWith(path, fragment) ? [path] : emptyArray;

}

const pathPrefix = path.slice(0, path.length - 1);

if (!startsWith(fragment, pathPrefix)) {

return emptyArray;

}

const remainingFragment = fragment.slice(pathPrefix.length);

return flatMap(patterns, pattern => getModulesForPathsPattern(remainingFragment, baseUrl, pattern, fileExtensions, host));

}

function getModulesForPathsPattern(fragment: string, baseUrl: string, pattern: string, fileExtensions: ReadonlyArray<string>, host: LanguageServiceHost): string[] | undefined {

if (!host.readDirectory) {

return undefined;

}

const parsed = hasZeroOrOneAsteriskCharacter(pattern) ? tryParsePattern(pattern) : undefined;

if (!parsed) {

return undefined;

}

// The prefix has two effective parts: the directory path and the base component after the filepath that is not a

// full directory component. For example: directory/path/of/prefix/base*

const normalizedPrefix = normalizeAndPreserveTrailingSlash(parsed.prefix);

const normalizedPrefixDirectory = getDirectoryPath(normalizedPrefix);

const normalizedPrefixBase = getBaseFileName(normalizedPrefix);

const fragmentHasPath = stringContains(fragment, directorySeparator);

// Try and expand the prefix to include any path from the fragment so that we can limit the readDirectory call

const expandedPrefixDirectory = fragmentHasPath ? combinePaths(normalizedPrefixDirectory, normalizedPrefixBase + getDirectoryPath(fragment)) : normalizedPrefixDirectory;

const normalizedSuffix = normalizePath(parsed.suffix);

// Need to normalize after combining: If we combinePaths("a", "../b"), we want "b" and not "a/../b".

const baseDirectory = normalizePath(combinePaths(baseUrl, expandedPrefixDirectory));

const completePrefix = fragmentHasPath ? baseDirectory : ensureTrailingDirectorySeparator(baseDirectory) + normalizedPrefixBase;

// If we have a suffix, then we need to read the directory all the way down. We could create a glob

// that encodes the suffix, but we would have to escape the character "?" which readDirectory

// doesn't support. For now, this is safer but slower

const includeGlob = normalizedSuffix ? "**/*" : "./*";

const matches = tryReadDirectory(host, baseDirectory, fileExtensions, /*exclude*/ undefined, [includeGlob]);

const directories = tryGetDirectories(host, baseDirectory);

// Trim away prefix and suffix

return mapDefined(concatenate(matches, directories), match => {

const normalizedMatch = normalizePath(match);

if (!endsWith(normalizedMatch, normalizedSuffix) || !startsWith(normalizedMatch, completePrefix)) {

return;

}

const start = completePrefix.length;

const length = normalizedMatch.length - start - normalizedSuffix.length;

return removeFileExtension(normalizedMatch.substr(start, length));

});

}

function enumeratePotentialNonRelativeModules(fragment: string, scriptPath: string, options: CompilerOptions, typeChecker: TypeChecker, host: LanguageServiceHost): string[] {

// Check If this is a nested module

const isNestedModule = stringContains(fragment, directorySeparator);

const moduleNameFragment = isNestedModule ? fragment.substr(0, fragment.lastIndexOf(directorySeparator)) : undefined;

// Get modules that the type checker picked up

const ambientModules = map(typeChecker.getAmbientModules(), sym => stripQuotes(sym.name));

let nonRelativeModuleNames = filter(ambientModules, moduleName => startsWith(moduleName, fragment));

// Nested modules of the form "module-name/sub" need to be adjusted to only return the string

// after the last '/' that appears in the fragment because that's where the replacement span

// starts

if (isNestedModule) {

const moduleNameWithSeperator = ensureTrailingDirectorySeparator(moduleNameFragment);

nonRelativeModuleNames = map(nonRelativeModuleNames, nonRelativeModuleName => {

return removePrefix(nonRelativeModuleName, moduleNameWithSeperator);

});

}

if (!options.moduleResolution || options.moduleResolution === ModuleResolutionKind.NodeJs) {

for (const visibleModule of enumerateNodeModulesVisibleToScript(host, scriptPath)) {

if (!isNestedModule) {

nonRelativeModuleNames.push(visibleModule.moduleName);

}

else if (startsWith(visibleModule.moduleName, moduleNameFragment)) {

const nestedFiles = tryReadDirectory(host, visibleModule.moduleDir, supportedTypeScriptExtensions, /*exclude*/ undefined, /*include*/ ["./*"]);

if (nestedFiles) {

for (let f of nestedFiles) {

f = normalizePath(f);

const nestedModule = removeFileExtension(getBaseFileName(f));

nonRelativeModuleNames.push(nestedModule);

}

}

}

}

}

return deduplicate(nonRelativeModuleNames, equateStringsCaseSensitive, compareStringsCaseSensitive);

}

export function getTripleSlashReferenceCompletion(sourceFile: SourceFile, position: number, compilerOptions: CompilerOptions, host: LanguageServiceHost): CompletionEntry[] | undefined {

const token = getTokenAtPosition(sourceFile, position, /*includeJsDocComment*/ false);

const commentRanges = getLeadingCommentRanges(sourceFile.text, token.pos);

const range = commentRanges && find(commentRanges, commentRange => position >= commentRange.pos && position <= commentRange.end);

if (!range) {

return undefined;

}

const text = sourceFile.text.slice(range.pos, position);

const match = tripleSlashDirectiveFragmentRegex.exec(text);

if (!match) {

return undefined;

}

const [, prefix, kind, toComplete] = match;

const scriptPath = getDirectoryPath(sourceFile.path);

switch (kind) {

case "path": {

// Give completions for a relative path

const span = getDirectoryFragmentTextSpan(toComplete, range.pos + prefix.length);

return getCompletionEntriesForDirectoryFragment(toComplete, scriptPath, getSupportedExtensions(compilerOptions), /*includeExtensions*/ true, span, host, sourceFile.path);

}

case "types": {

// Give completions based on the typings available

const span = createTextSpan(range.pos + prefix.length, match[0].length - prefix.length);

return getCompletionEntriesFromTypings(host, compilerOptions, scriptPath, span);

}

default:

return undefined;

}

}

function getCompletionEntriesFromTypings(host: LanguageServiceHost, options: CompilerOptions, scriptPath: string, span: TextSpan, result: CompletionEntry[] = []): CompletionEntry[] {

// Check for typings specified in compiler options

const seen = createMap<true>();

if (options.types) {

for (const typesName of options.types) {

const moduleName = getUnmangledNameForScopedPackage(typesName);

pushResult(moduleName);

}

}

else if (host.getDirectories) {

let typeRoots: ReadonlyArray<string>;

try {

typeRoots = getEffectiveTypeRoots(options, host);

}

catch { /* Wrap in try catch because getEffectiveTypeRoots touches the filesystem */ }

if (typeRoots) {

for (const root of typeRoots) {

getCompletionEntriesFromDirectories(root);

}

}

// Also get all @types typings installed in visible node_modules directories

for (const packageJson of findPackageJsons(scriptPath, host)) {

const typesDir = combinePaths(getDirectoryPath(packageJson), "node_modules/@types");

getCompletionEntriesFromDirectories(typesDir);

}

}

return result;

function getCompletionEntriesFromDirectories(directory: string) {

Debug.assert(!!host.getDirectories);

if (tryDirectoryExists(host, directory)) {

const directories = tryGetDirectories(host, directory);

if (directories) {

for (let typeDirectory of directories) {

typeDirectory = normalizePath(typeDirectory);

const directoryName = getBaseFileName(typeDirectory);

const moduleName = getUnmangledNameForScopedPackage(directoryName);

pushResult(moduleName);

}

}

}

}

function pushResult(moduleName: string) {

if (!seen.has(moduleName)) {

result.push(createCompletionEntryForModule(moduleName, ScriptElementKind.externalModuleName, span));

seen.set(moduleName, true);

}

}

}

function findPackageJsons(directory: string, host: LanguageServiceHost): string[] {

const paths: string[] = [];

forEachAncestorDirectory(directory, ancestor => {

const currentConfigPath = findConfigFile(ancestor, (f) => tryFileExists(host, f), "package.json");

if (!currentConfigPath) {

return true; // break out

}

paths.push(currentConfigPath);

});

return paths;

}

function enumerateNodeModulesVisibleToScript(host: LanguageServiceHost, scriptPath: string) {

const result: VisibleModuleInfo[] = [];

if (host.readFile && host.fileExists) {

for (const packageJson of findPackageJsons(scriptPath, host)) {

const contents = tryReadingPackageJson(packageJson);

if (!contents) {

return;

}

const nodeModulesDir = combinePaths(getDirectoryPath(packageJson), "node_modules");

const foundModuleNames: string[] = [];

// Provide completions for all non @types dependencies

for (const key of nodeModulesDependencyKeys) {

addPotentialPackageNames(contents[key], foundModuleNames);

}

for (const moduleName of foundModuleNames) {

const moduleDir = combinePaths(nodeModulesDir, moduleName);

result.push({

moduleName,

moduleDir

});

}

}

}

return result;

function tryReadingPackageJson(filePath: string) {

try {

const fileText = tryReadFile(host, filePath);

return fileText ? JSON.parse(fileText) : undefined;

}

catch (e) {

return undefined;

}

}

function addPotentialPackageNames(dependencies: any, result: string[]) {

if (dependencies) {

for (const dep in dependencies) {

if (dependencies.hasOwnProperty(dep) && !startsWith(dep, "@types/")) {

result.push(dep);

}

}

}

}

}

function createCompletionEntryForModule(name: string, kind: ScriptElementKind, replacementSpan: TextSpan): CompletionEntry {

return { name, kind, kindModifiers: ScriptElementKindModifier.none, sortText: name, replacementSpan };

}

// Replace everything after the last directory seperator that appears

function getDirectoryFragmentTextSpan(text: string, textStart: number): TextSpan {

const index = text.lastIndexOf(directorySeparator);

const offset = index !== -1 ? index + 1 : 0;

return { start: textStart + offset, length: text.length - offset };

}

// Returns true if the path is explicitly relative to the script (i.e. relative to . or ..)

function isPathRelativeToScript(path: string) {

if (path && path.length >= 2 && path.charCodeAt(0) === CharacterCodes.dot) {

const slashIndex = path.length >= 3 && path.charCodeAt(1) === CharacterCodes.dot ? 2 : 1;

const slashCharCode = path.charCodeAt(slashIndex);

return slashCharCode === CharacterCodes.slash || slashCharCode === CharacterCodes.backslash;

}

return false;

}

function normalizeAndPreserveTrailingSlash(path: string) {

return hasTrailingDirectorySeparator(path) ? ensureTrailingDirectorySeparator(normalizePath(path)) : normalizePath(path);

}

/**

* Matches a triple slash reference directive with an incomplete string literal for its path. Used

* to determine if the caret is currently within the string literal and capture the literal fragment

* for completions.

* For example, this matches

*

* /// <reference path="fragment

*

* but not

*

* /// <reference path="fragment"

*/

const tripleSlashDirectiveFragmentRegex = /^(\/\/\/\s*<reference\s+(path|types)\s*=\s*(?:'|"))([^\3"]*)$/;

interface VisibleModuleInfo {

moduleName: string;

moduleDir: string;

}

const nodeModulesDependencyKeys = ["dependencies", "devDependencies", "peerDependencies", "optionalDependencies"];

function tryGetDirectories(host: LanguageServiceHost, directoryName: string): string[] {

return tryIOAndConsumeErrors(host, host.getDirectories, directoryName);

}

function tryReadDirectory(host: LanguageServiceHost, path: string, extensions?: ReadonlyArray<string>, exclude?: ReadonlyArray<string>, include?: ReadonlyArray<string>): string[] | undefined {

return tryIOAndConsumeErrors(host, host.readDirectory, path, extensions, exclude, include);

}

function tryReadFile(host: LanguageServiceHost, path: string): string {

return tryIOAndConsumeErrors(host, host.readFile, path);

}

function tryFileExists(host: LanguageServiceHost, path: string): boolean {

return tryIOAndConsumeErrors(host, host.fileExists, path);

}

function tryDirectoryExists(host: LanguageServiceHost, path: string): boolean {

try {

return directoryProbablyExists(path, host);

}

catch { /*ignore*/ }

return undefined;

}

function tryIOAndConsumeErrors<T>(host: LanguageServiceHost, toApply: (...a: any[]) => T, ...args: any[]) {

try {

return toApply && toApply.apply(host, args);

}

catch { /*ignore*/ }

return undefined;

}

}