Refactor

Author: wooorm

.gitignore

@@ -1,6 +1,6 @@
-.DS_Store
-*.d.ts
-*.log
 coverage/
 node_modules/
+*.d.ts
+*.log
+.DS_Store
 yarn.lock

lib/core.js

@@ -8,16 +8,16 @@
  * @typedef _Env A hidden Prism environment
  * @property {string} type
  * @property {string} tag
- * @property {Text|RefractorElement|Array.<Text|RefractorElement>} content
- * @property {Array.<string>} classes
- * @property {Object.<string, string>} attributes
+ * @property {Text|RefractorElement|Array<Text|RefractorElement>} content
+ * @property {Array<string>} classes
+ * @property {Record<string, string>} attributes
  * @property {string} language
  *
  * @typedef {import('hast').Root} Root
  * @typedef {import('hast').Element} Element
  * @typedef {import('hast').Text} Text
- * @typedef {Omit<Element, 'children'> & {children: Array.<RefractorElement|Text>}} RefractorElement
- * @typedef {Omit<Root, 'children'> & {children: Array.<RefractorElement|Text>}} RefractorRoot
+ * @typedef {Omit<Element, 'children'> & {children: Array<RefractorElement|Text>}} RefractorElement
+ * @typedef {Omit<Root, 'children'> & {children: Array<RefractorElement|Text>}} RefractorRoot
  *
  * @typedef {import('prismjs').Languages} Languages
  * @typedef {import('prismjs').Grammar} Grammar Whatever this is, Prism handles it.
