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

check: support generated cdktf docs #50

Merged
merged 3 commits into from
May 31, 2023

Conversation

DanielMSchmidt
Copy link
Contributor

No description provided.

Copy link
Owner

@bflad bflad left a comment

Choose a reason for hiding this comment

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

Overall I think this is okay -- I do believe the glob pattern needs to be updated though. 👍

DocumentationGlobPattern = `{docs/index.md,docs/{data-sources,guides,resources},website/docs}/**/*`

LegacyIndexDirectory = `website/docs`
LegacyDataSourcesDirectory = `website/docs/d`
Copy link
Owner

Choose a reason for hiding this comment

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

These constants are exported and therefore part of the Go module compatibility promises, however in spot checking various dependents of this Go module, it does not appear that any drop down to using the Go code directly so it's likely fine that this is being changed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh I see, I wasn't aware :) Thanks for raising this and thank you for checking if it causes trouble down the road :)

Copy link
Owner

Choose a reason for hiding this comment

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

Other places in this codebase are dependent on these values exactly matching their original values, so need to follow this up with additional changes.

check/directory.go Outdated Show resolved Hide resolved
@bflad bflad added the enhancement New feature or request label May 31, 2023
@bflad bflad added this to the v0.10.0 milestone May 31, 2023
@bflad bflad self-requested a review May 31, 2023 12:30
Copy link
Owner

@bflad bflad left a comment

Choose a reason for hiding this comment

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

These changes look good, but there's a new test failure:

--- FAIL: TestCheck (0.00s)
    --- FAIL: TestCheck/valid_legacy_directories_requiring_side_navigation (0.00s)
        check_test.go:184: expected error, got no error

The ERB side navigation check is very outdated and unnecessary to maintain in this linter at this point so as a followup to this I'll remove all that functionality.

Thanks so much, @DanielMSchmidt 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants