Function getPubPackageStatus

src/shared/vscode/pub.ts:115–212

(
	sdks: Sdks,
	logger: Logger,
	folderUri: Uri,
	includeDatesAndFullPaths = true,
	existsSync: (itemPath: string) => boolean = fs.existsSync,
	readFileSync: (itemPath: string) => string = (p) => fs.readFileSync(p, "utf8").toString(),
	mtimeSync: (itemPath: string) => Date = (p) => fs.statSync(p).mtime,
)

}

function getPubPackageStatus(
	sdks: Sdks,
	logger: Logger,
	folderUri: Uri,
	includeDatesAndFullPaths = true,
	existsSync: (itemPath: string) => boolean = fs.existsSync,
	readFileSync: (itemPath: string) => string = (p) => fs.readFileSync(p, "utf8").toString(),
	mtimeSync: (itemPath: string) => Date = (p) => fs.statSync(p).mtime,
): PubPackageStatus {
	const folder = fsPath(folderUri);
	const pubspecPath = path.join(folder, "pubspec.yaml");
	const pubspecLockPath = path.join(folder, "pubspec.lock");
	const packageMapPath = path.join(folder, ".dart_tool", "package_config.json");
	if (!folder || !existsSync(pubspecPath))
		return { folderUri, pubRequired: false, reason: "Folder or pubspec do not exist", workspace: "NONE" };

	const isValid = isValidPubGetTarget(folderUri);
	if (!isValid.valid)
		return { folderUri, pubRequired: false, reason: isValid.reason, workspace: "NONE" };

	const pubspecContent = readFileSync(pubspecPath);
	const hasDependencies = pubspecHasDependenciesRegex.test(pubspecContent);
	const isWorkspaceProject = pubspecIsWorkspaceProjectRegex.test(pubspecContent);
	const isWorkspaceRoot = pubspecIsWorkspaceRootRegex.test(pubspecContent);

	const result: Partial<PubPackageStatus> & { folderUri: Uri, workspace: string } = { folderUri, workspace: isWorkspaceRoot ? "ROOT" : isWorkspaceProject ? "PROJECT" : "NONE" };

	// If we don't appear to have deps listed in pubspec, then no point prompting.
	if (!isWorkspaceRoot && !hasDependencies)
		return { ...result, pubRequired: false, reason: "Pubspec does not contain any dependencies" };

	// If we are part of a pub workspace, we don't do anything, it's handled by the root.
	if (isWorkspaceProject)
		return { ...result, pubRequired: false, reason: "The project is part of a Pub workspace" };

	// If we don't have package_config, we probably need running.
	if (!existsSync(packageMapPath))
		return { ...result, pubRequired: "GET", reason: "The .dart_tool/package_config.json file is missing" };

	// If the Dart SDK version has upgraded by more than just a patch, we should
	// prefer upgrade.
	const lastUsedSdkVersion = getPubGeneratorVersion(logger, packageMapPath, existsSync, readFileSync);
	const currentSdkVersion = sdks.dartVersion;
	if (lastUsedSdkVersion && currentSdkVersion) {
		const lastUsedSdkMajorMinor = `${semver.major(lastUsedSdkVersion)}.${semver.minor(lastUsedSdkVersion)}.0`;
		const currentSdkMajorMinor = `${semver.major(currentSdkVersion)}.${semver.minor(currentSdkVersion)}.0`;

		logger.info(`Version last used for Pub is ${lastUsedSdkVersion} (${lastUsedSdkMajorMinor}), current is ${currentSdkVersion} (${currentSdkMajorMinor})`);
		// For an SDK upgrade, we want to encourage upgrading.
		if (semver.gt(currentSdkMajorMinor, lastUsedSdkMajorMinor))
			return { ...result, pubRequired: "UPGRADE", reason: `The current SDK version (${currentSdkVersion}) is newer than the one last used to run "pub get" (${lastUsedSdkVersion})` };
		// For a downgrade, Pub Get is enough to fix.
		else if (semver.lt(currentSdkMajorMinor, lastUsedSdkMajorMinor))
			return { ...result, pubRequired: "GET", reason: `The current SDK version (${currentSdkVersion}) is older than the one last used to run "pub get" (${lastUsedSdkVersion})` };
	}


	// Helpers for Date/Paths so that output is complete for production, but simplified for tests.