metalsmith-prism 4.2.4 → 5.0.0

package/lib/index.js

@@ -1,71 +1,63 @@
-'use strict';
+import { load } from 'cheerio';
+import { extname } from 'path';
+import Prism from 'prismjs';
+import loadLanguages from 'prismjs/components/index.js';
+import he from 'he';
 
-const cheerio = require( 'cheerio' );
-const debug = require( 'debug' )( 'metalsmith-prism' );
-const extname = require( 'path' ).extname;
-const languages = require( 'prismjs' ).languages;
-const Prism = require( 'prismjs' );
+// Import languages from Prism's default export
+const { languages } = Prism;
 
-const loadLanguages = require( 'prismjs/components/' );
+// Preload PHP
 loadLanguages( [ 'php' ] );
 
-const he = require( 'he' );
-
+/**
+ * Check if a file is HTML
+ * @param {string} filePath
+ * @returns {boolean}
+ */
 const isHTMLFile = ( filePath ) => {
   return /\.html|\.htm/.test( extname( filePath ) );
 };
 
+/**
+ * @typedef Options
+ * @property {boolean} [decode=false] - Whether to decode HTML entities
+ * @property {boolean} [lineNumbers=false] - Whether to add line numbers
+ * @property {string[]} [preLoad=[]] - Languages to preload
+ */
 
 /**
  * Metalsmith plugin to highlight code syntax with PrismJS
  *
- * @param {Object} options
- * @returns
+ * @param {Options} [options]
+ * @returns {import('metalsmith').Plugin}
  */
-
-module.exports = ( options ) => {
-
-  options = options || {};
-
+function metalsmithPrism( options = {} ) {
   if ( options.preLoad ) {
-    //list of available languages: https://github.com/PrismJS/prism/tree/master/components
     options.preLoad.forEach( ( language ) => {
       try {
-        require( `prismjs/components/prism-${ language }.js` );
+        loadLanguages( [ language ] );
       } catch ( e ) {
-        /* eslint no-console: 0 */
-        console.warn( `Failed to preload prism syntax: ${ language } !` );
+        console.warn( `Failed to preload prism syntax: ${ language }!` );
       }
     } );
   }
 
   /**
-   * requireLanguage
    * Require optional language package
-   *
-   * @param {*} language
+   * @param {string} language
    */
   function requireLanguage( language ) {
     if ( !languages[ language ] ) {
       try {
-        require( `prismjs/components/prism-${ language }.js` );
+        loadLanguages( [ language ] );
       } catch ( e ) {
-        /* eslint no-console: 0 */
-        console.warn( `Failed to load prism syntax: ${ language } !` );
+        console.warn( `Failed to load prism syntax: ${ language }!` );
       }
     }
   }
 
-
-  /**
-   * Prism hook "after-tokenize" used to add html for line numbers
-   * Neccessary as we don't have a browser
-   *
-   * Sources:
-   * https://github.com/PrismJS/prism/blob/master/plugins/line-numbers/prism-line-numbers.js#L109
-   * https://stackoverflow.com/questions/59508413/static-html-generation-with-prismjs-how-to-enable-line-numbers
-   *
-   */
+  // Set up line numbers
   const NEW_LINE_EXP = /\n(?!$)/g;
   let lineNumbersWrapper;
 
@@ -73,22 +65,19 @@ module.exports = ( options ) => {
     const match = env.code.match( NEW_LINE_EXP );
     const linesNum = match ? match.length + 1 : 1;
     const lines = new Array( linesNum + 1 ).join( '<span></span>' );
-
     lineNumbersWrapper = `<span aria-hidden="true" class="line-numbers-rows">${ lines }</span>`;
   } );
 
   return function( files, metalsmith, done ) {
-
     setImmediate( done );
 
     Object.keys( files ).forEach( file => {
-
       if ( !isHTMLFile( file ) ) {
         return;
       }
 
       const contents = files[ file ].contents.toString();
-      const $ = cheerio.load( contents, { decodeEntities: false }, true );
+      const $ = load( contents, { decodeEntities: false } );
       let highlighted = false;
       const code = $( 'code' );
 
@@ -96,12 +85,12 @@ module.exports = ( options ) => {
 
       code.each( function() {
         const $this = $( this );
+
         const className = $this.attr( 'class' ) || '';
         const targets = className.split( 'language-' );
-        let addLineNmbers = false;
+        let addLineNumbers = false;
 
         if ( targets.length > 1 ) {
-
           const $pre = $this.parent( 'pre' );
 
           if ( $pre ) {
@@ -109,9 +98,8 @@ module.exports = ( options ) => {
             $pre.addClass( className );
 
             if ( options.lineNumbers ) {
-              debug( 'adding line numbers' );
               $pre.addClass( 'line-numbers' );
-              addLineNmbers = true;
+              addLineNumbers = true;
             }
           }
 
@@ -122,10 +110,13 @@ module.exports = ( options ) => {
           if ( !languages[ language ] ) {
             language = 'markup';
           }
-          const html = ( language === 'markup' && !options.decode ) ? $this.html() : he.decode( $this.html() );
-          const highlightedCode = Prism.highlight( html, Prism.languages[ language ] );
-          $this.html( addLineNmbers ? highlightedCode + lineNumbersWrapper : highlightedCode );
 
+          const html = ( language === 'markup' && !options.decode )
+            ? $this.html()
+            : he.decode( $this.html() );
+
+          const highlightedCode = Prism.highlight( html, languages[ language ] );
+          $this.html( addLineNumbers ? highlightedCode + lineNumbersWrapper : highlightedCode );
         }
       } );
 
@@ -134,4 +125,6 @@ module.exports = ( options ) => {
       }
     } );
   };
-};
+}
+
+export default metalsmithPrism;

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "metalsmith-prism",
-  "version": "4.2.4",
+  "version": "5.0.0",
   "description": "Syntax highlighting for Metalsmith HTML templates using Prism.js",
+  "type": "module",
   "main": "lib/index.js",
+  "exports": "./lib/index.js",
   "engines": {
-    "node": ">= 14.0.0"
+    "node": ">= 18.0.0"
   },
   "scripts": {
     "preversion": "npm run test",
@@ -39,7 +41,6 @@
     "prismjs": "^1.29.0"
   },
   "devDependencies": {
-    "babel-eslint": "^7.2.3",
     "chai": "^5.1.2",
     "eslint": "^9.14.0",
     "eslint-config-prettier": "^9.1.0",