|
1 | 1 | # extendscriptr |
2 | 2 |
|
3 | | -[](https://badge.fury.io/js/extendscriptr) |
| 3 | +[](https://badge.fury.io/js/extendscriptr) [](https://gitter.im/vogelino/extendscriptr?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
4 | 4 |
|
5 | | -A [NPM](https://www.npmjs.com/) CLI to compile es2015 AMD code into an executable [ExtendScript](https://www.adobe.com/devnet/scripting.html) |
6 | | - |
7 | | -[](https://gitter.im/vogelino/extendscriptr?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
8 | | - |
9 | | -NOTE: This is a work in progress - Star this project and stay tuned, we will announce it when it will be working and available on [npmjs.org](https://www.npmjs.com/) |
| 5 | +Extendscriptr is NPM CLI module that allows you to benefit of many modern javascript features of es5 and es6 in a es3 extendscript environment. |
10 | 6 |
|
11 | 7 | ## Why |
12 | | -Building scripts for Adobe products (mostly used for After Effects, InDesign, Photoshop or Illustrator) can be pain for the finger nails if you are used to proper javascript environments. ~~With this CLI node module, you will be able to write AMD javascript code in its most recent version ([ECMAScript® 2015](http://www.ecma-international.org/ecma-262/6.0/)) and compile it into an Adobe-compatible format.~~ |
| 8 | +Building scripts for Adobe products (mostly used for After Effects, InDesign, Photoshop or Illustrator) can be pain for the finger nails if you are used to proper javascript environments. |
| 9 | + |
| 10 | +Extendscriptr relays on [`extendscript.prototypes`](https://github.com/fabiantheblind/extendscript.prototypes) and focuses on mostly used prototypes as a priority that are tested in the different Adobe applications. This dependency will be improved over time to covers always more es5 and es6 features. Contributions are welcome! |
13 | 11 |
|
14 | | -**Edit:** Extendscriptr won't let you use all features of es2015 as existing polyfills cannot be used in this project. In fact, polyfills like `babel-polyfill`, `es5-shim` or `shim.js` are intended for the browser and don't work well in adobe applications. Therefor, extendscriptr will relay on [`extendscript.prototypes`](https://github.com/fabiantheblind/extendscript.prototypes) which focuses on mostly used prototypes as a priority and will be tested in the different Adobe applications. This dependency will be improved over time to covers always more es5 and es6 features. Contributions are welcome! |
| 12 | +Extendscriptr doesn't use an existing full-stack polyfills like `babel-polyfill`, `es5-shim` or `shim.js` as they are intended for the browser and don't work well in adobe applications. |
15 | 13 |
|
16 | | -## Goal |
17 | | -The wished workflow with this module can be resumed in a few steps: |
18 | 14 |
|
| 15 | +## Usage |
19 | 16 | - `npm install -g extendscriptr` |
20 | 17 | - `extendscriptr --script src/scripts/helloWorld.js --output dist/helloWord.js` |
21 | | -- open the outputed file with ExtendScript Toolkit |
| 18 | +- open the outputed file with ExtendScript Toolkit OR place your script in the relevant application script folder |
22 | 19 | - run it |
23 | 20 |
|
24 | 21 | ## Authors/Contributors |
|
0 commit comments