jdaviz icon indicating copy to clipboard operation
jdaviz copied to clipboard

Reorganize plugins to be config-agnostic

Open Jdaviz-Triage-Bot opened this issue 2 years ago • 2 comments

Reporter: pllim

As a dev, I find it very frustrating to have to recursive grep all the configs to find out a full inventory of all the plugins we have. Even if I could read the user docs, sometimes I need to know how they are actually named in the repository for various reasons. In addition, for some reason, we also put plugin tests even one level deeper in their individual test directories, adding to the complexity of the file system layout.

Therefore, I would like to propose the following new layout for Jdaviz plugins (2 are randomly chosen to illustrate the new layout):

jdaviz/
    configs/
        cubeviz/
        default/
        ...
    plugins/
        __init__.py
        collapse/
            __init__.py
            collapse.py
            collapse.vue
        moment_maps/
            __init__.py
            moment_maps.py
            moment_maps.vue
        tests/
            __init__.py
            test_collapse.py
            test_moment_maps.py

Any unmerged PRs touching plugins would likely have major merge conflicts. So, we should be careful on when we pick this ticket up to work on.

🐱


DISCLAIMER: This issue was autocreated by the Jdaviz Issue Creation Bot on behalf of the reporter. If any information is incorrect, please contact Duy Nguyen

Jdaviz-Triage-Bot avatar Mar 17 '23 21:03 Jdaviz-Triage-Bot