├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.d.ts ├── index.js ├── index.test-d.ts ├── license ├── package.json ├── readme.md └── test.js /.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: macos-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 14 14 | - 12 15 | steps: 16 | - uses: actions/checkout@v2 17 | - uses: actions/setup-node@v2 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 an app exists on macOS. 3 | 4 | @param bundleIdOrName - The [bundle ID](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier) or name of the app. Prefer specifying bundle ID whenever possible as it's more unique. 5 | 6 | @example 7 | ``` 8 | import appExists from 'app-exists'; 9 | 10 | console.log(await appExists('com.sindresorhus.Gifski')); 11 | //=> true 12 | 13 | console.log(await appExists('Gifski')); 14 | //=> true 15 | 16 | console.log(await appExists('com.sindresorhus.UnicornCakeFun')); 17 | //=> false 18 | ``` 19 | */ 20 | export default function appExists(bundleIdOrName: string): Promise; 21 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import {homedir} from 'os'; 2 | import path from 'path'; 3 | import {promisify} from 'util'; 4 | import {execFile} from 'child_process'; 5 | 6 | const execFileP = promisify(execFile); 7 | 8 | export default async function appExists(nameOrBundleId) { 9 | const isBundleId = nameOrBundleId.includes('.'); 10 | 11 | const paths = [ 12 | '/Applications', 13 | path.join(homedir(), 'Applications') 14 | ]; 15 | 16 | const pathArgs = paths.flatMap(path => ['-onlyin', path]); 17 | 18 | const query = isBundleId ? 19 | `kMDItemContentType == 'com.apple.application-bundle' && kMDItemCFBundleIdentifier == '${nameOrBundleId}'` : 20 | `kMDItemKind == 'Application' && kMDItemFSName == '${nameOrBundleId}.app'`; 21 | 22 | const {stdout: appPath} = await execFileP('mdfind', [query, ...pathArgs]); 23 | 24 | return Boolean(appPath); 25 | } 26 | -------------------------------------------------------------------------------- /index.test-d.ts: -------------------------------------------------------------------------------- 1 | import {expectType} from 'tsd'; 2 | import appExists from './index.js'; 3 | 4 | expectType>(appExists('com.sindresorhus.Gifski')); 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": "app-exists", 3 | "version": "2.1.1", 4 | "description": "Check if an app exists on macOS", 5 | "license": "MIT", 6 | "repository": "sindresorhus/app-exists", 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": "./index.js", 15 | "engines": { 16 | "node": ">=12" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava && tsd" 20 | }, 21 | "files": [ 22 | "index.js", 23 | "index.d.ts" 24 | ], 25 | "keywords": [ 26 | "macos", 27 | "app", 28 | "exists", 29 | "applescript", 30 | "bundle", 31 | "bundleid", 32 | "id", 33 | "identifier" 34 | ], 35 | "devDependencies": { 36 | "ava": "^3.15.0", 37 | "tsd": "^0.14.0", 38 | "xo": "^0.38.2" 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # app-exists 2 | 3 | > Check if an app exists on macOS 4 | 5 | ## Install 6 | 7 | ``` 8 | $ npm install app-exists 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | import appExists from 'app-exists'; 15 | 16 | console.log(await appExists('com.sindresorhus.Gifski')); 17 | //=> true 18 | 19 | console.log(await appExists('Gifski')); 20 | //=> true 21 | 22 | console.log(await appExists('com.sindresorhus.UnicornCakeFun')); 23 | //=> false 24 | ``` 25 | 26 | ## API 27 | 28 | ### appExists(bundleIdOrName) 29 | 30 | Returns a `Promise` of whether the app exists on the user's system. 31 | 32 | #### bundleIdOrName 33 | 34 | The [bundle ID](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier) or name of the app. 35 | 36 | Prefer specifying bundle ID whenever possible as it's more unique. 37 | 38 | ## Related 39 | 40 | - [file-icon](https://github.com/sindresorhus/file-icon) - Get the icon of a file or app as a PNG image 41 | - [bundle-name](https://github.com/sindresorhus/bundle-name) - Get bundle name from a bundle identifier 42 | - [bundle-id](https://github.com/sindresorhus/bundle-id) - Get bundle identifier from a bundle name 43 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import appExists from './index.js'; 3 | 4 | test('bundle ID', async t => { 5 | t.true(await appExists('com.apple.Safari')); 6 | t.false(await appExists('com.foo.bar')); 7 | }); 8 | 9 | test('name', async t => { 10 | t.true(await appExists('Safari')); 11 | t.false(await appExists('FooBar')); 12 | }); 13 | --------------------------------------------------------------------------------