feat: rename parse-tags to javascript-tag-names

Author: BenoitZugmeyer

README.md

@@ -15,7 +15,7 @@
   - [`html/xml-extensions`](#htmlxml-extensions)
   - [`html/indent`](#htmlindent)
   - [`html/report-bad-indent`](#htmlreport-bad-indent)
-  - [`html/parse-tags`](#htmlparse-tags)
+  - [`html/javascript-tag-names`](#htmljavascript-tag-names)
   - [`html/javascript-mime-types`](#htmljavascript-mime-types)
 - [Troubleshooting](#troubleshooting)
   - [No file linted when running `eslint` on a directory](#no-file-linted-when-running-eslint-on-a-directory)
@@ -162,7 +162,7 @@ display errors. Example:
 }
 ```
 
-### `html/parse-tags`
+### `html/javascript-tag-names`
 
 By default, the code between `<script>` tags is considered as JavaScript. You can customize which
 tags should be considered JavaScript by providing one or multiple tag names.
@@ -173,7 +173,7 @@ Example:
 {
     "plugins": [ "html" ],
     "settings": {
-        "html/parse-tags": ["script", "customscript"],
+        "html/javascript-tag-names": ["script", "customscript"],
     }
 }
 ```

src/__tests__/extract.js

@@ -25,7 +25,7 @@ function test(params) {
     dedent(params.input),
     params.indent,
     params.xmlMode,
-    params.parseTags || ["script"],
+    params.javaScriptTagNames || ["script"],
     params.isJavaScriptMIMEType
   )
   expect(infos.code.map((code) => code.toString())).toMatchSnapshot()
@@ -331,6 +331,6 @@ it("extract multiple tags types", () => {
         var bar = 1;
       </customscript>
     `,
-    parseTags: ["script", "customscript"],
+    javaScriptTagNames: ["script", "customscript"],
   })
 })

src/extract.js

@@ -8,7 +8,7 @@ function iterateScripts(code, options, onChunk) {
 
   const xmlMode = options.xmlMode
   const isJavaScriptMIMEType = options.isJavaScriptMIMEType || (() => true)
-  const parseTags = options.parseTags || ['script']
+  const javaScriptTagNames = options.javaScriptTagNames || ['script']
   let index = 0
   let inScript = false
   let cdata = []
@@ -24,7 +24,7 @@ function iterateScripts(code, options, onChunk) {
     {
       onopentag(name, attrs) {
         // Test if current tag is a valid <script> tag.
-        if (!parseTags.includes(name)) {
+        if (!javaScriptTagNames.includes(name)) {
           return
         }
 
@@ -54,7 +54,7 @@ function iterateScripts(code, options, onChunk) {
       },
 
       onclosetag(name) {
-        if (!parseTags.includes(name) || !inScript) {
+        if (!javaScriptTagNames.includes(name) || !inScript) {
           return
         }
 
@@ -180,13 +180,13 @@ function* dedent(indent, slice) {
   }
 }
 
-function extract(code, indentDescriptor, xmlMode, parseTags, isJavaScriptMIMEType) {
+function extract(code, indentDescriptor, xmlMode, javaScriptTagNames, isJavaScriptMIMEType) {
   const badIndentationLines = []
   const codeParts = []
   let lineNumber = 1
   let previousHTML = ""
 
-  iterateScripts(code, { xmlMode, parseTags, isJavaScriptMIMEType }, (chunk) => {
+  iterateScripts(code, { xmlMode, javaScriptTagNames, isJavaScriptMIMEType }, (chunk) => {
     const slice = code.slice(chunk.start, chunk.end)
     if (chunk.type === "html") {
       const match = slice.match(/\r\n|\n|\r/g)

src/index.js

@@ -146,7 +146,7 @@ function patch(Linter) {
       textOrSourceCode,
       pluginSettings.indent,
       mode === "xml",
-      pluginSettings.parseTags,
+      pluginSettings.javaScriptTagNames,
       pluginSettings.isJavaScriptMIMEType
     )
 

src/settings.js

@@ -50,8 +50,9 @@ function getSettings(settings) {
     getSetting(settings, "xml-extensions") ||
     filterOut(defaultXMLExtensions, getSetting(settings, "html-extensions"))
 
-  const parseTags =
-    getSetting(settings, "parse-tags") || ["script"]
+  const javaScriptTagNames = getSetting(settings, "javascript-tag-names") || [
+    "script",
+  ]
 
   let reportBadIndent
   switch (getSetting(settings, "report-bad-indent")) {
@@ -105,7 +106,7 @@ function getSettings(settings) {
   return {
     htmlExtensions,
     xmlExtensions,
-    parseTags,
+    javaScriptTagNames,
     indent,
     reportBadIndent,
     isJavaScriptMIMEType,