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

Rich Text Editor and Rich Text Viewer should import common parsing functionalities from the shared folder #1447

Closed
Tracked by #1288
aagash-ni opened this issue Aug 22, 2023 · 0 comments · Fixed by #1472

Comments

@aagash-ni
Copy link
Contributor

🧹 Tech Debt

Currently, Editor and viewer have duplicate parsing functionalities. Instead moving these common parsing functionalities to a separate models folder and restructuring will enable the editor and viewer to import and use the shared parsing functionalities.

Reference to the conversation: https://github.com/ni/nimble/pull/1424/files#r1290998178

@aagash-ni aagash-ni added tech debt triage New issue that needs to be reviewed labels Aug 22, 2023
@aagash-ni aagash-ni changed the title Rich Text Editor and Rich Text Viewer should use its common parsing functionalities from the shared folder Rich Text Editor and Rich Text Viewer should import common parsing functionalities from the shared folder Aug 22, 2023
@m-akinc m-akinc removed the triage New issue that needs to be reviewed label Aug 22, 2023
vivinkrishna-ni added a commit that referenced this issue Sep 6, 2023
# Pull Request

## 🤨 Rationale

<!---
Provide some background and a description of your work.
What problem does this change solve?

Include links to issues, work items, or other discussions.
-->
Reorganize the folder structure of the `nimble-rich-text-editor` and
`nimble-rich-text-viewer` to share the common functionalities between
components.

Part of #1447

## 👩‍💻 Implementation

<!---
Describe how the change addresses the problem. Consider factors such as
complexity, alternative solutions, performance impact, etc.

Consider listing files with important changes or comment on them
directly in the pull request.
-->

Revamped folder structure in nimble-components:
```
/rich-text
    /editor
        editor component files...
    /viewer
        viewer component files...
    /specs
        README.md (common spec file for both editor and viewer)
```

Revamped folder structure in nimble-angular:
```
/rich-text
    /editor
        editor component files...
    /viewer
        viewer component files...
```

Related discussion:
#1424 (comment)

## 🧪 Testing

<!---
Detail the testing done to ensure this submission meets requirements. 

Include automated/manual test additions or modifications, testing done
on a local build, private CI run results, and additional testing not
covered by automatic pull request validation.
-->
- Manually tested the components in the local storybook build.

## ✅ Checklist

<!--- Review the list and put an x in the boxes that apply or ~~strike
through~~ around items that don't (along with an explanation). -->

- [x] I have updated the project documentation to reflect my changes or
determined no changes are needed.
@vikisekarNI vikisekarNI linked a pull request Sep 11, 2023 that will close this issue
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging a pull request may close this issue.

3 participants