is-executable 1.0.1 → 2.0.0

package/index.d.ts

@@ -0,0 +1,47 @@
+/**
+Check whether a file can be executed.
+
+@param filePath - The file to check.
+
+@example
+```
+import {isExecutable} from 'is-executable';
+
+// On macOS
+await isExecutable('/usr/bin/bash');
+//=> true
+
+// On macOS
+await isExecutable('/Users/sindresorhus/unicorn.png');
+//=> false
+
+// On Windows
+await isExecutable('c:\\Windows\\notepad.exe');
+//=> true
+```
+*/
+export function isExecutable(filePath: string): Promise<boolean>;
+
+/**
+Check whether a file can be executed.
+
+@param filePath - The file to check.
+
+@example
+```
+import {isExecutableSync} from 'is-executable';
+
+// On macOS
+isExecutableSync('/usr/bin/bash');
+//=> true
+
+// On macOS
+isExecutableSync('/Users/sindresorhus/unicorn.png');
+//=> false
+
+// On Windows
+isExecutableSync('c:\\Windows\\notepad.exe');
+//=> true
+```
+*/
+export function isExecutableSync(filePath: string): boolean;

package/index.js

@@ -1,41 +1,25 @@
-'use strict';
+import process from 'node:process';
+import path from 'node:path';
+import fs from 'node:fs';
+import fsPromises from 'node:fs/promises';
 
-var os = require('os');
-var path = require('path');
+const isWindows = process.platform === 'win32';
+const pathExts = isWindows ? new Set(process.env.PATHEXT?.split(';').map(pathExt => pathExt.toLowerCase())) : [];
 
-var fs = require('graceful-fs');
+export async function isExecutable(filePath) {
+	try {
+		await fsPromises.access(filePath, fs.X_OK);
+		return isWindows ? pathExts.has(path.extname(filePath)) : true;
+	} catch {
+		return false;
+	}
+}
 
-var isWindows = os.type().indexOf('Windows') === 0;
-
-var pathExts = !isWindows ? [] : (function () {
-  /* eslint-disable no-process-env */ // need this for cross-platform use
-  return (process.env.PATHEXT || '').split(';').map(function (pathExt) {
-    return pathExt.toLowerCase();
-  });
-  /* eslint-enable no-process-env */
-}());
-
-module.exports = function isExe (filePath) {
-  return new Promise(function (resolve) {
-    fs.access(filePath, fs.X_OK, function (err) {
-      if (err) {
-        resolve(false);
-        return;
-      }
-      if (isWindows) {
-        resolve(pathExts.indexOf(path.extname(filePath)) !== -1);
-        return;
-      }
-      resolve(true);
-    });
-  });
-};
-
-module.exports.sync = function isExeSync (filePath) {
-  try {
-    fs.accessSync(filePath, fs.X_OK);
-    return !isWindows ? true : pathExts.indexOf(path.extname(filePath)) !== -1;
-  } catch (err) {
-    return false;
-  }
-};
+export function isExecutableSync(filePath) {
+	try {
+		fs.accessSync(filePath, fs.X_OK);
+		return isWindows ? pathExts.has(path.extname(filePath)) : true;
+	} catch {
+		return false;
+	}
+}

package/license

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+Copyright (c) Ron Waldon
+
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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.

package/package.json

@@ -1,43 +1,37 @@
 {
-  "name": "is-executable",
-  "description": "cross-platform helper to determine whether a file can be executed",
-  "version": "1.0.1",
-  "bugs": {
-    "url": "https://github.com/jokeyrhyme/is-executable.js/issues"
-  },
-  "dependencies": {
-    "graceful-fs": "4.1.2"
-  },
-  "devDependencies": {
-    "@jokeyrhyme/eslint-config-es2015": "1.0.0",
-    "@jokeyrhyme/eslint-config-es5": "^1.0.0",
-    "ava": "^0.7.0",
-    "eslint": "^1.10.3",
-    "eslint-config-semistandard": "^5.0.0",
-    "eslint-config-standard": "^4.4.0",
-    "eslint-plugin-standard": "^1.3.1",
-    "fixpack": "^2.2.0",
-    "npm-run-all": "^1.4.0"
-  },
-  "engines": {
-    "node": ">=4.0.0",
-    "npm": ">=3.0.0"
-  },
-  "files": [
-    "index.js"
-  ],
-  "homepage": "https://github.com/jokeyrhyme/is-executable.js#readme",
-  "keywords": [],
-  "license": "BSD-2-Clause",
-  "main": "index.js",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/jokeyrhyme/is-executable.js.git"
-  },
-  "scripts": {
-    "eslint": "eslint --fix .",
-    "fixpack": "fixpack",
-    "posttest": "npm-run-all eslint fixpack",
-    "test": "ava"
-  }
+	"name": "is-executable",
+	"version": "2.0.0",
+	"description": "Check whether a file can be executed",
+	"license": "MIT",
+	"repository": "sindresorhus/is-executable",
+	"funding": "https://github.com/sponsors/sindresorhus",
+	"type": "module",
+	"exports": "./index.js",
+	"engines": {
+		"node": "=>14.16"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"executable",
+		"execute",
+		"exe",
+		"file",
+		"binary",
+		"check",
+		"detect",
+		"access",
+		"fs",
+		"permission"
+	],
+	"devDependencies": {
+		"ava": "^4.3.3",
+		"tsd": "^0.24.1",
+		"xo": "^0.52.4"
+	}
 }

package/readme.md

@@ -0,0 +1,33 @@
+# is-executable
+
+> Check whether a file can be [executed](https://www.yesik.it/blog/2018-the-x-permission-bit)
+
+## Install
+
+```sh
+npm install is-executable
+```
+
+## Usage
+
+```js
+import {isExecutable} from 'is-executable';
+
+// On macOS
+await isExecutable('/usr/bin/bash');
+//=> true
+
+// On macOS
+await isExecutable('/Users/sindresorhus/unicorn.png');
+//=> false
+
+// On Windows
+await isExecutable('c:\\Windows\\notepad.exe');
+//=> true
+```
+
+## API
+
+### `isExecutable(filePath: string) => Promise<boolean>`
+
+### `isExecutableSync(filePath: string) => boolean`

package/LICENSE

@@ -1,24 +0,0 @@
-Copyright (c) 2015, Ron Waldon
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-

package/README.md

@@ -1,31 +0,0 @@
-# is-executable.js
-
-cross-platform helper to determine whether a file can be executed
-
-[![npm module](https://img.shields.io/npm/v/is-executable.svg)](https://www.npmjs.com/package/is-executable)
-[![Build Status](https://travis-ci.org/jokeyrhyme/is-executable.js.png)](https://travis-ci.org/jokeyrhyme/is-executable.js)
-[![Build status](https://ci.appveyor.com/api/projects/status/bbip8ej03e57p3e2/branch/master?svg=true)](https://ci.appveyor.com/project/jokeyrhyme/is-executable-js/branch/master)
-
-
-## Why?
-
-Node.js' built-in [`fs.access()`](https://nodejs.org/dist/latest-v5.x/docs/api/fs.html#fs_fs_access_path_mode_callback) is not useful enough for Windows use cases.
-
-
-## Usage
-
-```js
-const isExe = require('is-executable');
-
-isExe.sync('c:\\Windows\\notepad.exe'); // => true on Windows
-isExe.sync('/usr/bin/bash'); // => true on OS X / Linux
-```
-
-
-## API
-
-
-### isExe (filePath: String) => Promise
-
-
-### isExe.sync (filePath: String) => Boolean