Skip to content

Commit 1ee19df

Browse files
committed
feat: Implement JSDoc parser and composer with CLI support and update tests
1 parent c85cf60 commit 1ee19df

File tree

11 files changed

+13
-13
lines changed

11 files changed

+13
-13
lines changed

.github/workflows/python-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
pip install -e .
2929
- name: Test with pytest
3030
run: |
31-
pytest --cov=docstring_parser tests/ --cov-report=xml
31+
pytest --cov=jsdoc_parser tests/ --cov-report=xml
3232
- name: Upload coverage to Codecov
3333
uses: codecov/codecov-action@v3
3434
with:

docstring_parser/__init__.py renamed to jsdoc_parser/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""JSDoc parser package initialization."""
22

3-
from docstring_parser.parser import parse_jsdoc
4-
from docstring_parser.composer import compose_jsdoc
5-
from docstring_parser.utils import (
3+
from jsdoc_parser.parser import parse_jsdoc
4+
from jsdoc_parser.composer import compose_jsdoc
5+
from jsdoc_parser.utils import (
66
extract_type_info,
77
merge_jsdoc_objects,
88
remove_jsdoc_component

docstring_parser/cli.py renamed to jsdoc_parser/cli.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
import argparse
99
import json
1010
import sys
11-
from docstring_parser.parser import parse_jsdoc
12-
from docstring_parser.composer import compose_jsdoc
13-
from docstring_parser.utils import remove_jsdoc_component
11+
from jsdoc_parser.parser import parse_jsdoc
12+
from jsdoc_parser.composer import compose_jsdoc
13+
from jsdoc_parser.utils import remove_jsdoc_component
1414

1515

1616
def main():
File renamed without changes.
File renamed without changes.
File renamed without changes.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ dependencies = []
2525
"Bug Tracker" = "https://github.com/Penify-dev/jsdoc-parser/issues"
2626

2727
[project.scripts]
28-
jsdoc-parser = "docstring_parser.cli:main"
28+
jsdoc-parser = "jsdoc_parser.cli:main"

tests/test_composer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Tests for the JSDoc composer module."""
22

33
import unittest
4-
from docstring_parser.composer import compose_jsdoc
4+
from jsdoc_parser.composer import compose_jsdoc
55

66

77
class TestJSDocComposer(unittest.TestCase):

tests/test_integration.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""Integration tests for the JSDoc parser and composer."""
22

33
import unittest
4-
from docstring_parser.parser import parse_jsdoc
5-
from docstring_parser.composer import compose_jsdoc
4+
from jsdoc_parser.parser import parse_jsdoc
5+
from jsdoc_parser.composer import compose_jsdoc
66

77

88
class TestJSDocIntegration(unittest.TestCase):

tests/test_parser.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Tests for the JSDoc parser module."""
22

33
import unittest
4-
from docstring_parser.parser import parse_jsdoc
4+
from jsdoc_parser.parser import parse_jsdoc
55

66

77
class TestJSDocParser(unittest.TestCase):

0 commit comments

Comments
 (0)