Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hansottowirtz/adobe-uxp-types-crawler
Crawls the Adobe UXP documentation and generates Typescript declaration files
https://github.com/hansottowirtz/adobe-uxp-types-crawler
adobe-uxp puppeteer typescript
Last synced: about 1 month ago
JSON representation
Crawls the Adobe UXP documentation and generates Typescript declaration files
- Host: GitHub
- URL: https://github.com/hansottowirtz/adobe-uxp-types-crawler
- Owner: hansottowirtz
- License: other
- Created: 2021-02-23T20:20:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-10T10:42:52.000Z (almost 3 years ago)
- Last Synced: 2024-04-28T03:29:48.352Z (8 months ago)
- Topics: adobe-uxp, puppeteer, typescript
- Language: TypeScript
- Homepage:
- Size: 611 KB
- Stars: 15
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Adobe UXP Types Crawler
Currently includes types for Adobe Photoshop and UXP.
This project crawls the Adobe UXP documentation and generates Typescript declaration files, merging them with manually created types.
## Usage
```bash
npm i -D @adobe-uxp-types/photoshop
npm i -D @adobe-uxp-types/uxp
```
```jsonc
// tsconfig.json
{
"compilerOptions": {
"typeRoots": ["node_modules/@types", "node_modules/@adobe-uxp-types"],
"types": ["photoshop", "uxp", /* other types */] // this field is optional
}
}
```
Looking for `GroupLayer` or `layerTree`? These were removed in newer versions of the UXP API. For Photoshop, make sure your `manifest.json` has [`host.data.apiVersion` set to `2`](https://www.adobe.io/photoshop/uxp/2022/guides/uxp_guide/uxp-misc/manifest-v4/photoshop-manifest)!
**Warning**: These typings are not thoroughly tested and will contain a lot of bugs! Please open an [issue](https://github.com/hansottowirtz/adobe-uxp-types-crawler/issues) if you find any inconsistencies.
**The @adobe-uxp-types organization is not an official Adobe project**
## Intro
_Currently only includes types for Photoshop and UXP_
This project is a quickly hacked together Typescript .d.ts generator for Adobe UXP (for Photoshop).
It uses Puppeteer to crawl https://www.adobe.io/photoshop/uxp/ps_reference/ and subpages, and `dts-dom` to
stitch together the typings files.
See `res/entrypoints.jsonc` for configuration and overrides of the crawler.
## Crawling
(minimum Node version: 14)
```bash
npm i
npx ts-node src/index.ts --entrypoints res/entrypoints.jsonc --templates-path res/templates --out-path tmp/out --cache-path tmp/cache
```
## Publishing
This project is managed with a very basic Lerna setup.
```bash
npx ts-node src/index.ts --entrypoints res/entrypoints.jsonc --templates-path res/templates --out-path packages/photoshop --cache-path tmp/cache
```
Bumping package versions:
```
npx lerna version --no-git-tag-version
```
Then commit. Git tags are added by Github Actions.
__Publishing to npm is currently done in Github Actions.__, based on the Lerna version. See `.github/workflows/build-and-publish.yml`.
Manually publishing:
```bash
npx lerna publish from-package
```
## Credits
This project started from [AdobeXD/typings](https://github.com/AdobeXD/typings/issues/28), which did not include types for Photoshop.
Descriptor enums and interfaces were taken from [simonhenke/photoshop-types](https://github.com/simonhenke/photoshop-types).Other types were taken from [@types/photoshop](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/photoshop).
A missing interface was taken from [bbb999/Types-For-Adobe](https://github.com/bbb999/Types-for-Adobe/blob/master/Photoshop/2015.5/index.d.ts).
The common UXP typings were taken from [thejustinwalsh/uxp-types](https://github.com/thejustinwalsh/uxp-types).