feat: Add linting and formating config

[munechika-koyo]

Motivation

To maintain clear and readable code, we should use linting and formatting settings.

Tools to adopt

• ruff — Python de fact standard linter/formatter
• cython-lint — Cython linter
• dprint — code formatting platform mainly to format yaml, json, markdown files

pre-commit tool

• lefthook — Git hooks manager to execute all of the above checks before commit or when CI runs.

Note

I assume that these tools can be managed by a package management system like pixi. (#489)

Finally, I would be happy to discuss the most appropriate approach for cherab developers.

[jacklovell]

I suggest adding Pylint to the list. Here's a minimal pylintrc file I use with Cherab:

[MAIN]
extension-pkg-allow-list=cherab,raysect,numpy,scipy
py-version=3.9 # Oldest supported by raysect 0.9
ignore-patterns=.*test.*.py # Lots of noise in test files
[MESSAGES CONTROL]
# Disable checks which produce lots of warnings without affecting code quality.
disable=consider-using-f-string,
missing-module-docstring,
missing-function-docstring,
line-too-long,
missing-final-newline,

These can also go in pyproject.toml under the headings tool.pylint.MAIN and tool.pylint."MESSAGES CONTROL"

[munechika-koyo]

Motivation

To maintain clear and readable code, we should use linting and formatting settings.

Tools to adopt

• ruff — Python de fact standard linter/formatter
• cython-lint — Cython linter
• dprint — code formatting platform mainly to format yaml, json, markdown files

pre-commit tool

• lefthook — Git hooks manager to execute all of the above checks before commit or when CI runs.

Note

I assume that these tools can be managed by a package management system like pixi. (#489)

Finally, I would be happy to discuss the most appropriate approach for cherab developers.

[jacklovell]

I suggest adding Pylint to the list. Here's a minimal pylintrc file I use with Cherab:

[MAIN]
extension-pkg-allow-list=cherab,raysect,numpy,scipy
py-version=3.9 # Oldest supported by raysect 0.9
ignore-patterns=.*test.*.py # Lots of noise in test files
[MESSAGES CONTROL]
# Disable checks which produce lots of warnings without affecting code quality.
disable=consider-using-f-string,
missing-module-docstring,
missing-function-docstring,
line-too-long,
missing-final-newline,

These can also go in pyproject.toml under the headings tool.pylint.MAIN and tool.pylint."MESSAGES CONTROL"

[munechika-koyo]

Motivation

To maintain clear and readable code, we should use linting and formatting settings.

Tools to adopt

• ruff — Python de fact standard linter/formatter
• cython-lint — Cython linter
• dprint — code formatting platform mainly to format yaml, json, markdown files

pre-commit tool

• lefthook — Git hooks manager to execute all of the above checks before commit or when CI runs.

Note

I assume that these tools can be managed by a package management system like pixi. (#489)

Finally, I would be happy to discuss the most appropriate approach for cherab developers.

[jacklovell]

I suggest adding Pylint to the list. Here's a minimal pylintrc file I use with Cherab:

[MAIN]
extension-pkg-allow-list=cherab,raysect,numpy,scipy
py-version=3.9 # Oldest supported by raysect 0.9
ignore-patterns=.*test.*.py # Lots of noise in test files
[MESSAGES CONTROL]
# Disable checks which produce lots of warnings without affecting code quality.
disable=consider-using-f-string,
missing-module-docstring,
missing-function-docstring,
line-too-long,
missing-final-newline,

These can also go in pyproject.toml under the headings tool.pylint.MAIN and tool.pylint."MESSAGES CONTROL"

[munechika-koyo]

Motivation

To maintain clear and readable code, we should use linting and formatting settings.

Tools to adopt

• ruff — Python de fact standard linter/formatter
• cython-lint — Cython linter
• dprint — code formatting platform mainly to format yaml, json, markdown files

pre-commit tool

• lefthook — Git hooks manager to execute all of the above checks before commit or when CI runs.

Note

I assume that these tools can be managed by a package management system like pixi. (#489)

Finally, I would be happy to discuss the most appropriate approach for cherab developers.

[jacklovell]

I suggest adding Pylint to the list. Here's a minimal pylintrc file I use with Cherab:

[MAIN]
extension-pkg-allow-list=cherab,raysect,numpy,scipy
py-version=3.9 # Oldest supported by raysect 0.9
ignore-patterns=.*test.*.py # Lots of noise in test files
[MESSAGES CONTROL]
# Disable checks which produce lots of warnings without affecting code quality.
disable=consider-using-f-string,
missing-module-docstring,
missing-function-docstring,
line-too-long,
missing-final-newline,

These can also go in pyproject.toml under the headings tool.pylint.MAIN and tool.pylint."MESSAGES CONTROL"

[munechika-koyo]

Motivation

To maintain clear and readable code, we should use linting and formatting settings.

Tools to adopt

• ruff — Python de fact standard linter/formatter
• cython-lint — Cython linter
• dprint — code formatting platform mainly to format yaml, json, markdown files

pre-commit tool

• lefthook — Git hooks manager to execute all of the above checks before commit or when CI runs.

Note

I assume that these tools can be managed by a package management system like pixi. (#489)

Finally, I would be happy to discuss the most appropriate approach for cherab developers.

[jacklovell]

I suggest adding Pylint to the list. Here's a minimal pylintrc file I use with Cherab:

[MAIN]
extension-pkg-allow-list=cherab,raysect,numpy,scipy
py-version=3.9 # Oldest supported by raysect 0.9
ignore-patterns=.*test.*.py # Lots of noise in test files
[MESSAGES CONTROL]
# Disable checks which produce lots of warnings without affecting code quality.
disable=consider-using-f-string,
missing-module-docstring,
missing-function-docstring,
line-too-long,
missing-final-newline,

These can also go in pyproject.toml under the headings tool.pylint.MAIN and tool.pylint."MESSAGES CONTROL"

[munechika-koyo]

Motivation

To maintain clear and readable code, we should use linting and formatting settings.

Tools to adopt

• ruff — Python de fact standard linter/formatter
• cython-lint — Cython linter
• dprint — code formatting platform mainly to format yaml, json, markdown files

pre-commit tool

• lefthook — Git hooks manager to execute all of the above checks before commit or when CI runs.

Note

I assume that these tools can be managed by a package management system like pixi. (#489)

Finally, I would be happy to discuss the most appropriate approach for cherab developers.

[jacklovell]

I suggest adding Pylint to the list. Here's a minimal pylintrc file I use with Cherab:

[MAIN]
extension-pkg-allow-list=cherab,raysect,numpy,scipy
py-version=3.9 # Oldest supported by raysect 0.9
ignore-patterns=.*test.*.py # Lots of noise in test files
[MESSAGES CONTROL]
# Disable checks which produce lots of warnings without affecting code quality.
disable=consider-using-f-string,
missing-module-docstring,
missing-function-docstring,
line-too-long,
missing-final-newline,

These can also go in pyproject.toml under the headings tool.pylint.MAIN and tool.pylint."MESSAGES CONTROL"

[munechika-koyo]

Motivation

To maintain clear and readable code, we should use linting and formatting settings.

Tools to adopt

• ruff — Python de fact standard linter/formatter
• cython-lint — Cython linter
• dprint — code formatting platform mainly to format yaml, json, markdown files

pre-commit tool

• lefthook — Git hooks manager to execute all of the above checks before commit or when CI runs.

Note

I assume that these tools can be managed by a package management system like pixi. (#489)

Finally, I would be happy to discuss the most appropriate approach for cherab developers.

[jacklovell]

I suggest adding Pylint to the list. Here's a minimal pylintrc file I use with Cherab:

[MAIN]
extension-pkg-allow-list=cherab,raysect,numpy,scipy
py-version=3.9 # Oldest supported by raysect 0.9
ignore-patterns=.*test.*.py # Lots of noise in test files
[MESSAGES CONTROL]
# Disable checks which produce lots of warnings without affecting code quality.
disable=consider-using-f-string,
missing-module-docstring,
missing-function-docstring,
line-too-long,
missing-final-newline,

These can also go in pyproject.toml under the headings tool.pylint.MAIN and tool.pylint."MESSAGES CONTROL"

[munechika-koyo]

Motivation

To maintain clear and readable code, we should use linting and formatting settings.

Tools to adopt

• ruff — Python de fact standard linter/formatter
• cython-lint — Cython linter
• dprint — code formatting platform mainly to format yaml, json, markdown files

pre-commit tool

• lefthook — Git hooks manager to execute all of the above checks before commit or when CI runs.

Note

I assume that these tools can be managed by a package management system like pixi. (#489)

Finally, I would be happy to discuss the most appropriate approach for cherab developers.

[jacklovell]

I suggest adding Pylint to the list. Here's a minimal pylintrc file I use with Cherab:

[MAIN]
extension-pkg-allow-list=cherab,raysect,numpy,scipy
py-version=3.9 # Oldest supported by raysect 0.9
ignore-patterns=.*test.*.py # Lots of noise in test files
[MESSAGES CONTROL]
# Disable checks which produce lots of warnings without affecting code quality.
disable=consider-using-f-string,
missing-module-docstring,
missing-function-docstring,
line-too-long,
missing-final-newline,

These can also go in pyproject.toml under the headings tool.pylint.MAIN and tool.pylint."MESSAGES CONTROL"