Skip to content

Why is the position being removed from remark output #1378

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

Open
koraa opened this issue May 4, 2021 · 4 comments
Open

Why is the position being removed from remark output #1378

koraa opened this issue May 4, 2021 · 4 comments
Assignees

Comments

@koraa
Copy link

koraa commented May 4, 2021

f4a46b1

src/remark-remove-position.js

Forgive me for putting this so bluntly, but…WHY? I was using documentation.js to parse documentation and extract code blocks for ferrum.doctest and my build is failing because of the removal of the position?

I am perfectly happy with the upgrade, but removing the position might better have been a breaking change oO

@koraa
Copy link
Author

koraa commented May 4, 2021

(Anyway thanks for creating documentation.js I should add!!)

koraa added a commit to adobe/ferrum.doctest that referenced this issue May 4, 2021
@tmcw
Copy link
Member

tmcw commented May 4, 2021

You can see the recent PR that removed position in #1369. position information was bloating test fixtures (to the tune of 14k LoC) and didn't have any clear purpose in the output - apparently ferrum.doctest was using it, but it is fairly difficult as a maintainer of a large project with many users to anticipate all possible use cases.

Happy to accept a PR that would turn off position information for tests, to keep the simplification on that side, but include position information in the mdast output mode.

@anthony-redFox
Copy link
Member

I will make it optional that mean make it options which switch on and doesn't remove position Object. @tmcw I'll take it.

@anthony-redFox anthony-redFox self-assigned this May 4, 2021
@koraa
Copy link
Author

koraa commented May 4, 2021

I will make it optional that mean make it options which switch on and doesn't remove position Object. @tmcw I'll take it.

Thank you very much! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants