├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.d.ts ├── index.js ├── index.test-d.ts ├── license ├── package.json └── readme.md /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 20 14 | - 18 15 | steps: 16 | - uses: actions/checkout@v4 17 | - uses: actions/setup-node@v4 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - run: npm install 21 | - run: npm test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | Check if Electron is running in development. 3 | 4 | This package must be used from the Electron main process. 5 | 6 | You can force development mode by setting the `ELECTRON_IS_DEV` environment variable to `1`. 7 | 8 | @example 9 | ``` 10 | import isDev from 'electron-is-dev'; 11 | 12 | if (isDev) { 13 | console.log('Running in development'); 14 | } else { 15 | console.log('Running in production'); 16 | } 17 | ``` 18 | */ 19 | declare const isDev: boolean; 20 | 21 | export default isDev; 22 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import electron from 'electron'; 2 | 3 | if (typeof electron === 'string') { 4 | throw new TypeError('Not running in an Electron environment!'); 5 | } 6 | 7 | const {env} = process; // eslint-disable-line n/prefer-global/process 8 | const isEnvSet = 'ELECTRON_IS_DEV' in env; 9 | const getFromEnv = Number.parseInt(env.ELECTRON_IS_DEV, 10) === 1; 10 | 11 | const isDev = isEnvSet ? getFromEnv : !electron.app.isPackaged; 12 | 13 | export default isDev; 14 | -------------------------------------------------------------------------------- /index.test-d.ts: -------------------------------------------------------------------------------- 1 | import {expectType} from 'tsd'; 2 | import isDev from './index.js'; 3 | 4 | expectType(isDev); 5 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "electron-is-dev", 3 | "version": "3.0.1", 4 | "description": "Check if Electron is running in development", 5 | "license": "MIT", 6 | "repository": "sindresorhus/electron-is-dev", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": { 15 | "types": "./index.d.ts", 16 | "default": "./index.js" 17 | }, 18 | "sideEffects": false, 19 | "engines": { 20 | "node": ">=18" 21 | }, 22 | "scripts": { 23 | "test": "xo && tsd" 24 | }, 25 | "files": [ 26 | "index.js", 27 | "index.d.ts" 28 | ], 29 | "keywords": [ 30 | "electron", 31 | "dev", 32 | "development", 33 | "mode", 34 | "prod", 35 | "production", 36 | "detect", 37 | "check", 38 | "debug", 39 | "app" 40 | ], 41 | "devDependencies": { 42 | "tsd": "^0.30.3", 43 | "xo": "^0.56.0" 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # electron-is-dev 2 | 3 | > Check if [Electron](https://electronjs.org) is running in development 4 | 5 | Useful for enabling debug features only during development. 6 | 7 | This package must be used from the Electron main process. 8 | 9 | ## Install 10 | 11 | ```sh 12 | npm install electron-is-dev 13 | ``` 14 | 15 | *Requires Electron 28 or later.* 16 | 17 | ## Usage 18 | 19 | ```js 20 | import isDev from 'electron-is-dev'; 21 | 22 | if (isDev) { 23 | console.log('Running in development'); 24 | } else { 25 | console.log('Running in production'); 26 | } 27 | ``` 28 | 29 | You can force development mode by setting the `ELECTRON_IS_DEV` environment variable to `1`. 30 | 31 | ## FAQ 32 | 33 | ### How is this different than [`app.isPackaged`](https://www.electronjs.org/docs/api/app#appispackaged-readonly)? 34 | 35 | This package existed long before that property. The benefit of this package is that you can override the value using an environment variable. 36 | 37 | ### How do I use this in the renderer process? 38 | 39 | You can use [`contextBridge`](https://www.electronjs.org/docs/latest/api/context-bridge) in the [preload script](https://www.electronjs.org/docs/latest/tutorial/tutorial-preload) to manually expose the variable: 40 | 41 | ```js 42 | import {contextBridge} from 'electron'; 43 | import isDev from 'electron-is-dev'; 44 | 45 | contextBridge.exposeInMainWorld('isDev', isDev); 46 | ``` 47 | 48 | You can then access it in `globalThis` from the renderer process: 49 | 50 | ```js 51 | console.log(globalThis.isDev); 52 | ``` 53 | 54 | ## Related 55 | 56 | - [electron-util](https://github.com/sindresorhus/electron-util) - Useful utilities for developing Electron apps 57 | - [electron-debug](https://github.com/sindresorhus/electron-debug) - Adds useful debug features to your Electron app 58 | --------------------------------------------------------------------------------