https://github.com/adambrgmn/eslint-plugin-extendscript
Environment variables for Adobes Extendscript
https://github.com/adambrgmn/eslint-plugin-extendscript
eslint extendscript illustrator indesign photoshop scriptui
Last synced: 17 days ago
JSON representation
Environment variables for Adobes Extendscript
- Host: GitHub
- URL: https://github.com/adambrgmn/eslint-plugin-extendscript
- Owner: adambrgmn
- License: mit
- Created: 2017-12-01T15:03:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-01T02:17:34.000Z (over 7 years ago)
- Last Synced: 2025-08-09T05:48:03.604Z (7 months ago)
- Topics: eslint, extendscript, illustrator, indesign, photoshop, scriptui
- Language: JavaScript
- Homepage:
- Size: 341 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eslint Plugin ExtendScript
> Add environment globals for extendscript
## Table of Contents
* [Installation](#installation)
* [Setup](#setup)
* [Contributions](#contributions)
* [Contributors](#contributors)
* [License](#license)
## Installation
This module is distributed via [npm](https://www.npmjs.com/) which comes bundled
with [node](https://nodejs.org/). Install it as one of your projects
`devDependencies`.
```sh
# with npm
npm i --save-dev eslint-plugin-extendscript
# or with yarn
yarn add --dev eslint-plugin-extendscript
```
## Setup
Remember to first install [Eslint](https://eslint.org/) as well, otherwise this
plugin will be utterly useless!
Then define `extendscript` as one of the plugins inside `.eslintrc` and add the
environments you like.
```js
{
"extends": "eslint:recommended", // or any other presets
"plugins": ["extendscript"],
"env": {
"extendscript/base": true, // Basic suite available in all ExtendScript environments
"extendscript/scriptui": true, // ScriptUI globals
"extendscript/indesign": true, // InDesign globals
"extendscript/photoshop": true, // Photoshop globals
"extendscript/illustrator": true, // Illustrator globals
}
}
```
If you don't know or want to work on all environments you can use the
environment `"extendscript/extendscript"` instead. This will give you all
environment globals form all the ExtendScript environments.
```js
{
"extends": "eslint:recommended", // or any other presets
"plugins": ["extendscript"],
"env": {
"extendscript/extendscript": true, // All available globals
}
}
```
## Contributions
Contributions are more than welcome. Especially if you like to add more
environments to this setup.
The globals are generated automatically from ExtendScript documentation which
might be quite hard to find sometimes. Reach out to me via issues or email and
we might get something working.
All globals are found in `src/globals.json`. They are generated by running `npm run get-globals`.
## Contributors
| [
Adam Bergman](http://fransvilhelm.com)
[💻](https://github.com/adambrgmn/eslint-plugin-extendscript/commits?author=adambrgmn "Code") [📖](https://github.com/adambrgmn/eslint-plugin-extendscript/commits?author=adambrgmn "Documentation") |
| :---: |
## License
MIT