Fix linting #124
Merged
Fix linting #124
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I want `gitignore` support from `markdownlint-cli2` but it wasn't available in the version that was pinned by `python.version` in the `toplevel` package group. I've moved `lychee` to a new group at the same time because it felt weird having a group for a single package and I can safely verify that these don't introduce any breaking changes.
This fixes a bug whereby the globs were being incorrectly expanded by the shell before being passed to `markdownlint-cli2` because they weren't quoted as the docs suggest. Depending on the shell in use this could cause it to: - incorrectly miss nested directories like `docs/tutorials/migrations` - semi-correctly miss `docs/reference/command-reference` if the glob was expanded before `flox activate` copies the dir from `flox/flox`
We don't want to lint `docs/reference/command-reference` because the files are already committed and copied from `flox/flox`. We may choose to apply linting there separately. We could use `!docs/reference/command-reference` in the glob patterns but it feels more reliable to depend on the gitignore rules that we already have in case the path changes at any time.
These were inconsistently linted until a recent commit that moved the
globbing to the config. This is the result of running:
markdownlint-cli2 --fix
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes some issues that were described in this thread:
flox: Upgrade markdownlint and lychee
I want
gitignoresupport frommarkdownlint-cli2but it wasn'tavailable in the version that was pinned by
python.versionin thetoplevelpackage group.I've moved
lycheeto a new group at the same time because it feltweird having a group for a single package and I can safely verify that
these don't introduce any breaking changes.
ci: Move markdownlint globs to config
This fixes a bug whereby the globs were being incorrectly expanded by
the shell before being passed to
markdownlint-cli2because theyweren't quoted as the docs suggest.
Depending on the shell in use this could cause it to:
docs/tutorials/migrationsdocs/reference/command-referenceif the glob wasexpanded before
flox activatecopies the dir fromflox/floxlint: Ignore gitignored dirs (command-reference)
We don't want to lint
docs/reference/command-referencebecause thefiles are already committed and copied from
flox/flox. We may chooseto apply linting there separately.
We could use
!docs/reference/command-referencein the glob patternsbut it feels more reliable to depend on the gitignore rules that we
already have in case the path changes at any time.
lint: Auto-fix omitted migrations dir
These were inconsistently linted until a recent commit that moved the
globbing to the config. This is the result of running: