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

Enable the '.' character in names paths when parsing them? #143

Closed
7118path opened this issue Jun 3, 2020 · 3 comments
Closed

Enable the '.' character in names paths when parsing them? #143

7118path opened this issue Jun 3, 2020 · 3 comments
Labels
typescript Having to do with sphinx-js's typescript support

Comments

@7118path
Copy link

7118path commented Jun 3, 2020

Hi,
as a first time user of sphinx-js I ran across an error when trying to use it with Typescript code.
Typescript version: 3.9.3
Typedoc version: 0.17.7

The error is like this:
parsimonious.exceptions.ParseError: Rule 'path' didn't match at '../../docs/abstractS'

The error is triggerd by this path input value, which seems to hold an '.' character in the name:
../../docs/abstractSigner.module:abstractSigner

Allowing the '.' character in names in the parsers grammar in 'sphinx_js/parsers.py', seems to solve the issue:
name = ~r"(?:[^(/#~\\]|\\.)+"
instead of
name = ~r"(?:[^(/#~.\\]|\\.)+"

Is it possible to change the rule for names like this without raising new problems? I would add a Pull Request then.

TIA

@raucao
Copy link

raucao commented Jun 26, 2020

I ran into the same issue, and this change seems to fix it.

@erikrose
Copy link
Contributor

erikrose commented Sep 2, 2020

Should be fixed in 63ec399.

@erikrose erikrose closed this as completed Sep 2, 2020
@7118path
Copy link
Author

7118path commented Sep 3, 2020

Great, Thank you very much :-)

hoodmane added a commit to hoodmane/sphinx-js that referenced this issue May 3, 2024
…#143)

This is supposed to help make the ts check job work
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typescript Having to do with sphinx-js's typescript support
Projects
None yet
Development

No branches or pull requests

3 participants