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

Package linting #20

Open
openvmp opened this issue Dec 29, 2023 · 0 comments
Open

Package linting #20

openvmp opened this issue Dec 29, 2023 · 0 comments
Labels
good first issue Good for newcomers

Comments

@openvmp
Copy link
Owner

openvmp commented Dec 29, 2023

Add "cli_lint.py" to implement "pc lint [-r]" to lint the current package or all of them recursively in case of "-r".
Not to be confused with assembly or part linting (to be implemented later).

"cli_lint()" would initialize the context and apply linting rules to all packages (call linting rules one by one passing packages as parameters).
Initialize the list of all linting rules in "lint_package_all.py".
Define the LintPackageRule class to be used by all package linting rules as the best class in "lint_package.py".
Implement a couple of basic linting rules in "link_package_<rule_name>.py".
For example:

  • warn about missing "desc" fields in packages, parts and assemblies.
  • warn about malformed or unreachable urls if "url" field is present (for now, better not attempt to figure out if "url" is expected to be present or not)
@openvmp openvmp added the good first issue Good for newcomers label Dec 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Development

No branches or pull requests

1 participant