Merge pull request #8 from havardh/feat/npx-sdef-to-dfs

Feat/npx sdef to dfs

Author: azu

packages/@jxa/sdef-to-dts/README.md

@@ -8,7 +8,7 @@ Install with [npm](https://www.npmjs.com/):
 
     npm install @jxa/sdef-to-dts
 
-## Usage
+## Usage as library
 
 Convert `./input/*.sdef` file and output it as `d.ts` to `./output` directory.
 
@@ -31,6 +31,27 @@ Promise.all(promises).then(() => {
 });
 ```
 
+## Usage as command
+
+Convert application bundles (e.g. `/Applications/Safari.app`) and output as `d.ts`.
+
+```
+  Scripting definition files (sdefs) to TypeScript (d.ts)
+
+  Usage
+    $ npx @jxa/sdef-to-dts <input> --output <output>
+
+    <input>       path to an Application.app to read
+
+  Options
+    --output, -o  path to an Application.d.ts or a directory to write to
+    --version     show the version
+    --help        show this help page
+
+  Examples
+    $ npx @jxa/sdef-to-dts /Applications/Safari.app --output ./safari.d.ts
+```
+
 ## Running tests
 
     yarn test

packages/@jxa/sdef-to-dts/bin/cmd.js

@@ -0,0 +1,84 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+const path = require("path");
+const child_process = require("child_process");
+const transform = require("../lib/sdef-to-dts").transform;
+const meow = require("meow");
+const execa = require("execa");
+
+const cli = meow(`
+        Usage
+          $ npx @jxa/sdef-to-dts <input> --output <output>
+
+          <input>       path to an Application.app to read
+
+        Options
+          --output, -o  path to an Application.d.ts or a directory to write to
+          --version     show the version
+          --help        show this help page
+
+        Examples
+          $ npx @jxa/sdef-to-dts /Applications/Safari.app --output ./safari.d.ts
+`, {
+	flags: {
+		output: {
+			type: 'string',
+			alias: 'o'
+		}
+	},
+  autoVersion: true,
+  autoHelp: true
+});
+
+run(cli.input[0], cli.flags.output);
+
+function run(inPath, out) {
+  if (!inPath) {
+    console.error("Error: Missing output parameter.");
+    cli.showHelp();
+    process.exit(1);
+  }
+
+  const appName = path.basename(inPath, ".app").replace(/\s/g, "");
+  const outPath = outFile(appName, out);
+
+  const sdef = readSdef(inPath);
+  writeDTS(appName, outPath, sdef)
+    .then(() => {
+      console.log("Converted: " + inPath + " to " + outPath);
+    });
+}
+
+function outFile(appName, out) {
+  if (out) {
+    if (fs.existsSync(out) && fs.lstatSync(out).isDirectory()) {
+      return path.resolve(out, appName) + ".d.ts";
+    } else {
+      return path.resolve(out).replace(/.d.ts$/, "") + ".d.ts";
+    }
+  } else {
+    return path.resolve(appName) + ".d.ts";
+  }
+}
+
+function readSdef(path) {
+  try {
+    return execa.sync("sdef", [path], {stdio: ["ignore"]}).stdout;
+  } catch (e) {
+    console.error(e.toString());
+    cli.showHelp();
+    process.exit(2);
+  }
+}
+
+function writeDTS(appName, outPath, sdef) {
+  return transform(appName, sdef).then(content => {
+    fs.writeFileSync(outPath, content, "utf-8");
+  }).catch(err => {
+    console.error(err.toString());
+    cli.showHelp();
+    process.exit(3);
+  });
+}
+

packages/@jxa/sdef-to-dts/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jxa/sdef-to-dts",
   "version": "0.3.1",
-  "description": "Scripting definition files (sdefs) to TypeScript(d.ts)",
+  "description": "Scripting definition files (sdefs) to TypeScript (d.ts)",
   "keywords": [
     "applescript",
     "dts",
@@ -22,6 +22,7 @@
   ],
   "main": "lib/sdef-to-dts.js",
   "types": "lib/sdef-to-dts.d.ts",
+  "bin": "bin/cmd.js",
   "directories": {
     "lib": "lib",
     "test": "test"
@@ -62,9 +63,11 @@
     "@rgrove/parse-xml": "^1.1.1",
     "@types/camelcase": "^4.1.0",
     "camelcase": "^5.0.0",
+    "execa": "^1.0.0",
     "indent-string": "^3.2.0",
     "is-keyword": "^1.2.2",
     "is-var-name": "^2.0.0",
-    "json-schema-to-typescript": "^5.4.0"
+    "json-schema-to-typescript": "^5.4.0",
+    "meow": "^5.0.0"
   }
 }

yarn.lock

@@ -539,7 +539,7 @@ cross-spawn@^5.0.1, cross-spawn@^5.1.0:
     shebang-command "^1.2.0"
     which "^1.2.9"
 
-cross-spawn@^6.0.5:
+cross-spawn@^6.0.0, cross-spawn@^6.0.5:
   version "6.0.5"
   resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-6.0.5.tgz#4a5ec7c64dfae22c3a14124dbacdee846d80cbc4"
   dependencies:
@@ -628,6 +628,12 @@ duplexer@^0.1.1:
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/duplexer/-/duplexer-0.1.1.tgz#ace6ff808c1ce66b57d1ebf97977acb02334cfc1"
 
+end-of-stream@^1.1.0:
+  version "1.4.1"
+  resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.4.1.tgz#ed29634d19baba463b6ce6b80a37213eab71ec43"
+  dependencies:
+    once "^1.4.0"
+
 error-ex@^1.2.0, error-ex@^1.3.1:
   version "1.3.1"
   resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.1.tgz#f855a86ce61adc4e8621c3cda21e7a7612c3a8dc"
@@ -705,6 +711,18 @@ execa@^0.8.0:
     signal-exit "^3.0.0"
     strip-eof "^1.0.0"
 
+execa@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/execa/-/execa-1.0.0.tgz#c6236a5bb4df6d6f15e88e7f017798216749ddd8"
+  dependencies:
+    cross-spawn "^6.0.0"
+    get-stream "^4.0.0"
+    is-stream "^1.1.0"
+    npm-run-path "^2.0.0"
+    p-finally "^1.0.0"
+    signal-exit "^3.0.0"
+    strip-eof "^1.0.0"
+
 external-editor@^2.0.4:
   version "2.2.0"
   resolved "https://registry.yarnpkg.com/external-editor/-/external-editor-2.2.0.tgz#045511cfd8d133f3846673d1047c154e214ad3d5"
@@ -787,6 +805,12 @@ get-stream@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-3.0.0.tgz#8e943d1358dc37555054ecbe2edb05aa174ede14"
 
+get-stream@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-4.0.0.tgz#9e074cb898bd2b9ebabb445a1766d7f43576d977"
+  dependencies:
+    pump "^3.0.0"
+
 git-raw-commits@^1.3.0, git-raw-commits@^1.3.6:
   version "1.3.6"
   resolved "https://registry.yarnpkg.com/git-raw-commits/-/git-raw-commits-1.3.6.tgz#27c35a32a67777c1ecd412a239a6c19d71b95aff"
@@ -1335,6 +1359,20 @@ meow@^4.0.0:
     redent "^2.0.0"
     trim-newlines "^2.0.0"
 
+meow@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/meow/-/meow-5.0.0.tgz#dfc73d63a9afc714a5e371760eb5c88b91078aa4"
+  dependencies:
+    camelcase-keys "^4.0.0"
+    decamelize-keys "^1.0.0"
+    loud-rejection "^1.0.0"
+    minimist-options "^3.0.1"
+    normalize-package-data "^2.3.4"
+    read-pkg-up "^3.0.0"
+    redent "^2.0.0"
+    trim-newlines "^2.0.0"
+    yargs-parser "^10.0.0"
+
 mimic-fn@^1.0.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-1.2.0.tgz#820c86a39334640e99516928bd03fca88057d022"
@@ -1470,7 +1508,7 @@ object-assign@^4.0.1, object-assign@^4.1.0:
   version "4.1.1"
   resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863"
 
-once@^1.3.0:
+once@^1.3.0, once@^1.3.1, once@^1.4.0:
   version "1.4.0"
   resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1"
   dependencies:
@@ -1633,6 +1671,13 @@ pseudomap@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/pseudomap/-/pseudomap-1.0.2.tgz#f052a28da70e618917ef0a8ac34c1ae5a68286b3"
 
+pump@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.0.tgz#b4a2116815bde2f4e1ea602354e8c75565107a64"
+  dependencies:
+    end-of-stream "^1.1.0"
+    once "^1.3.1"
+
 q@^1.4.1, q@^1.5.1:
   version "1.5.1"
   resolved "https://registry.yarnpkg.com/q/-/q-1.5.1.tgz#7e32f75b41381291d04611f1bf14109ac00651d7"
@@ -2252,6 +2297,12 @@ yallist@^2.1.2:
   version "2.1.2"
   resolved "https://registry.yarnpkg.com/yallist/-/yallist-2.1.2.tgz#1c11f9218f076089a47dd512f93c6699a6a81d52"
 
+yargs-parser@^10.0.0:
+  version "10.1.0"
+  resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-10.1.0.tgz#7202265b89f7e9e9f2e5765e0fe735a905edbaa8"
+  dependencies:
+    camelcase "^4.1.0"
+
 yargs-parser@^7.0.0:
   version "7.0.0"
   resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-7.0.0.tgz#8d0ac42f16ea55debd332caf4c4038b3e3f5dfd9"