shipmnts / editor-hub

Powerful and customizable rich text editor component for React applications
10 stars 5 forks source link

Refactor Folder Structure and Module Naming for Improved Organization #14

Open devcodes9 opened 2 days ago

devcodes9 commented 2 days ago

Is your feature request related to a problem? Please describe.

The current folder structure and module naming in the Editor Hub repository are inconsistent and overly verbose. This makes navigation and maintenance of the codebase more difficult than necessary. For example, we have folders like quill-emojijs-main instead of simply emoji.

Describe the solution you'd like

Refactor the folder structure and module naming to be more concise, consistent, and intuitive. This should include:

  1. Simplifying module names (e.g., emoji instead of quill-emojijs-main)
  2. Organizing related modules into logical groupings
  3. Ensuring consistent naming conventions across the project
  4. Updating all relevant import statements and documentation

Implementation details

  1. Create a new folder structure that logically groups related modules
  2. Rename modules to be more concise while still being descriptive
  3. Update all import statements throughout the codebase
  4. Update documentation, including README files, to reflect the new structure

Proposed folder structure: (Can be changed) editor-hub/ ├── src/ │ ├── core/ │ ├── modules/ │ │ ├── emoji/ │ │ ├── mention/ │ │ ├── table/ │ │ └── ...

Example of module renaming:

Relevant code

This change will affect multiple areas of the codebase. Here's an example of how imports might change:

// Before
import Emoji from 'quill-emojijs-main';
// After
import Emoji from 'modules/emoji';

Additional context

Refactoring the folder structure and module naming will improve the overall organization of the project, making it easier for both maintainers and contributors to navigate and understand the codebase. It will also make the project more approachable for new contributors.

Possible challenges

  1. Ensuring all imports are correctly updated across the entire project
  2. Maintaining backwards compatibility for any external projects that may be using specific import paths
  3. Updating all documentation and examples to reflect the new structure

Acceptance Criteria

infernodragon456 commented 1 day ago

Hello, can you assign me this issue to work on?

devdcodes9 commented 1 day ago

@infernodragon456 Assigned..Happy Coding!

infernodragon456 commented 1 day ago

@devcodes9 should I clone the main branch or the staging branch?

devcodes9 commented 1 day ago

@infernodragon456 you can clone it from staging

infernodragon456 commented 1 day ago

@devcodes9 I have updated the file structure as mentioned. Here is a screenshot for reference: image Please review and let me know of any changes! If this is acceptable, let me know so that I can create a PR.

devcodes9 commented 1 day ago

@infernodragon456 Structure looks fine(other than 2 dist folders). I would request you to read the acceptance criteria, dont forget to resolve the imports and build. Also, provide a screen recording in the PR.