Skip to content

Commit d54e12f

Browse files
author
Lucas Vogel
committed
2 parents be2f910 + e46d0a2 commit d54e12f

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
1-
# es2015-2-extendScript-build
1+
# extendscriptr
22

33
A [NPM](https://www.npmjs.com/) CLI to compile es2015 AMD code into an executable [ExtendScript](https://www.adobe.com/devnet/scripting.html)
44

5-
[![Join the chat at https://gitter.im/vogelino/es2015-2-extendScript-build](https://badges.gitter.im/vogelino/es2015-2-extendScript-build.svg)](https://gitter.im/vogelino/es2015-2-extendScript-build?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5+
[![Join the chat at https://gitter.im/vogelino/extendscriptr](https://badges.gitter.im/vogelino/extendscriptr.svg)](https://gitter.im/vogelino/extendscriptr?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
66

77
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/)
88

99
## Why
10-
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.
10+
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.~~
11+
12+
**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!
1113

1214
## Goal
1315
The wished workflow with this module can be resumed in a few steps:
1416

15-
- `npm install -g es2015-2-extendScript-build`
16-
- `es2015-2-extendScript-build --script src/scripts/helloWorld.js --output dist/helloWord.js`
17+
- `npm install -g extendscriptr`
18+
- `extendscriptr --script src/scripts/helloWorld.js --output dist/helloWord.js`
1719
- open the outputed file with ExtendScript Toolkit
1820
- run it
1921

20-
## Name
21-
The name `es2015-2-extendScript-build` is subject to modification. Stay tuned.
22-
2322
## Authors/Contributors
2423
- Lucas Vogel @vogelino
2524
- Fabian Morón Zirfas @fabiantheblind
@@ -29,7 +28,7 @@ We would be happy to have contributions from other members as well. Don't hesita
2928

3029
### Report issues
3130
Feel free to report any issue you would encounter using the module.
32-
https://github.com/vogelino/es2015-2-extendScript-build/issues
31+
https://github.com/vogelino/extendscriptr/issues
3332

3433
### License
3534
WTFPL - Do whatever the fuck you want

0 commit comments

Comments
 (0)