Refactor code-style

Author: wooorm

lib/index.js

@@ -12,10 +12,14 @@
  *   When a typed array, must be UTF-8.
  *
  * @typedef AcornErrorFields
+ *   Extra fields in acorn errors.
  * @property {number} pos
+ *   Index.
  * @property {Position} loc
+ *   Acorn position.
  *
  * @typedef {Error & AcornErrorFields} AcornError
+ *   Acorn error.
  *
  * @callback Plugin
  *   Acorn plugin.
@@ -25,36 +29,39 @@
  *   Resulting parser class.
  *
  * @typedef {2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 2023 | 'latest'} Version
+ *   JavaScript version.
+ *
+ *   `'latest'` is equivalent to the latest supported year.
  *
  * @typedef Options
- *   Configuration (optional).
+ *   Configuration.
  * @property {Version | null | undefined} [version='latest']
- *   JavaScript version (year between 2015 and 2022 or `'latest'`).
+ *   JavaScript version (year between 2015 and 2023 or `'latest'`,
+ *   default: `'latest'`).
  *
- *   When a number, must be a year in the range `2015` and `2022` (both
+ *   When a number, must be a year in the range `2015` and `2023` (both
  *   including).
  *   `'latest'` is the same as passing the latest supported year.
  *
  *   > ☢️ **Danger**: `'latest'` is a sliding thing, you could consider it as
  *   > breaking semver.
  *   > Pass an actual year to lock that down.
  * @property {boolean | null | undefined} [module=false]
- *   Whether this is a module (ESM) or a script.
+ *   Whether this is a module (ESM) or a script (default: `false`).
  * @property {boolean | null | undefined} [allowReturnOutsideFunction=false]
- *   Whether a return statement is allowed in the top scope.
+ *   Whether a return statement is allowed in the top scope (default: `false`).
  * @property {boolean | null | undefined} [allowImportExportEverywhere=false]
- *   Whether import/export statements are allowed in the every scope.
+ *   Whether import/export statements are allowed in the every scope (default:
+ *   `false`).
  * @property {boolean | null | undefined} [allowAwaitOutsideFunction]
- *   Whether `await` is allowed in the top scope.
- *   Defaults to `version >= 2022`.
+ *   Whether `await` is allowed in the top scope (default: `version >= 2022`).
  * @property {boolean | null | undefined} [allowSuperOutsideMethod=false]
- *   Whether `super` is allowed outside methods.
+ *   Whether `super` is allowed outside methods (default: `false`).
  * @property {boolean | null | undefined} [allowHashBang=false]
- *   Whether a shell hasbang is allowed.
+ *   Whether a shell hasbang is allowed (default: `false`).
  * @property {Array<Plugin> | null | undefined} [plugins=[]]
- *   List of acorn plugins.
- *
- *   Examples are `acorn-jsx` and `acorn-stage3`.
+ *   List of acorn plugins (default: `[]`); examples are `acorn-jsx` and
+ *   `acorn-stage3`.
  */
 
 import {Parser} from 'acorn'
@@ -127,6 +134,6 @@ export function fromJs(value, options) {
 
   tree.comments = comments
 
-  // @ts-expect-error: similar enough.
+  // @ts-expect-error: Program in, program out.
   return fromEstree(tree)
 }

readme.md

@@ -154,7 +154,7 @@ Configuration (TypeScript type).
 
 JavaScript version ([`Version`][version], default: `'latest'`).
 
-When a number, must be a year in the range `2015` and `2022` (both including).
+When a number, must be a year in the range `2015` and `2023` (both including).
 `'latest'` is the same as passing the latest supported year.
 
 > ☢️ **Danger**: `'latest'` is a sliding thing, you could consider it as
@@ -224,7 +224,7 @@ JavaScript version (TypeScript type).
 ###### Type
 
 ```ts
-type Version = 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 'latest'
+type Version = 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 2023 | 'latest'
 ```
 
 ## Types

test/index.js

@@ -186,9 +186,8 @@ test('fromJs', async function (t) {
     })
   })
 
-  assert.deepEqual(
-    fromJs(new Uint8Array()),
-    {
+  await t.test('should support empty typed arrays', async function () {
+    assert.deepEqual(fromJs(new Uint8Array()), {
       type: 'Program',
       body: [],
       sourceType: 'script',
@@ -197,13 +196,11 @@ test('fromJs', async function (t) {
         start: {line: 1, column: 1, offset: 0},
         end: {line: 1, column: 1, offset: 0}
       }
-    },
-    'should support empty typed arrays'
-  )
+    })
+  })
 
-  assert.deepEqual(
-    fromJs(new TextEncoder().encode('let a = 1')),
-    {
+  await t.test('should support typed arrays', async function () {
+    assert.deepEqual(fromJs(new TextEncoder().encode('let a = 1')), {
       type: 'Program',
       body: [
         {
@@ -246,24 +243,8 @@ test('fromJs', async function (t) {
         start: {line: 1, column: 1, offset: 0},
         end: {line: 1, column: 10, offset: 9}
       }
-    },
-    'should support typed arrays'
-  )
-
-  assert.deepEqual(
-    fromJs(new Uint8Array()),
-    {
-      type: 'Program',
-      body: [],
-      sourceType: 'script',
-      comments: [],
-      position: {
-        start: {line: 1, column: 1, offset: 0},
-        end: {line: 1, column: 1, offset: 0}
-      }
-    },
-    'should support empty typed arrays'
-  )
+    })
+  })
 })
 
 test('fixtures', async function (t) {
@@ -302,7 +283,7 @@ test('fixtures', async function (t) {
         expected = JSON.parse(String(await fs.readFile(treeUrl)))
       } catch {
         // New fixture.
-        expected = JSON.stringify(actual, null, 2) + '\n'
+        expected = JSON.stringify(actual, undefined, 2) + '\n'
         await fs.writeFile(treeUrl, expected)
       }