Skip to content

usage.md

Latest commit

 

History

History
100 lines (76 loc) · 3.13 KB

usage.md

File metadata and controls

100 lines (76 loc) · 3.13 KB

Usage

Prerequisites

Gizmo requires yeoman, gulp and bower:
npm install -g yo gulp bower
Install generator-gizmo:
npm install -g generator-gizmo

Creating your project

  • Be sure you are in your extension directory.
  • Windows: C:\Program Files (x86)\Common Files\Adobe\CEP\extensions
  • Mac: /Library/Application Support/Adobe/CEP/extensions
Create a new directory, and go into:
mkdir my_extension && cd $_
Run yo gizmo, and follow the prompts:
yo gizmo

Building your extension

Gizmo should auto-download your dependencies. If it fails for some reason, be sure to install them with the following command.

npm install && bower install

Run the following command(s), and your zxp will be in placed in the build directory

gulp cert && gulp build

You only need to run the cert task once. The build command will bootstrap your project, build the bundle, generator CSS, and inject dependencies onto your index.

Congrats! Open Photoshop to see your extension.

Gulp Tasks

  • gulp or gulp help - Show a list of all available tasks
  • gulp build - Build your ZXP file. Requires a certificate to be generated with gulp cert.
  • gulp cert - Generates a certificate for signing in your bin folder. You should only run this when you need to update your certificate.
  • gulp hint - Run JSHint against your source files.
  • gulp sass - Build your SASS files.
  • gulp watch - Watch various source files and re-run tasks depending on what changes.
  • gulp webpack - Compile your webpack bundle from all sources in your /app/ directory.
  • gulp wire - Wires all files to your index.html.

F.A.Q.

CLI Questions

  • Name - Defaults to the name of the active directory. This will be used to populate your manifest, bower, and package files.
  • Version - The version of your app. Expects and defaults to semantic versioning.
  • Decscription - Used to populate your bower file.
  • Author's name - Used in the package file.
  • Company name - Used for the signing of your certificate and extension compiling.
  • Country - Used for the signing of your certificate and extension compiling.
  • State/province - Used for the signing of your certificate and extension compiling.
  • License - Used in your package and bower files.

Certification

The gulp cert task will generate a self-signed certificate with zxp-sign-cmd. If you would like to utilize your own certificate instead, simply update the path to it in your gulpfile as the variable "certPath".

Backwards-compatibility

If you would like to generate extensions for Photoshop CC 15.0 or older, please use gizmo v0.0.9 or lower. 0.1.0+ are for Photoshop CC 2015.5+

Debugging your extension

By default, go to http://localhost:2001 when your extension is running. If you would like to use a different port, edit the generated .debug file.

Polyfills

Gizmo provides minified and tested polyfills for the following:

  • JSON.stringify
  • JSON.parse
  • Date.now
  • Date.toISOString
  • Object.create
  • Array.forEach
  • Array.isArray
  • Array.every
  • Array.filter
  • Array.indexOf
  • Array.lastIndexOf
  • Array.map
  • Array.reduce
  • Array.some