Skip to content

[Cleanup] Move Parsers to be internal to Markdown package, deprecate old package on NuGet #3744

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

Closed
michael-hawker opened this issue Feb 9, 2021 · 2 comments · Fixed by #3759
Labels
Completed 🔥 feature request 📬 A request for new changes to improve functionality in progress 🚧 maintenance ⚙️ markdown 📑 Issues related to Markdown next preview ✈️ Label for marking what we want to include in the next preview release for developers to try.
Milestone

Comments

@michael-hawker
Copy link
Member

We don't want to support our Markdown parser package and eventually move to Markdig, see issue #3200.

For 7.0, we shouldn't ship a new package, just deprecate it on NuGet point to Markdig. Then just internalize all this code for the MarkdownTextBlock.

@michael-hawker michael-hawker added the feature request 📬 A request for new changes to improve functionality label Feb 9, 2021
@michael-hawker michael-hawker added this to the 7.0 milestone Feb 9, 2021
@michael-hawker michael-hawker added maintenance ⚙️ markdown 📑 Issues related to Markdown next preview ✈️ Label for marking what we want to include in the next preview release for developers to try. labels Feb 9, 2021
@Rosuavio
Copy link
Contributor

We seem to still have a lot of unit tests referencing the Parsers package. Should we keep them?

@michael-hawker
Copy link
Member Author

We seem to still have a lot of unit tests referencing the Parsers package. Should we keep them?

Yeah, we should keep them incase we can refactor them later for the rendering side with a new parser, and the code is still being used by the MarkdownTextBlock itself.

@Rosuavio Rosuavio mentioned this issue Feb 16, 2021
8 tasks
@ghost ghost closed this as completed in #3759 Feb 18, 2021
ghost pushed a commit that referenced this issue Feb 18, 2021
<!-- 🚨 Please Do Not skip any instructions and information mentioned below as they are all required and essential to evaluate and test the PR. By fulfilling all the required information you will be able to reduce the volume of questions and most likely help merge the PR faster 🚨 -->

<!-- 📝 It is preferred if you keep the "☑️ Allow edits by maintainers" checked in the Pull Request Template as it increases collaboration with the Toolkit maintainers by permitting commits to your PR branch (only) created from your fork.  This can let us quickly make fixes for minor typos or forgotten StyleCop issues during review without needing to wait on you doing extra work. Let us help you help us! 🎉 -->


## Fixes #3744
<!-- Add the relevant issue number after the "#" mentioned above (for ex: Fixes #1234) which will automatically close the issue once the PR is merged. -->

<!-- Add a brief overview here of the feature/bug & fix. --> 
Move Parsing code from `Microsoft.Toolkit.Parsers` into `Microsoft.Toolkit.Uwp.UI.Controls.Markdown`. Make parsing code internal as we don't want anyone using our parsers. 

Remove sample `MarkdownParserPage` as it directly uses our parser.


## PR Type
What kind of change does this PR introduce?
<!-- Please uncomment one or more that apply to this PR. -->

<!-- - Bugfix -->
<!-- - Feature -->
<!-- - Code style update (formatting) -->
- Refactoring (no functional changes, no api changes)
<!-- - Build or CI related changes -->
<!-- - Documentation content changes -->
- Sample app changes
<!-- - Other... Please describe: -->


## What is the current behavior?
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->


## What is the new behavior?
<!-- Describe how was this issue resolved or changed? -->


## PR Checklist

Please check if your PR fulfills the following requirements:

- [ ] Tested code with current [supported SDKs](../readme.md#supported)
- [ ] Pull Request has been submitted to the documentation repository [instructions](..\contributing.md#docs). Link: <!-- docs PR link -->
- [ ] Sample in sample app has been added / updated (for bug fixes / features)
    - [ ] Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/windows-toolkit/WindowsCommunityToolkit-design-assets)
- [ ] New major technical changes in the toolkit have or will be added to the [Wiki](https://github.com/windows-toolkit/WindowsCommunityToolkit/wiki) e.g. build changes, source generators, testing infrastructure, sample creation changes, etc...
- [ ] Tests for the changes have been added (for bug fixes / features) (if applicable)
- [ ] Header has been added to all new source files (run *build/UpdateHeaders.bat*)
- [ ] Contains **NO** breaking changes

<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. 
     Please note that breaking changes are likely to be rejected within minor release cycles or held until major versions. -->


## Other information
@ghost ghost added Completed 🔥 and removed In-PR 🚀 labels Feb 18, 2021
@ghost ghost locked as resolved and limited conversation to collaborators Apr 20, 2021
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Completed 🔥 feature request 📬 A request for new changes to improve functionality in progress 🚧 maintenance ⚙️ markdown 📑 Issues related to Markdown next preview ✈️ Label for marking what we want to include in the next preview release for developers to try.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants