naokazuterada / MarkdownTOC

SublimeText3 plugin which generate a table of contents (TOC) in a markdown document.
https://packagecontrol.io/packages/MarkdownTOC
MIT License
301 stars 48 forks source link

Attribute "levels" prevents generation #166

Open PpChailley opened 1 year ago

PpChailley commented 1 year ago
  1. parameter setting seems to not work
  2. documentation should be updated -> https://packagecontrol.io/packages/MarkdownTOC#control-of-levels-listed-in-toc

How can the issue be reproduced

Using the syntax default.levels="1,2" in XML comment, it works as expected. Using similar redundant syntax in config files does not work

"defaults": 
  {
    "default.levels": "1",
    ...
  }

Context

Packages/MarkdownTOC/MarkdownTOC.sublime-settings

{
  "defaults": {
    "autoanchor": false,
    "autolink": false,
    "bracket": "round",
    "levels": [1,2,3,4,5,6],
    "indent": "\t",
    "remove_image": true,
    "link_prefix": "",
    "bullets": ["-"],
    "lowercase": "only_ascii",
    "style": "unordered",
    "uri_encoding": true,
    "markdown_preview": ""
  },
  "id_replacements": [
    {
      "pattern": "\\s+",
      "replacement": "-"
    },
    {
      "pattern": "&lt;|&gt;|&amp;|&apos;|&quot;|&#60;|&#62;|&#38;|&#39;|&#34;|!|#|$|&|'|\\(|\\)|\\*|\\+|,|/|:|;|=|\\?|@|\\[|\\]|`|\"|\\.|\\\\|<|>|{|}|™|®|©|%",
      "replacement": ""
    }
  ],
  "logging": false
}

Packages/User/MarkdownTOC.sublime-settings

{
  "defaults": 
  {
    "autolink": true,
    "autoanchor": true,
    // "bracket": "square",
    // "levels": "1,2",
    "indent": "    ",
    // "remove_image": false,
    // "bullets": "*",
    "style": "unordered",

  },
  "id_replacements": 
  [
    {
      "pattern": "\\s+",
      "replacement": "-"
    },
    {
      "pattern": "&lt;|&gt;|&amp;|&apos;|&quot;|&#60;|&#62;|&#38;|&#39;|&#34;|!|#|$|&|'|\\(|\\)|\\*|\\+|,|/|:|;|=|_|\\?|@|\\[|\\]|`|\"|\\.|<|>|{|}|™|®|©",
      "replacement": ""
    },
    {
      "pattern": "&eacute;|é|&egrave;|è|&ecirc;|ê",
      "replacement": "e"
    },
    {
      "pattern": "&aacute;|&agrave;|à|&acirc;|â",
      "replacement": "a"
    }

  ],

}

What was expected

TOC should be (re)generated with appropriate levels included

What actually occurred

As soon as this config item is specified (either un user config file or XML comment), generating the TOC doesn't work (no change in file) Strangely, the parameter exists in global config file and it stil works

What was the version of the involved component

Markdown TOC v4.1.2 Sublime text build 4143 win10