The libraries and injections for JXA found in this repository originate in my personal automation needs. I have tried to keep them modular and generic enough to be useful outside the scenarios they were created for, but I never aimed for “standard library“ levels of completeness. This means new features will only be added when I need them, or if you contribute code for them.
Extensions of, or entirely new, libraries and injections are welcome as long as their philosophy and API blend with the existing set, and as long as they follow the coding standards outlined below.
APIs should be generic enough to be of use outside specialised situations. In design and documentation, they should strive to feel at home besides JS’ own (for an example, see Array.prototype.findLast). Where functionality mimics JS core functionality, it should do so faithfully, even if that means more complexity (for an example, see String.prototype.toLocaleCapitalizedForm).
All code must be written in JavaScript Standard Style; functionality must be documented with JSDoc tags. Please lint your code for both criteria before submitting, i.e. via ESLint (see below for configuration).
Standard’s and JXA’s rules for linting do not play well together out of the box. The easiest way to get them to is to do the following:
# Install ESLint to your project development dependencies:
npm install --save-dev eslint
# Install JXA ESLint configuration and the Standard configuration:
npm install --save-dev eslint-config-jxa
npm install --save-dev eslint-config-standard eslint-plugin-standard eslint-plugin-promise eslint-plugin-import eslint-plugin-node
# Install other ESLint plugin:
npm install --save-dev eslint-plugin-jsdoc
npm install --save-dev eslint-plugin-jsonThe repo contains an .eslintrc.json configuration file with the necessary overrides to handle JXA Infusion code gracefully.
There is an .editorconfig configuration file in the repo, which should help with the basic formatting and avoid manual editor configuration, if your editor supports EditorConfig (most seem to do, nowadays, or at least have a plugin that does).
I am not aware of any JS testing framework supporting JXA, so there are no automated tests to write. However, you should extensively run any of your contributions and try out how edge cases perform manually in the Script Editor.