From e4cf2434038124db6c868196c241273b657a98be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Alet?= Date: Wed, 4 May 2022 10:50:17 +1100 Subject: [PATCH] Added TODO list for unsupported problems. --- README.md | 3 +++ TODO.md | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 TODO.md diff --git a/README.md b/README.md index d7de9c9..709bc09 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..cb6712f --- /dev/null +++ b/TODO.md @@ -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