Giter Club home page Giter Club logo

bastieneichenberger / extendscript-library Goto Github PK

View Code? Open in Web Editor NEW
65.0 13.0 12.0 27.22 MB

ExtendScript-library is a JavaScript library. This library has been created in order to support people who'd like write automation scripts for Adobe Creative Suite

Home Page: www.extendscript-library.org

License: BSD 2-Clause "Simplified" License

JavaScript 100.00%
extendscript indesign illustrator photoshop extendscript-library javascript adobe

extendscript-library's Introduction

extendscript-library.org

This library is under active development.

For more information go to our website extendscript-library.org!

Architecture:

packages

  1. lib
  • helper (modules with functionality that could be use in other apps)
  • illustrator (modules for illustrator including the common packages)
  • indesign (modules for indesign including the common packages)
  • photoshop (modules for photoshop including the common packages)

Use the library

Include the library

//if you use photoshop lib -> add the target photoshop
//you can use the @include syntax to use extendscript in an other IDE without error

//@target "photoshop"
//@include "../../../../../../lib/photoshop/photoshop-lib.jsx"


Contribute

Install node js

// install node modules for the documentation
cd your_extendscript-library.org_directory
sudo npm install

// install node modules for the tests
cd your_extendscript-library.org_directory/tests
sudo npm install

Generate the documentation

Use jsdoc3 to generate the documentation

cd your_extendscript-library.org_directory
./node_modules/.bin/jsdoc lib/* -c conf.json documentation/doc.md -d documentation/html_doc

Tests

Create a config.js file under your_extendscript-library.org_directory/tests/config.js. You can use the exemple.config.js file, just change the name to config.js. Use grunt to run units tests. Make sure that you have the Creative Suite CC installed. Otherwise you can change the config file:

var config = {};
config.app = {};

config.app.photoshop = 'Adobe Photoshop CS6'; // Adobe Photoshop CC 2014
config.app.indesign = 'Adobe InDesign CS6'; // Adobe InDesign CC 2014
config.app.illustrator = 'Adobe Illustrator CS6'; // Adobe Illustrator CC 2014

module.exports = config;

Run the tests

Create a config.js file under your_extendscript-library.org_directory/tests/config.js. You can use the exemple.config.js file, just change the name to config.js.

cd your_extendscript-library.org_directory/tests
grunt --verbose

Write tests

To write your own tests follow this section

IDE

If you don't like to use the ExtendScript Toolkit to write your scripts, you can use the excellent WebStorm IDE. If you will participate in this project you can write to me an email to receive a free open-source licence. First download WebStorm IDE here

Add autocompletion to WebStorm

If you would like to add the autocompletion in WebStorm you can follow this projet. Download precompiled libraries and setup WebStorm by the way described in the section "Documentation and autocomplete in IDEs"

Useful Resources

Tutorials

ExtendScript documentation

Others ressources

Grateful

Contributors

extendscript-library's People

Contributors

bastieneichenberger avatar siraj1983 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

extendscript-library's Issues

Pull requests

Hi All,
I see that there is only one branch to this repository. It feels weird for me to make a pull request on the master branch. Is there any thought to adding a development branch to the repository, or should pull requests be made against master.

lib>helper>utils>file.jsx

file.jsx overwrites extendscript native implementation of read() and write() methods and assumes UTF8 encoding on all File objects passed in as parameters.

Run the following with and with out the .read() library function. The native implementation returns the expected data.

var blob;
var bin = File('/c/path/to/some/binaryFile.bin');
bin.encoding = 'BINARY';
bin.open('r');
blob = bin.read();
bin.close();
alert(blob);

Suggest renaming .read() and .write() methods in lib.helper.utils.file.jsx to .readUTF8() and .writeUTF8() or something similar.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.