@jetbrains/create-youtrack-app

Create YouTrack App

YouTrack App is an App that can be installed into JetBrains YouTrack to customize it even more. See documentation.

Quick Start

1. Prepare an empty directory for your App
2. Run npm create @jetbrains/youtrack-app
3. Follow the prompts

Adding more features to generated App

Once App is generated, one may need to add more features. See list of awailable commands:

• npx @jetbrains/create-youtrack-app help show to see list of possible commands
• npx @jetbrains/create-youtrack-app init settings to add a settings declaration
• npx @jetbrains/create-youtrack-app property add to add one more property into Settings, created by command above
• npx @jetbrains/create-youtrack-app widget add to add one more widget
• npx @jetbrains/create-youtrack-app entity create to declare extension property
• npx @jetbrains/create-youtrack-app http-handler add to add an HTTP handler

Development

To test locally, run one of the package.json scripts like npm run widget. This generator uses Hygen udner the hood.

Run npm test to check basic generation workflow.

Caveats

Hygen is quite powerful tool for generation files, but it is not perfect for the working with the JSON files. So, some JSON manipulation can be tricky. To prevent this, there is a injectJsCallback.js file where is a helper function that can be called to create custom JS actions instead of file rendering. Example of usage _templates/settings/index.js file.

TODO:

• update the code to use this as external tool
• permissions in widget.add
• possibly rewrite property add to JSON-based approach
• full list of the extension properties entities
• creation of http handlers
• TypeScript support (at least widgets/handlers/extension-propertioes should be added to app.d.ts file)
• React + ring-ui support in widget templates
• wording review
• testing
• documentation