mac-helper 0.0.1

package/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

package/.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+
+lib
+dist

package/.eslintrc.yml

@@ -0,0 +1,18 @@
+# root
+root: true
+parser: '@typescript-eslint/parser'
+plugins: ['@typescript-eslint']
+
+env:
+  mocha: true
+  node: true
+
+extends:
+  - 'eslint:recommended'
+  - 'plugin:@typescript-eslint/recommended'
+  - 'prettier'
+
+rules:
+  '@typescript-eslint/ban-ts-comment': off
+  '@typescript-eslint/no-unused-vars': off
+  '@typescript-eslint/no-non-null-assertion': off

package/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: ci
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  unit-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: pnpm/action-setup@v2
+        with: { version: 7 }
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: 'pnpm'
+
+      - run: pnpm install
+
+      # test
+      - run: pnpm test-cover
+
+      # test:report
+      - uses: codecov/codecov-action@v3

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+pnpm lint-staged

package/.mocharc.yml

@@ -0,0 +1,4 @@
+require: [should]
+reporter: spec
+timeout: 5000
+recursive: true

package/.prettierignore

@@ -0,0 +1,4 @@
+node_modules
+
+lib
+dist

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## v0.0.1 2023-03-01
+
+- first release

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Magicdawn(magicdawn@qq.com)
+
+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/README.md