@@ -122,13 +122,13 @@ function register(syntax) {
 /**
  * Register a new `alias` for the `name` language.
  *
- * @param {Object.<string, string|Array.<string>>|string} name
- * @param {string|Array.<string>} [alias]
+ * @param {Record<string, string|Array<string>>|string} name
+ * @param {string|Array<string>} [alias]
  * @returns {void}
  */
 function alias(name, alias) {
   const languages = refractor.languages
-  /** @type {Object.<string, string|Array.<string>>} */
+  /** @type {Record<string, string|Array<string>>} */
   let map = {}
 
   if (typeof name === 'string') {
@@ -215,11 +215,11 @@ function registered(language) {
 /**
  * List all registered languages (names and aliases).
  *
- * @returns {Array.<string>}
+ * @returns {Array<string>}
  */
 function listLanguages() {
   const languages = refractor.languages
-  /** @type {Array.<string>} */
+  /** @type {Array<string>} */
   const list = []
   /** @type {string} */
   let language
@@ -237,17 +237,17 @@ function listLanguages() {
 }
 
 /**
- * @param {string|_Token|Array.<string|_Token>} value
+ * @param {string|_Token|Array<string|_Token>} value
  * @param {string} language
- * @returns {Text|RefractorElement|Array.<Text|RefractorElement>}
+ * @returns {Text|RefractorElement|Array<Text|RefractorElement>}
  */
 function stringify(value, language) {
   if (typeof value === 'string') {
     return {type: 'text', value}
   }
 
   if (Array.isArray(value)) {
-    /** @type {Array.<Text|RefractorElement>} */
+    /** @type {Array<Text|RefractorElement>} */
     const result = []
     let index = -1
 
@@ -302,8 +302,8 @@ function encode(tokens) {
 }
 
 /**
- * @param {Object.<string, string>} attrs
- * @returns {Object.<string, string>}
+ * @param {Record<string, string>} attrs
+ * @returns {Record<string, string>}
  */
 function attributes(attrs) {
   /** @type {string} */

package.json

@@ -78,13 +78,13 @@
     "xo": "^0.46.0"
   },
   "scripts": {
-    "prepack": "npm run build && npm run format",
-    "build": "rimraf \"{lang/**,lib/**,script/**,test/**,}*.d.ts\" && tsc && type-coverage",
     "generate": "node script/languages.js && node script/list.js && node script/fixtures.js",
+    "prepublishOnly": "npm run build && npm run format",
+    "build": "rimraf \"{lang,lib,script,test}/**/*.d.ts\" \"*.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "test-api": "node test/index.js",
-    "test-coverage": "c8 -x \"lang/*.js\" --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test/index.js",
-    "test": "npm run build && npm run generate && npm run format && npm run test-coverage"
+    "test-api": "node --conditions development test/index.js",
+    "test-coverage": "c8 -x \"lang/*.js\" --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov npm run test-api",
+    "test": "npm run generate && npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,
@@ -117,6 +117,7 @@
     "atLeast": 100,
     "detail": true,
     "strict": true,
+    "ignoreCatch": true,
     "ignoreFiles": [
       "lang/*.d.ts"
     ]

readme.md

@@ -144,8 +144,8 @@ Register a new `alias` for the `name` language.
 
 *   `name` (`string`) — [Name][names] of a registered language
 *   `alias` (`string`) — New alias for the registered language
-*   `list` (`Array.<alias>`) — List of aliases
-*   `aliases` (`Object.<alias|list>`) — Map where each key is a `name` and each
+*   `list` (`Array<alias>`) — List of aliases
+*   `aliases` (`Record<alias|list>`) — Map where each key is a `name` and each
     value an `alias` or a `list`
 
 ###### Example
@@ -228,7 +228,7 @@ List all registered languages ([names and aliases][syntax]).
 
 ###### Returns
 
-`Array.<string>`.
+`Array<string>`.
 
 ###### Example
 

script/data.js

@@ -3,7 +3,7 @@ import path from 'node:path'
 // @ts-expect-error: untyped.
 import getLoader from 'prismjs/dependencies.js'
 
-/** @type {{languages: Object.<string, unknown>}} */
+/** @type {{languages: Record<string, unknown>}} */
 const components = JSON.parse(
   String(
     fs.readFileSync(path.join('node_modules', 'prismjs', 'components.json'))
@@ -14,10 +14,10 @@ const allLanguages = Object.keys(components.languages).filter(
   (d) => d !== 'meta'
 )
 
-/** @type {Array.<string>} */
+/** @type {Array<string>} */
 export const all = getLoader(components, allLanguages).getIds()
 
-/** @type {Array.<string>} */
+/** @type {Array<string>} */
 export const common = getLoader(components, [
   // These are alphabetical, but they are exported in registration order.
   // They are based on the languages that lowlight exports as common,

script/languages.js

@@ -14,7 +14,7 @@ import alphaSort from 'alpha-sort'
 import {all} from './data.js'
 import {toId} from './to-id.js'
 
-/** @type {{languages: Object.<string, {require: string|string[], alias: string|string[]}>}} */
+/** @type {{languages: Record<string, {require: string|string[], alias: string|string[]}>}} */
 const components = JSON.parse(
   String(
     fs.readFileSync(path.join('node_modules', 'prismjs', 'components.json'))

script/list.js

@@ -18,7 +18,7 @@ console.log(
 )
 
 /**
- * @param {Array.<string>} list
+ * @param {Array<string>} list
  */
 function generate(list) {
   return [

script/support.js

@@ -33,11 +33,11 @@ async function transformer(tree) {
  * @param {string} name
  */
 async function one(name) {
-  /** @type {Array.<string>} */
+  /** @type {Array<string>} */
   // Unknown stuff to TS.
   // type-coverage:ignore-next-line
   const aliases = (await import('../lang/' + name + '.js')).default.aliases
-  /** @type {Array.<PhrasingContent>} */
+  /** @type {Array<PhrasingContent>} */
   const content = [
     u(
       'link',

tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "include": ["index.js", "lib/**/*.js", "script/**/*.js", "test/**/*.js"],
+  "include": ["lib/**/*.js", "script/**/*.js", "test/**/*.js", "*.js"],
   "compilerOptions": {
     "target": "ES2020",
     "lib": ["ES2020"],