https://github.com/fusepilot/parcel-plugin-cep-starter

Starter template for parcel-cep-plugin, a zero configuration CEP extension builder for Parcel.
https://github.com/fusepilot/parcel-plugin-cep-starter

adobe cep parcel

Last synced: about 1 month ago
JSON representation

Starter template for parcel-cep-plugin, a zero configuration CEP extension builder for Parcel.

• Host: GitHub
• URL: https://github.com/fusepilot/parcel-plugin-cep-starter
• Owner: fusepilot
• License: mit
• Created: 2017-12-31T19:00:18.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T03:34:22.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T04:51:19.547Z (9 months ago)
• Topics: adobe, cep, parcel
• Language: TypeScript
• Homepage:
• Size: 538 KB
• Stars: 13
• Watchers: 2
• Forks: 9
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Parcel CEP Plugin Starter

Starter template for [parcel-cep-plugin](https://github.com/fusepilot/parcel-plugin-cep), a zero configuration CEP extension builder for [Parcel](https://github.com/parcel-bundler/parcel).

## Quick Start

```sh

git clone https://github.com/fusepilot/parcel-plugin-cep-starter.git

cd parcel-plugin-cep-starter

yarn && yarn start

```

Open your CC app of choice, find your extension under `Window` > `Extensions`, and start developing.

## Building

To create a production build:

```sh

yarn build

```

## Packaging

To create a .zxp for deployment:

```sh

yarn zxp

```

A versioned .zxp file will be placed inside `archive`.

## Guides

### Running Scripts

1. Add the function to the `$.global` object in `script/index.jsx.ts`

2. Call `evalScript` in your React component

```js

// index.jsx.ts

import { id } from "../shared";

function alertFromScript(message) {

  alert(message);

}

$.global[id] = {

  alertFromScript,

};

// Component.jsx

import * as React from "react";

export function Component() {

  const { evalScript } = useExtension();

  return (

     evalScript('alertFromScript("Hey!")')}>Alert

  );

}

```

### Logging

You can log events from React in a similar way:

```js

// Component.jsx

import * as React from "react";

export function Component() {

  const { logMessage } = useLogger();

  return (

     logMessage("info", "Logged info from panel")}>

      Log info

    

  );

}

```

This will append a log message to a file on disk.

### CEP Configuration

See [fusepilot/parcel-plugin-cep](https://github.com/fusepilot/parcel-plugin-cep)