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

Move compas-save #4

Open
JakobVogelsang opened this issue Jan 11, 2023 · 3 comments · May be fixed by #9
Open

Move compas-save #4

JakobVogelsang opened this issue Jan 11, 2023 · 3 comments · May be fixed by #9
Assignees

Comments

@JakobVogelsang
Copy link

To be able to use OpenSCD core we need to move out heavily used web-components within CoMPAS. This issue shall describe how to move out compas-save

t.b.d

@Stef3st
Copy link
Collaborator

Stef3st commented Feb 6, 2023

Acceptance criteria:

  • Remove all compas-save code from compas-open-scd
  • Compas-save and save-as plugins are basically the same. This needs to be rewritten
  • Components should be UI based only. So no logic to it
  • Plugins should contain logic and should use the UI component
  • Tests need to be rewritten accodingly
  • Dependencies are imported from their own repositories.
  • Check to see if helper files are only being used for this particular plugin, if so move to repository. Otherwise, figure where it should be implemented and import dependancy. ( Do not include “compas-core” in the repo)
  • Include screenshot tests if needed
  • Document the new API of the plugin
  • Add TypeDoc for documentation to the repository
  • Create storybook for the plugin

TBD:

  • How to handle translations
  • How to handle logging
  • Save-as-version now opens the entire document just to be rewritten. This needs to be refactored so it only uses the document ID

@Stef3st Stef3st transferred this issue from com-pas/compas-open-scd Feb 27, 2023
@Sander3003
Copy link
Member

Sander3003 commented Aug 23, 2023

OSCD new architecture/logic can be re-used to build this: https://github.com/openscd/oscd-new/tree/oscd-new_WIP

@Stef3st Stef3st self-assigned this Aug 28, 2023
@Stef3st Stef3st linked a pull request Sep 12, 2023 that will close this issue
@Stef3st Stef3st linked a pull request Sep 12, 2023 that will close this issue
@juancho0202
Copy link
Contributor

After pair sessions with @Stef3st it was decided to have code duplication instead of using the CompasExistsIn mixin, because it was problematic to have it exported and reused in multiple plugins (CompasSave and CompasUploadVersion).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants