Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a simple js-only plugin template #603

Closed
6 tasks done
Tracked by #629
jmcook1186 opened this issue Apr 10, 2024 · 3 comments · Fixed by Green-Software-Foundation/if-js-plugin-template#1
Closed
6 tasks done
Tracked by #629
Assignees

Comments

@jmcook1186
Copy link
Contributor

jmcook1186 commented Apr 10, 2024

What
Add a new repository to the gSF organmization Githiub called if-js-plugin-template and prepopulate it with the code for a minimal plugin that can easily be loaded into if.

Why

As a plugin builder I want to rapidly prototype plugins using javascript, rather than typescript. This will help me to rapidly prototype and create plugins for demos and proofs-of-concept.

There are several times when we have wanted to quickly create new plugins for demos, but conforming to the relatively strict standards imposed in the typescript template has slowed things down. We could also provide a javascript-only simplified template for rapid plugin development.

Acceptance criteria

  • code for a minimal plugin is available in new if-js-plugin-template repository

    • includes a index.js, package.json and README
    • includes an example manifest
  • README includes explanation of how to install demo plugin and run from if using the example manifest provided

    • includes step by step instructions for using npm link to create local package for plugin
      GIVEN a user clones the new if-js-plugin-template repository
      WHEN follow the instructions int he template readme
      THEN they can execute the template plugin code in their locally installed if

SoW

  • create repository
  • add plugin code
  • add example manifest
  • add README with instructions
@narekhovhannisyan
Copy link
Member

@jmcook1186 let's have the javascript version in a separate repository

@zanete zanete moved this from Backlog to In Design in IF Apr 22, 2024
@jmcook1186 jmcook1186 assigned jmcook1186 and unassigned manushak May 7, 2024
@jmcook1186 jmcook1186 moved this from In Design to In Refinement in IF May 7, 2024
@zanete zanete assigned manushak and unassigned jmcook1186 Jun 5, 2024
@zanete zanete removed the epic: QA label Jun 5, 2024
@zanete
Copy link

zanete commented Jul 29, 2024

@jmcook1186 @manushak and @narekhovhannisyan to have a disussion before implementing this in case there is opportunity to create a single repo for Js and typescript templates

@zanete zanete removed this from the IF Watchers milestone Aug 22, 2024
@zanete zanete moved this from In Refinement to Ready in IF Nov 27, 2024
@zanete
Copy link

zanete commented Dec 12, 2024

@jmcook1186 please create a repo for this template to unblock @manushak 🙏

@manushak manushak moved this from Ready to Pending Review in IF Dec 13, 2024
@github-project-automation github-project-automation bot moved this from Pending Review to Done in IF Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants