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

introspectComments does not play nice with tab indentation #1705

Closed
2 of 4 tasks
chromey opened this issue Dec 1, 2021 · 1 comment · Fixed by #1706
Closed
2 of 4 tasks

introspectComments does not play nice with tab indentation #1705

chromey opened this issue Dec 1, 2021 · 1 comment · Fixed by #1706

Comments

@chromey
Copy link

chromey commented Dec 1, 2021

Is there an existing issue for this?

  • I have searched the existing issues

Current behavior

If tab-based indentation is used in the codebase (e.g. prettier config "useTabs": true), introspectComments does not accurately parse comments. For example, descriptions have leading * characters that are interpreted as bullets, and tsdoc tags are not stripped away.

Minimum reproduction code

I will attach a PR with a test case shortly, let me know if you need anything else.

Steps to reproduce

see current behavior

Expected behavior

introspectComments should work identical for space and tab-based indentation

Package version

5.1.5

NestJS version

8.2.3

Node.js version

14.15.1

In which operating systems have you tested?

  • macOS
  • Windows
  • Linux

Other

No response

chromey pushed a commit to chromey/swagger that referenced this issue Dec 1, 2021
introspectComments did not properly parse comments when source files used tab indentation

fixes nestjs#1705
@chromey
Copy link
Author

chromey commented Dec 8, 2021

Just checking in. If there's anything lacking from the description or the PR, or if there's anything I can do to help get this merged, please let me know.

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

Successfully merging a pull request may close this issue.

1 participant