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.

Sign up for GitHub

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

Jump to bottom

Don't allow trailing newlines in description #505

Merged
merged 1 commit into from
Dec 23, 2022
Merged

Don't allow trailing newlines in description #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/poetry/core/json/schemas/poetry-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"description": {
"type": "string",
"description": "Short package description.",
"pattern": "^[^\n]*$"
"pattern": "\\A[^\n]*\\Z"
},
"keywords": {
"type": "array",
Expand Down
14 changes: 11 additions & 3 deletions tests/json/test_poetry_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,18 @@ def test_multi_url_dependencies(multi_url_object: dict[str, Any]) -> None:
assert len(validate_object(multi_url_object, "poetry-schema")) == 0


def test_multiline_description(base_object: dict[str, Any]) -> None:
bad_description = "Some multi-\nline string"
@pytest.mark.parametrize(
"bad_description",
["Some multi-\nline string", "Some multiline string\n", "\nSome multi-line string"],
)
def test_multiline_description(
base_object: dict[str, Any], bad_description: str
) -> None:
base_object["description"] = bad_description

errors = validate_object(base_object, "poetry-schema")

assert len(errors) == 1
assert errors[0] == f"[description] {bad_description!r} does not match '^[^\\n]*$'"

regex = r"\\A[^\n]*\\Z"
assert errors[0] == f"[description] {bad_description!r} does not match '{regex}'"