:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS
Перейти к файлу
Darshan Sen 03e68e2efe
fix: fix a crash in `safeStorage` on Linux (#33913)
On Linux, `isEncryptionAvailable()` was crashing instead of returning a
boolean before the 'ready' event was emitted by the app. The reason of
the crash is that [`CreateKeyStorage()`](https://source.chromium.org/chromium/chromium/src/+/main:components/os_crypt/os_crypt_linux.cc;l=74;drc=35be6215ec8f09e50176f36753c68f26c63d1885;bpv=1;bpt=0)
expects the config to be set but the function responsible for setting the
config, [`SetConfig()`](https://source.chromium.org/chromium/chromium/src/+/main:components/os_crypt/os_crypt_linux.cc;l=237;drc=35be6215ec8f09e50176f36753c68f26c63d1885;bpv=1;bpt=0),
is called only after the app is ready inside [`PostCreateMainMessageLoop()`](https://github.com/electron/electron/blob/main/shell/browser/electron_browser_main_parts.cc#L499).
So this changes `IsEncryptionAvailable()` to return `false` when the app
is not ready on Linux and uses that instead of the raw API in other
places like `EncryptString()` and `DecryptString()`.

Fixes: https://github.com/electron/electron/issues/32206
Signed-off-by: Darshan Sen <raisinten@gmail.com>
2022-05-09 09:38:53 -04:00
.circleci build: change upload-to-s3 vars to upload-to-storage (#34105) 2022-05-09 09:34:17 -04:00
.devcontainer build: fix gclient config file 2021-08-16 10:56:29 -07:00
.github chore: use semantic-commit-action (#33857) 2022-04-20 16:49:59 -04:00
.husky chore: Update husky v6.0.0 (#28827) 2021-04-29 09:46:15 +02:00
build docs: note reason for is_cfi = false (#33749) 2022-04-12 21:00:03 -07:00
buildflags chore: remove deprecated remote module (#25734) 2021-03-09 17:12:40 -08:00
chromium_src chore: add missing GN dep (#33758) 2022-04-13 10:55:57 -07:00
default_app chore: update to latest TypeScript (#32596) 2022-01-31 20:37:40 +09:00
docs fix: fix a crash in `safeStorage` on Linux (#33913) 2022-05-09 09:38:53 -04:00
lib refactor: initialize member variables directly (#34046) 2022-05-04 16:30:05 +02:00
npm chore: update node types version (#33452) 2022-03-28 14:37:35 -07:00
patches fix: requestSingleInstanceLock API sometimes hangs (#33777) 2022-05-04 13:30:30 -04:00
script build: change upload-to-s3 vars to upload-to-storage (#34105) 2022-05-09 09:34:17 -04:00
shell fix: fix a crash in `safeStorage` on Linux (#33913) 2022-05-09 09:38:53 -04:00
spec test: fix nativeModulesEnabled in spec/webview-spec.js (#34027) 2022-05-03 23:56:45 -07:00
spec-main fix: fix a crash in `safeStorage` on Linux (#33913) 2022-05-09 09:38:53 -04:00
typings chore: update node types version (#33452) 2022-03-28 14:37:35 -07:00
.clang-format
.dockerignore build: remove unused install-build-deps (#26891) 2020-12-09 09:26:21 -08:00
.env.example build: do not require vsts token for releases (#28643) 2021-04-13 15:30:46 -07:00
.eslintrc.json chore: bump chromium to 102.0.4961.0 (main) (#33091) 2022-03-24 21:39:03 -04:00
.git-blame-ignore-revs chore: add ignore revs file for GH blame UI (#33171) 2022-03-07 18:40:28 -08:00
.gitattributes
.gitignore build: embed binary checksums in the npm package (#30611) 2021-08-19 11:26:17 -07:00
.markdownlint.autofix.json chore: use markdownlint to lint the docs (#26792) 2021-01-14 17:31:26 +09:00
.markdownlint.json fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
.nvmrc build: add nvmrc file (#30612) 2021-08-19 11:12:17 -07:00
.remarkrc
BUILD.gn build: improve CI speeds and reduce CI costs (#33904) 2022-04-26 23:14:59 -07:00
CODE_OF_CONDUCT.md docs: use asterisks for unordered lists (#26552) 2020-11-23 12:15:27 -05:00
CONTRIBUTING.md docs: Update Branch Name (#31106) 2021-09-27 11:35:56 -04:00
DEPS chore: bump chromium to 102.0.4999.0 (main) (#33731) 2022-04-22 15:36:22 -07:00
ELECTRON_VERSION Bump v20.0.0-nightly.20220509 2022-05-09 06:01:36 -07:00
LICENSE chore: update copyright headers (#27697) 2021-02-12 15:22:41 -08:00
README.md Update china npmmirror (#33401) 2022-03-24 20:08:33 -04:00
SECURITY.md docs: Update Branch Name (#31106) 2021-09-27 11:35:56 -04:00
appveyor.yml build: change upload-to-s3 vars to upload-to-storage (#34105) 2022-05-09 09:34:17 -04:00
azure-pipelines-arm.yml ci: enable arm64 macOS tests (#24832) 2021-01-21 18:36:52 -05:00
azure-pipelines-woa.yml chore: bump chromium to 100.0.4894.0 (main) (#32852) 2022-02-25 13:17:35 -05:00
electron_paks.gni fix: include accessibility blink strings (#33840) 2022-04-19 20:00:51 -07:00
electron_resources.grd chore: use //chrome resources directly (#33626) 2022-04-06 09:34:35 -07:00
filenames.auto.gni feat: Added missing info to IAP transaction and product structures (#31739) 2022-01-24 08:55:18 -08:00
filenames.gni fix: calling of X11 functions when running under Wayland (#33355) 2022-03-28 12:48:50 -04:00
filenames.hunspell.gni chore: bump chromium to 102.0.4961.0 (main) (#33091) 2022-03-24 21:39:03 -04:00
filenames.libcxx.gni chore: bump chromium to 94.0.4584.0 (main) (#30030) 2021-07-26 09:02:16 -07:00
filenames.libcxxabi.gni chore: bump chromium to 102.0.4961.0 (main) (#33091) 2022-03-24 21:39:03 -04:00
package.json Bump v20.0.0-nightly.20220509 2022-05-09 06:01:36 -07:00
tsconfig.default_app.json
tsconfig.electron.json
tsconfig.json chore: update to latest TypeScript, which has built-in WeakRef declarations (#27425) 2021-01-22 11:25:47 -08:00
tsconfig.script.json
tsconfig.spec.json chore: update to latest TypeScript (#32596) 2022-01-31 20:37:40 +09:00
vsts-arm-test-steps.yml chore: bump chromium to 92.0.4475.0 (master) (#28462) 2021-04-15 10:44:35 -07:00
vsts-arm32v7.yml build: add basic codespaces configuration (#30528) 2021-08-16 10:33:49 -07:00
vsts-arm64v8.yml build: add basic codespaces configuration (#30528) 2021-08-16 10:33:49 -07:00
yarn.lock build: upload to AZ as well as S3 (#33573) 2022-04-04 02:32:57 -07:00

README.md

Electron Logo

CircleCI Build Status AppVeyor Build Status Electron Discord Invite

📝 Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages at electron/i18n.

The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on Node.js and Chromium and is used by the Atom editor and many other apps.

Follow @ElectronJS on Twitter for important announcements.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to coc@electronjs.org.

Installation

To install prebuilt Electron binaries, use npm. The preferred method is to install Electron as a development dependency in your app:

npm install electron --save-dev

For more installation options and troubleshooting tips, see installation. For info on how to manage Electron versions in your apps, see Electron versioning.

Platform support

Each Electron release provides binaries for macOS, Windows, and Linux.

  • macOS (El Capitan and up): Electron provides 64-bit Intel and ARM binaries for macOS. Apple Silicon support was added in Electron 11.
  • Windows (Windows 7 and up): Electron provides ia32 (x86), x64 (amd64), and arm64 binaries for Windows. Windows on ARM support was added in Electron 5.0.8.
  • Linux: The prebuilt binaries of Electron are built on Ubuntu 20.04. They have also been verified to work on:
    • Ubuntu 14.04 and newer
    • Fedora 24 and newer
    • Debian 8 and newer

Quick start & Electron Fiddle

Use Electron Fiddle to build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and to try out different versions of Electron. It's designed to make the start of your journey with Electron easier.

Alternatively, clone and run the electron/electron-quick-start repository to see a minimal Electron app in action:

git clone https://github.com/electron/electron-quick-start
cd electron-quick-start
npm install
npm start

Resources for learning Electron

Programmatic usage

Most people use Electron from the command line, but if you require electron inside your Node app (not your Electron app) it will return the file path to the binary. Use this to spawn Electron from Node scripts:

const electron = require('electron')
const proc = require('child_process')

// will print something similar to /Users/maf/.../Electron
console.log(electron)

// spawn Electron
const child = proc.spawn(electron)

Mirrors

See the Advanced Installation Instructions to learn how to use a custom mirror.

Documentation translations

We crowdsource translations for our documentation via Crowdin. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, Russian, and Spanish.

Contributing

If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.

Community

Info on reporting bugs, getting help, finding third-party tools and sample apps, and more can be found on the Community page.

License

MIT

When using Electron logos, make sure to follow OpenJS Foundation Trademark Policy.