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

Linting #55

Merged
merged 13 commits into from
Mar 11, 2023
Merged

Linting #55

merged 13 commits into from
Mar 11, 2023

Conversation

tkphd
Copy link
Contributor

@tkphd tkphd commented Mar 7, 2023

This PR addresses linting errors in the cookiecutter template, which are unfortunately propagated to every downstream project.

Tools used include:

Copy link
Member

@sierra-moxon sierra-moxon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tkphd! This is great; can you confirm that you were able to test this by successfully creating a linkml project with the linted changes?

@tkphd
Copy link
Contributor Author

tkphd commented Mar 8, 2023

Haha you want me to make sure the edited code works‽ Picky, picky!

... already found an error in list indentation, so, good call.

The file {{cookiecutter.project_name}}/project/prefixmap/{{cookiecutter.__project_slug}}.yaml fails linting, because it contains a Python dict (or JSON), not YAML as advertised. This was also noted in #22. This is out-of-scope for this PR, but I wonder what the appropriate "fix" is.

@tkphd
Copy link
Contributor Author

tkphd commented Mar 8, 2023

OK, I have actually used the updated cookiecutter template, and can confirm that the generated files pass linting checks and make sense visually.

For fellow travelers, the command to use a specific branch is
cruft create --checkout <branch-or-tag-name> URL, so in this case I did

cruft create --checkout linting https://github.com/tkphd/linkml-project-cookiecutter

@cmungall cmungall merged commit 33f5511 into linkml:main Mar 11, 2023
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

Successfully merging this pull request may close these issues.

3 participants