Skip to content

Require that package descriptions not include newlines #219

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

Merged
neersighted merged 2 commits into from
Nov 10, 2021
Merged

Require that package descriptions not include newlines #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89da158
Require that package descriptions not include newlines
tipabu Oct 8, 2021
886217f
Add test for multi-line description
tipabu Oct 11, 2021
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
3 changes: 2 additions & 1 deletion poetry/core/json/schemas/poetry-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
},
"description": {
"type": "string",
"description": "Short package description."
"description": "Short package description.",
"pattern": "^[^\n]*$"
},
"keywords": {
"type": "array",
Expand Down
9 changes: 9 additions & 0 deletions tests/json/test_poetry_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,12 @@ def test_path_dependencies(base_object):

def test_multi_url_dependencies(multi_url_object):
assert len(validate_object(multi_url_object, "poetry-schema")) == 0


def test_multiline_description(base_object):
bad_description = "Some multi-\nline string"
base_object["description"] = bad_description

errors = validate_object(base_object, "poetry-schema")
assert len(errors) == 1
assert errors[0] == "[description] %r does not match '^[^\\n]*$'" % bad_description