-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GH-3736: Use the system Git in electron.
If Git does not exisit on the `PATH`, fall back to the embedded Git. Closes #3736. Signed-off-by: Akos Kitta <[email protected]>
- Loading branch information
Akos Kitta
committed
Dec 6, 2018
1 parent
f73263b
commit 98161c0
Showing
7 changed files
with
212 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
packages/git/src/electron-node/init/electron-git-init-module.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /******************************************************************************** | ||
| * Copyright (C) 2018 TypeFox and others. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License v. 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0. | ||
| * | ||
| * This Source Code may also be made available under the following Secondary | ||
| * Licenses when the conditions for such availability set forth in the Eclipse | ||
| * Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
| * with the GNU Classpath Exception which is available at | ||
| * https://www.gnu.org/software/classpath/license.html. | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
| ********************************************************************************/ | ||
|
|
||
| import { ContainerModule } from 'inversify'; | ||
| import { GitInit } from '../../node/init/git-init'; | ||
| import { ElectronGitInit } from './electron-git-init'; | ||
|
|
||
| export default new ContainerModule(bind => { | ||
| bind(ElectronGitInit).toSelf(); | ||
| bind(GitInit).toService(ElectronGitInit); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| /******************************************************************************** | ||
| * Copyright (C) 2018 TypeFox and others. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License v. 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0. | ||
| * | ||
| * This Source Code may also be made available under the following Secondary | ||
| * Licenses when the conditions for such availability set forth in the Eclipse | ||
| * Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
| * with the GNU Classpath Exception which is available at | ||
| * https://www.gnu.org/software/classpath/license.html. | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
| ********************************************************************************/ | ||
|
|
||
| import { inject, injectable } from 'inversify'; | ||
| import findGit from 'find-git-exec'; | ||
| import { dirname } from 'path'; | ||
| import { pathExists } from 'fs-extra'; | ||
| import { MessageService } from '@theia/core/lib/common/message-service'; | ||
| import { ILogger } from '@theia/core/lib/common/logger'; | ||
| import { DefaultGitInit } from '../../node/init/git-init'; | ||
|
|
||
| /** | ||
| * The Git initializer for electron. If Git can be found on the `PATH`, it will be used instead of the embedded Git shipped with `dugite`. | ||
| */ | ||
| @injectable() | ||
| export class ElectronGitInit extends DefaultGitInit { | ||
|
|
||
| @inject(ILogger) | ||
| protected readonly logger: ILogger; | ||
|
|
||
| @inject(MessageService) | ||
| protected readonly messageService: MessageService; | ||
|
|
||
| async init(): Promise<void> { | ||
| const { env } = process; | ||
| if (typeof env.LOCAL_GIT_DIRECTORY !== 'undefined' || typeof env.GIT_EXEC_PATH !== 'undefined') { | ||
| await this.handleExternalNotFound('Cannot use Git from the PATH when the LOCAL_GIT_DIRECTORY or the GIT_EXEC_PATH environment variables are set.'); | ||
| } else { | ||
| try { | ||
| const { execPath, path, version } = await findGit(); | ||
| if (!!execPath && !!path && !!version) { | ||
| // https:/desktop/dugite/issues/111#issuecomment-323222834 | ||
| // Instead of the executable path, we need the root directory of Git. | ||
| const dir = dirname(dirname(path)); | ||
| const [execPathOk, pathOk, dirOk] = await Promise.all([pathExists(execPath), pathExists(path), pathExists(dir)]); | ||
| if (execPathOk && pathOk && dirOk) { | ||
| process.env.LOCAL_GIT_DIRECTORY = dir; | ||
| process.env.GIT_EXEC_PATH = execPath; | ||
| this.logger.info(`Using Git [${version}] from the PATH. (${path})`); | ||
| return; | ||
| } | ||
| } | ||
| await this.handleExternalNotFound(); | ||
| } catch (err) { | ||
| await this.handleExternalNotFound(err); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // tslint:disable-next-line:no-any | ||
| protected async handleExternalNotFound(err?: any): Promise<void> { | ||
| if (err) { | ||
| this.logger.error(err); | ||
| } | ||
| this.logger.info('Could not find Git on the PATH. Falling back to the embedded Git.'); | ||
| } | ||
| // LOCAL_GIT_DIRECTORY | ||
| // GIT_EXEC_PATH | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| /******************************************************************************** | ||
| * Copyright (C) 2018 TypeFox and others. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License v. 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0. | ||
| * | ||
| * This Source Code may also be made available under the following Secondary | ||
| * Licenses when the conditions for such availability set forth in the Eclipse | ||
| * Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
| * with the GNU Classpath Exception which is available at | ||
| * https://www.gnu.org/software/classpath/license.html. | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
| ********************************************************************************/ | ||
|
|
||
| import { ContainerModule } from 'inversify'; | ||
| import { GitInit, DefaultGitInit } from './git-init'; | ||
|
|
||
| export default new ContainerModule(bind => { | ||
| bind(DefaultGitInit).toSelf(); | ||
| bind(GitInit).toService(DefaultGitInit); | ||
| }); |
Oops, something went wrong.