Skip to content

Commit

Permalink
Added TODO list for unsupported problems.
Browse files Browse the repository at this point in the history
  • Loading branch information
tamere-allo-peter committed May 3, 2022
1 parent b8bacbf commit e4cf243
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,9 @@ yamlfixer currently (as of 0.6.4) can fix the following problems as reported by
An always up-to-date list of fixers can be obtained with `yamlfixer --listfixers`.
Please read our [TODO list](https://github.com/opt-nc/yamlfixer/blob/main/TODO.md)
to see which problems are still unsupported but which we plan to support some day.
**IMPORTANT : fixing syntax errors is done on a best effort basis and
may work only partially or not at all for you. Use the -N|--nosyntax
command line switch do prevent `yamlfixer` from trying to fix syntax
Expand Down
19 changes: 19 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# TODO

Here's a list of problems reported by yamllint which are not currently
supported by yamlfixer, but which might be supported in a future
release :

* too few spaces inside brackets
* too few spaces inside empty brackets
* too many spaces after question mark
* missing document end "..."
* found forbidden document end "..."
* found forbidden document start "---"
* wrong new line character: expected \\r\\n
* wrong new line character: expected \\n
* forbidden implicit octal value "%s"
* forbidden explicit octal value "%s"
* string value is not quoted with %s quotes
* string value is not quoted
* string value is redundantly quoted with %s quotes

0 comments on commit e4cf243

Please sign in to comment.