Refactor code-style

Author: wooorm

lib/index.js

@@ -9,27 +9,26 @@
  * @typedef {Root|Child} Node
  * @typedef {import('unist').Point} Point
  * @typedef {import('sax').Tag} Tag
- *
  */
 
 import sax from 'sax'
 import {VFileMessage} from 'vfile-message'
 
-var Parser = sax.SAXParser
+const Parser = sax.SAXParser
 
-var fromCharCode = String.fromCharCode
+const fromCharCode = String.fromCharCode
 
-var search = /\r?\n|\r/g
+const search = /\r?\n|\r/g
 
 /**
  * @param {string|Uint8Array} doc
  */
 export function fromXml(doc) {
   // @ts-ignore `strictEntities` is most definitely fine.
-  var parser = new Parser(true, {position: true, strictEntities: true})
+  const parser = new Parser(true, {position: true, strictEntities: true})
   /** @type {Array.<Node>} */
-  var stack = [{type: 'root', children: []}]
-  var position = now()
+  const stack = [{type: 'root', children: []}]
+  let position = now()
 
   parser.ondoctype = ondoctype
   // @ts-ignore `onsgmldeclaration` is most definitely fine.
@@ -54,7 +53,7 @@ export function fromXml(doc) {
    * @returns {never}
    */
   function onerror(error) {
-    var index = error.message.indexOf('\nLine')
+    const index = error.message.indexOf('\nLine')
     // The substring should always be included, but this guards against
     // changes in newer sax versions.
     /* c8 ignore next */
@@ -75,24 +74,23 @@ export function fromXml(doc) {
   // eslint-disable-next-line complexity
   function ondoctype(value) {
     /** @type {Doctype} */
-    var node = {type: 'doctype', name: '', public: null, system: null}
-    var index = -1
-    var state = 'BEGIN'
+    const node = {type: 'doctype', name: '', public: null, system: null}
+    let index = -1
+    let state = 'BEGIN'
     /** @type {string} */
-    var returnState
+    let returnState
     /** @type {string} */
-    var buffer
-    /** @type {number} */
-    var bufferIndex
+    let buffer
     /** @type {number} */
-    var start
+    let bufferIndex
     /** @type {number} */
-    var marker
+    let start
     /** @type {number} */
-    var code
+    let marker
 
     while (++index <= value.length) {
-      code = index === value.length ? null /* EOF */ : value.charCodeAt(index)
+      const code =
+        index === value.length ? null /* EOF */ : value.charCodeAt(index)
 
       switch (state) {
         case 'BEGIN':
@@ -311,11 +309,11 @@ export function fromXml(doc) {
    */
   function oncomment(value) {
     /** @type {Comment} */
-    var node = {type: 'comment', value}
+    const node = {type: 'comment', value}
 
     // Comment has a positional bug… 😢
     // They end right before the last character (`>`), so let’s add that:
-    var actualEnd = now()
+    const actualEnd = now()
     actualEnd.column++
     actualEnd.offset++
 
@@ -348,18 +346,16 @@ export function fromXml(doc) {
    */
   function ontext(value) {
     /** @type {Text} */
-    var node = {type: 'text', value}
+    const node = {type: 'text', value}
     // Text has a positional bug… 😢
     // When they are added, the position is already at the next token.
     // So let’s reverse that.
-    var actualEnd = Object.assign({}, position)
-    var start = 0
-    /** @type {RegExpMatchArray} */
-    var match
+    const actualEnd = Object.assign({}, position)
+    let start = 0
 
     while (start < value.length) {
       search.lastIndex = start
-      match = search.exec(value)
+      const match = search.exec(value)
 
       if (match) {
         actualEnd.line++
@@ -441,6 +437,7 @@ export function fromXml(doc) {
  * @returns {boolean}
  */
 function isNameStartChar(code) {
+  // eslint-disable-next-line no-misleading-character-class
   return /[:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD]/.test(
     fromCharCode(code)
   )
@@ -455,6 +452,7 @@ function isNameStartChar(code) {
 function isNameChar(code) {
   return (
     isNameStartChar(code) ||
+    // eslint-disable-next-line no-misleading-character-class
     /[-.\d\u00B7\u0300-\u036F\u203F\u2040]/.test(fromCharCode(code))
   )
 }

package.json

@@ -76,9 +76,7 @@
   "xo": {
     "prettier": true,
     "rules": {
-      "no-misleading-character-class": "off",
-      "no-var": "off",
-      "prefer-arrow-callback": "off"
+      "#no-misleading-character-class": "off"
     }
   },
   "remarkConfig": {

readme.md

@@ -36,12 +36,12 @@ Say we have the following XML file, `example.xml`:
 And our script, `example.js`, looks as follows:
 
 ```js
-import fs from 'fs'
+import fs from 'node:fs'
 import {fromXml} from 'xast-util-from-xml'
 
-var doc = fs.readFileSync('example.xml')
+const doc = fs.readFileSync('example.xml')
 
-var tree = fromXml(doc)
+const tree = fromXml(doc)
 
 console.log(tree)
 ```

test/index.js

@@ -10,9 +10,9 @@ import test from 'tape'
 import {isHidden} from 'is-hidden'
 import {fromXml} from '../index.js'
 
-var join = path.join
+const join = path.join
 
-test('xast-util-from-xml', function (t) {
+test('xast-util-from-xml', (t) => {
   t.equal(typeof fromXml, 'function', 'should expose a function')
 
   try {
@@ -71,135 +71,135 @@ test('xast-util-from-xml', function (t) {
   }
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!doctype>')
     },
     /1:11: Expected doctype name/,
     'should throw on missing doctype name'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!doctype !>')
     },
     /1:13: Expected start of doctype name/,
     'should throw on invalid doctype name'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name[<!ELEMENT greeting (#PCDATA)>]>')
     },
     /1:47: Unexpected internal subset/,
     'should throw on internal subset directly after doctype name'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name [<!ELEMENT greeting (#PCDATA)>]>')
     },
     /1:48: Unexpected internal subset/,
     'should throw on internal subset after doctype name'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name!>')
     },
     /1:17: Expected doctype name character, whitespace, or doctype end/,
     'should throw on invalid character directly after doctype'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name !>')
     },
     /1:18: Expected external identifier \(`PUBLIC` or `SYSTEM`\), whitespace, or doctype end/,
     'should throw on invalid character after doctype'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name PUB>')
     },
     /1:20: Expected external identifier \(`PUBLIC` or `SYSTEM`\)/,
     'should throw on invalid external identifier (1)'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name SYSTEm>')
     },
     /1:23: Expected external identifier \(`PUBLIC` or `SYSTEM`\)/,
     'should throw on invalid external identifier (2)'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name PUBLIC>')
     },
     /1:23: Expected whitespace after `PUBLIC`/,
     'should throw on missing whitespace after public identifier'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name PUBLIC !>')
     },
     /1:25: Expected quote or apostrophe to start public literal/,
     'should throw on invalid character after public identifier'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name PUBLIC "🤔">')
     },
     /1:28: Expected pubid character in public literal/,
     'should throw on invalid character in public identifier'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name PUBLIC "literal"!>')
     },
     /1:34: Expected whitespace after public literal/,
     'should throw on invalid character after public literal'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name SYSTEM>')
     },
     /1:23: Expected whitespace after `SYSTEM`/,
     'should throw on missing whitespace after system identifier'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name SYSTEM !>')
     },
     /1:25: Expected quote or apostrophe to start system literal/,
     'should throw on invalid character after system identifier'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name SYSTEM "asd>')
     },
     /1:28: Unexpected end/,
     'should throw on unended system literal'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name SYSTEM "asd" [<!ELEMENT greeting (#PCDATA)>]>')
     },
     /1:61: Unexpected internal subset/,
     'should throw on internal subset after external id'
   )
 
   t.throws(
-    function () {
+    () => {
       fromXml('<!DOCTYPE name SYSTEM "asd" !>')
     },
     /1:31: Expected whitespace or end of doctype/,
@@ -209,10 +209,10 @@ test('xast-util-from-xml', function (t) {
   t.end()
 })
 
-test('fixtures', function (t) {
-  var base = join('test', 'fixtures')
-  var files = fs.readdirSync(base)
-  var index = -1
+test('fixtures', (t) => {
+  const base = join('test', 'fixtures')
+  const files = fs.readdirSync(base)
+  let index = -1
 
   while (++index < files.length) {
     if (!isHidden(files[index])) {
@@ -223,11 +223,11 @@ test('fixtures', function (t) {
   t.end()
 
   function each(/** @type {string} */ fixture) {
-    var input = fs.readFileSync(join(base, fixture, 'index.xml'))
-    var fp = join(base, fixture, 'index.json')
-    var actual = fromXml(input)
+    const input = fs.readFileSync(join(base, fixture, 'index.xml'))
+    const fp = join(base, fixture, 'index.json')
+    const actual = fromXml(input)
     /** @type {Node} */
-    var expected
+    let expected
 
     try {
       expected = JSON.parse(String(fs.readFileSync(fp)))