@@ -0,0 +1,29 @@
+# mac-helper
+
+> useful helper for macOS
+
+[![Build Status](https://img.shields.io/github/workflow/status/magicdawn/mac-helper/ci.yml?style=flat-square&branch=main)](https://github.com/magicdawn/mac-helper/actions/workflows/ci.yml)
+[![Coverage Status](https://img.shields.io/codecov/c/github/magicdawn/mac-helper.svg?style=flat-square)](https://codecov.io/gh/magicdawn/mac-helper)
+[![npm version](https://img.shields.io/npm/v/mac-helper.svg?style=flat-square)](https://www.npmjs.com/package/mac-helper)
+[![npm downloads](https://img.shields.io/npm/dm/mac-helper.svg?style=flat-square)](https://www.npmjs.com/package/mac-helper)
+[![npm license](https://img.shields.io/npm/l/mac-helper.svg?style=flat-square)](http://magicdawn.mit-license.org)
+
+## Install
+
+```sh
+$ pnpm add mac-helper
+```
+
+## API
+
+```js
+const MacHelper = require('mac-helper')
+```
+
+## Changelog
+
+[CHANGELOG.md](CHANGELOG.md)
+
+## License
+
+the MIT License http://magicdawn.mit-license.org

package/lib/index.d.ts

@@ -0,0 +1,8 @@
+import '@jxa/global-type';
+export declare function deprecated_getFinderSelectionViaAppleScript(): Promise<string>;
+export declare function getPathFinderSelect(): Promise<string | null>;
+export declare function getPathFinderSelects(): Promise<string[]>;
+export declare const PathFinder: {
+    singleSelected(): Promise<string | null>;
+    allSelected(): Promise<string[]>;
+};

package/lib/index.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathFinder = exports.getPathFinderSelects = exports.getPathFinderSelect = exports.deprecated_getFinderSelectionViaAppleScript = void 0;
+require("@jxa/global-type");
+const run_1 = require("@jxa/run");
+const applescript_1 = __importDefault(require("applescript"));
+const promise_ify_1 = __importDefault(require("promise.ify"));
+const SCRIPT_FI_SELECTION = `
+tell application "Path Finder"
+	get POSIX path of (get item 1 of (get selection))
+end tell
+`;
+async function deprecated_getFinderSelectionViaAppleScript() {
+    const result = (await (0, promise_ify_1.default)(applescript_1.default.execString, applescript_1.default)(SCRIPT_FI_SELECTION.trim()));
+    const url = result && result[0];
+    return url;
+}
+exports.deprecated_getFinderSelectionViaAppleScript = deprecated_getFinderSelectionViaAppleScript;
+async function getPathFinderSelect() {
+    const filePath = await (0, run_1.run)(() => {
+        const app = Application('Path Finder');
+        return app.selection()?.[0]?.posixPath() ?? null;
+    });
+    return filePath;
+}
+exports.getPathFinderSelect = getPathFinderSelect;
+async function getPathFinderSelects() {
+    const filePaths = await (0, run_1.run)(() => {
+        const app = Application('Path Finder');
+        return (app.selection() || []).map((x) => x?.posixPath());
+    });
+    return filePaths;
+}
+exports.getPathFinderSelects = getPathFinderSelects;
+exports.PathFinder = {
+    singleSelected() {
+        return getPathFinderSelect();
+    },
+    allSelected() {
+        return getPathFinderSelects();
+    },
+};
+// ;(async () => {
+//   console.log(await getPathFinderSelect())
+//   console.log(await getPathFinderSelects())
+// })()

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "mac-helper",
+  "version": "0.0.1",
+  "description": "useful helper for macOS",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "test": "mocha",
+    "prepare": "husky install",
+    "test-cover": "nyc --reporter=lcov --reporter=text mocha",
+    "dev": "tsc -w --incremental",
+    "build": "rm -rf lib; rm tsconfig.tsbuildinfo; tsc",
+    "prepublishOnly": "pnpm build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/magicdawn/mac-helper.git"
+  },
+  "keywords": [
+    "mac",
+    "helper",
+    "mac-helper"
+  ],
+  "author": "magicdawn",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/magicdawn/mac-helper/issues"
+  },
+  "homepage": "https://github.com/magicdawn/mac-helper#readme",
+  "devDependencies": {
+    "@magicdawn/prettier-config": "^0.0.2",
+    "@swc/core": "^1.3.19",
+    "@types/node": "^18.11.9",
+    "@typescript-eslint/eslint-plugin": "^5.44.0",
+    "@typescript-eslint/parser": "^5.44.0",
+    "eslint": "^8.28.0",
+    "eslint-config-prettier": "^8.5.0",
+    "husky": "^8.0.2",
+    "lint-staged": "^13.0.3",
+    "mocha": "^10.1.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.7.1",
+    "should": "^13.2.3",
+    "typescript": "^4.9.5"
+  },
+  "packageManager": "pnpm@7.17.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,less,md}": [
+      "prettier --write"
+    ]
+  },
+  "dependencies": {
+    "@jxa/global-type": "^1.3.6",
+    "@jxa/run": "^1.3.6",
+    "applescript": "^1.0.0",
+    "promise.ify": "^0.4.0"
+  }
+}

package/prettier.config.js

@@ -0,0 +1 @@
+module.exports = require('@magicdawn/prettier-config')

package/src/index.ts

@@ -0,0 +1,48 @@
+import '@jxa/global-type'
+import { run as jxaRun } from '@jxa/run'
+import AppleScript from 'applescript'
+import pify from 'promise.ify'
+
+const SCRIPT_FI_SELECTION = `
+tell application "Path Finder"
+	get POSIX path of (get item 1 of (get selection))
+end tell
+`
+export async function deprecated_getFinderSelectionViaAppleScript() {
+  const result = (await pify(
+    AppleScript.execString,
+    AppleScript
+  )(SCRIPT_FI_SELECTION.trim())) as string[]
+  const url = result && result[0]
+  return url
+}
+
+export async function getPathFinderSelect() {
+  const filePath: string | null = await jxaRun(() => {
+    const app = Application('Path Finder')
+    return app.selection()?.[0]?.posixPath() ?? null
+  })
+  return filePath
+}
+
+export async function getPathFinderSelects() {
+  const filePaths: string[] = await jxaRun(() => {
+    const app = Application('Path Finder')
+    return (app.selection() || []).map((x: any) => x?.posixPath())
+  })
+  return filePaths
+}
+
+export const PathFinder = {
+  singleSelected() {
+    return getPathFinderSelect()
+  },
+  allSelected() {
+    return getPathFinderSelects()
+  },
+}
+
+// ;(async () => {
+//   console.log(await getPathFinderSelect())
+//   console.log(await getPathFinderSelects())
+// })()

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "lib",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "target": "ES2020",
+    "module": "CommonJS",
+    "strictNullChecks": true,
+    "skipLibCheck": true,
+    "declaration": true
+  },
+  "ts-node": {
+    "swc": true
+  }
+}