create-jxa-app
v0.0.16
Create MacOS Javascript for Automation (JXA) Apps with no build configuration.
9/weekUpdated 3 years agobsd-2-clauseUnpacked: 225.0 KB
Published by Andreas Heissenberger
npm install create-jxa-appCreate JXA App
Create JXA Apps and Command Line Scripts with no build configuration.
This Setup is only supported on MacOS > 10.11.
If something doesn’t work, please file an issue.
If you have questions or need help, please ask in GitHub Discussions.
Quick Overview
``sh`
npx creat-jxa-app my-app
cd my-app
npm start
The compiled MacOs App is created in the build folder and can be started.
Creating an App
You’ll need to have Node 10.16.0 or later version on your local development machine (but it’s not required on the server). We recommend using the latest LTS version. Only MacOS is supported.
To create a new app, you may choose one of the following methods:
$3
`sh`
npx creat-jxa-app my-app
_(npx is a package runner tool that comes with npm 5.2+ and higher, see instructions for older npm versions)_
$3
`sh`
npm init jxa-app my-app
_ is available in npm 6+_
$3
`sh`
yarn create jxa-app my-app
_ is available in Yarn 0.25+_
It will create a directory called my-app inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:
`
my-app
├── README.md
├── node_modules
├── package.json
├── .gitignore
├── build
└── src
├── index.js
`
No configuration or complicated folder structures, only the files you need to build your app.
Once the installation is done, you can open your project folder:
`sh`
cd my-app
Inside the newly created project, you can run some built-in commands:
$3
Runs the compiler in watch mode. Finale application is in build folder.
All libaries are bundled.
There is a sourcemap inlined for debugging and the sourcecode is not mangled or compressed.
$3
Runs jest with your tests.$3
Builds the app for production to the build folder.
It correctly bundles all external libaries in production mode and optimizes the build for the best performance. No sourcemap files and code is mangled and compressed.
Your app is ready to be deployed.
All CLI options
`
Description
Create a JXA App project setup
Usage
$ create-jxa-app [project_directory] [options]
Options
-template, --
--verbose print additional logs
--use-pnp use yarn plug-and-play manager
--use-npm use npm to install packages
-v, --version Displays current version
-h, --help Displays this message
``