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

Moving the ccr folder out of /lib #325

Closed
mrob95 opened this issue Nov 17, 2018 · 6 comments
Closed

Moving the ccr folder out of /lib #325

mrob95 opened this issue Nov 17, 2018 · 6 comments
Assignees
Labels
Refactor Restructuring file structure or existing code without changing its external behavior.

Comments

@mrob95
Copy link
Member

mrob95 commented Nov 17, 2018

The folder structure doesn't seem to make a lot of sense at the moment, with a very un-clear distinction made between command modules and back-end definitions. I think the simplest thing to do would be to:

  • Move the caster/lib/ccr folder into caster/, so that it's in the same place as caster/apps. These are really the two folders which users are going to want to tinker with on a daily basis.
  • Move the caster/asynch folder into caster/lib. Nobody is ever going to need to touch this.
  • Maybe move the ccr/core folder into the main caster/ directory as well? This would make the three main caster functions - language modules, core navigation and context dependent commands - obvious and separate.

Thoughts?

@LexiconCode LexiconCode added the Refactor Restructuring file structure or existing code without changing its external behavior. label Nov 17, 2018
@LexiconCode
Copy link
Member

I would agree all three points as it make sense.

@mrob95
Copy link
Member Author

mrob95 commented Nov 17, 2018

Okay, I've done it on mine and got it working (after quite a few error messages :-)) but it might be worth clearing the pull request schedule before doing this one, as it's going to make anything else unmergeable.

@comodoro
Copy link
Contributor

If shuffling directories, I could maybe suggest debate about

  • renaming async to something specific, e.g. isn't it all GUI?
  • recording is not all CCR (or all recording)
  • loading of CCR and apps rules in _caster.py might be more readable than currently via __init__.py in ccr/ and apps/
  • I have no opinion about the core dir (perhaps slightly in favor of keeping it in ccr/ because these are in fact CCR rules), but having core rule names hardwired in class CCRMerger feels wrong

@LexiconCode
Copy link
Member

LexiconCode commented Nov 18, 2018

I would be in favor of keeping the the core file in the CCR directory. I would also keep the structure for loading CCR has it is. In the future we will change how this works or eliminate it altogether.

@mrob95
Copy link
Member Author

mrob95 commented Nov 23, 2018

Currently aiming to move the ccr and asynch folders once #312 has been merged if there are no objections

@drmfinlay
Copy link
Member

@mrob95 I should have the work on that finished soon :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Refactor Restructuring file structure or existing code without changing its external behavior.
Projects
None yet
Development

No branches or pull requests

4 participants