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

[feature-proposal] improve config - switch to toml & more #1364

Open
orgua opened this issue Jan 23, 2024 · 2 comments
Open

[feature-proposal] improve config - switch to toml & more #1364

orgua opened this issue Jan 23, 2024 · 2 comments
Assignees

Comments

@orgua
Copy link
Collaborator

orgua commented Jan 23, 2024

advantages of toml:

  • default in common modern projects
  • easier to read and modify than json

per project config allows more control over lint-process. Projects like codespell or ruff demonstrate good usability:

update:

  • also nice feature: (auto) fix to safely remove words or replace them
  • allow sub-configs, individually per project. look for them when entering a sub-directory
@Nytelife26
Copy link
Member

I would approve switching from JSON to TOML, especially since the standard library for Python 3.11 upwards includes tomllib, which means we're already guaranteed future support. Should we use toml from PyPI for earlier versions?

@Nytelife26 Nytelife26 self-assigned this Feb 5, 2024
@Nytelife26
Copy link
Member

Nytelife26 commented Feb 18, 2024

I would approve switching from JSON to TOML, especially since the standard library for Python 3.11 upwards includes tomllib, which means we're already guaranteed future support. Should we use toml from PyPI for earlier versions?

As a follow-on to this, I found out that tomli now maintains a backport of tomllib, so they should have the same interface. Additionally, poetry (although we're not planning to keep using it for long) does support Python-dependent versions, which is convenient.

Then, we'll just be able to do this in the code:

import sys

if sys.version_info >= (3, 11):
    import tomllib
else:
    import tomli as tomllib

I suppose the new filename should be .proselint.toml. I'm not sure why we kept it as proselintrc in the first place, honestly, given that it isn't a command file.

@Nytelife26 Nytelife26 added this to the 1.0.0 milestone Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants