Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milewski/generator-exporter
Automate the 'Image Assets' menu, easy to integrate into any CI pipeline.
https://github.com/milewski/generator-exporter
assets automation ci extract generator photoshop pipeline
Last synced: 18 days ago
JSON representation
Automate the 'Image Assets' menu, easy to integrate into any CI pipeline.
- Host: GitHub
- URL: https://github.com/milewski/generator-exporter
- Owner: milewski
- License: mit
- Created: 2017-03-04T09:32:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-29T12:16:56.000Z (over 1 year ago)
- Last Synced: 2024-10-16T06:41:53.260Z (30 days ago)
- Topics: assets, automation, ci, extract, generator, photoshop, pipeline
- Language: TypeScript
- Homepage:
- Size: 4.07 MB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Photoshop Assets Generator
[](https://badge.fury.io/js/generator-exporter)
[](https://www.npmjs.com/package/generator-exporter)
Automate the extraction of photoshop assets using the **GENERATOR PLUGIN**,
[here you can find a detailed explanation](https://github.com/adobe-photoshop/generator-assets/wiki/Generate-Web-Assets-Functional-Spec#getting-started) on how you should name your layers in order for this library to work.
What this lib will do for you:
- Automatically launch photoshop
- Open a given array of files
- Activate the Generator Assets Plugin
- Close all documents after all assets has been generated, and optionally close photoshop.
Perfect for CI (**Continuous Integration**) _This was the reason i built this anyway._
## Why do i need this?
If you are developing something that grab some assets from a psd file, why not using the the magic of assets generation to streamline your pipeline? so then you don't have to export your assets every time you make some changes, and even better, if you are working with some kind of CI (Jenkins, Bamboo, [Strider](https://github.com/Strider-CD/strider)....) you can automate the assets extraction process!
## Requirements
**You must have photoshop installed in your local machine in order to this lib to work.**
In photoshop's preferences go to plug-ins and make sure **Enable Generator** and **Enable Remote Connections** are checked.
Pick any **Service Name** you like, and input a **Password** (this lib defaults to 123456).
## Install
```bash
npm install generator-exporter
```
#### Usage with Node
```js
import { Generator } from 'generator-exporter'
import * as glob from 'glob'
import * as path from 'path'
const files = glob.sync(
path.resolve(__dirname, '**/*.psd')
);
const generator = new Generator(files, {
password: '123456',
generatorOptions: {
'base-directory': path.resolve(__dirname, 'output')
}
})
generator.start().then(files => console.log(files));
```
#### Usage from Command Line
```bash
generator-cli --help
generator-cli --files 'source/**/*.psd' --exclude '**/*(references|temp)/**' --password 654321 -c false -g.base-directory output
```
## Config Options (OptionsInterface)
| Property | Default | Description |
|------------------ |----------- |-------------------------------------------------------------------------------------------------------------------------- |
| closePhotoshop | true | Terminate photoshop after execution. |
| hostname | 127.0.0.1 | The host the socket is listing to connections, defaults to your local IP. |
| password | 123456 | The generator's password set inside photoshop plugins section. |
| port | 49494 | Socket's port. |
| maxRetries | 10 | Max number of retries this library will try to make with photoshop before assume it's dead. |
| retryDelay | 5000 | Delay between each retry. |
| generatorOptions | { ... } | [See all the available options in here.](https://github.com/adobe-photoshop/generator-assets/wiki/Configuration-Options) |
## Api
```js
/** Create a Generator Instance **/
const generator = new Generator(string|string[], OptionsInterface)
/** Start Extraction **/
generator.start().then(files => {})
/** Self Explanatory **/
generator.closePhotoshop()
generator.closeActiveDocument()
generator.closeAllDocuments()
```
## License
[MIT](LICENSE)