penrose 0.2.45 → 0.3.0

package/.envrc

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+version_gte() {
+    local cmd="$1"
+    local required_version="$2"
+    local installed_version=$($cmd | grep -oE "[0-9]+(\.[0-9]+)+" | head -n 1)
+
+    if [ -z "$installed_version" ]; then
+        return 1
+    fi
+
+    IFS="."
+    set -- $installed_version
+    local installed_parts="$@"
+    set -- $required_version
+    local required_parts="$@"
+    unset IFS
+
+    local i=1
+    for required_part in $required_parts; do
+        installed_part=$(echo "$installed_parts" | cut -d " " -f $i)
+        if [ "${installed_part:-0}" -lt "$required_part" ]; then
+            return 1
+        elif [ "${installed_part:-0}" -gt "$required_part" ]; then
+            return 0
+        fi
+        i=$((i + 1))
+    done
+
+    return 0
+}
+
+if type nix-shell >/dev/null 2>&1; then
+    if ! has devenv; then
+        # Install devenv v1.x. Hash from https://www.nixhub.io/packages/devenv
+        if version_gte "nix --version" "2.30.0"; then
+            nix profile add github:NixOS/nixpkgs/80d901ec0377e19ac3f7bb8c035201e2e098cc97#devenv
+        else
+            nix profile install github:NixOS/nixpkgs/80d901ec0377e19ac3f7bb8c035201e2e098cc97#devenv
+        fi
+    fi
+
+    eval "$(devenv direnvrc)"
+    use devenv
+else
+    echo "nix-shell is not available. Install Nix: https://nixos.org/download"
+fi

package/.github/workflows/ci.yaml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -y -qq graphicsmagick
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24.15.0
+          cache: npm
+
+      - name: Install Node dependencies
+        run: npm ci
+
+      - name: Run Node tests
+        run: npm test

package/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+default_language_version:
+  node: 24.15.0
+
+default_stages: [pre-commit]
+
+fail_fast: true
+
+repos:
+  - repo: local
+    hooks:
+      - id: nixfmt
+        name: nixfmt
+        entry: nixfmt
+        language: system
+        files: \.nix$
+
+      - id: format-js
+        name: Format JS
+        language: system
+        entry: npx prettier --parser babel --write
+        files: ^(lib)/.*\.(js|jsx|cjs|mjs)$
+        pass_filenames: true

package/Makefile

@@ -0,0 +1,38 @@
+ifneq ($(shell which tput),)
+	ifneq ($(TERM),)
+		RED    := $(shell tput setaf 1)
+		GREEN  := $(shell tput setaf 2)
+		YELLOW := $(shell tput setaf 3)
+		CYAN   := $(shell tput setaf 6)
+		RESET  := $(shell tput sgr0)
+	endif
+endif
+
+format:
+	@echo "Formatting code..."
+	pre-commit run format-js --all-files
+
+bump-version:
+	@BUMP=$(word 2,$(MAKECMDGOALS)); \
+	VALID_BUMP="major minor patch premajor preminor prepatch prerelease"; \
+	if [ -z "$$BUMP" ]; then \
+		echo "$(RED)Error: Bump is required.$(RESET)"; \
+		echo "Usage: make bump-version [major|minor|patch|premajor|preminor|prepatch|prerelease]"; \
+		exit 1; \
+	fi; \
+	if ! echo "$$VALID_BUMP" | grep -qw "$$BUMP"; then \
+		echo "$(RED)Error: Invalid bump '$$BUMP'.$(RESET)"; \
+		echo "Must be one of: $(CYAN)$$VALID_BUMP$(RESET)"; \
+		exit 1; \
+	fi; \
+	npm version $$BUMP;
+
+create-release:
+	@VERSION=$$(npm pkg get version --browser=false | tr -d '"'); \
+	gh release create $$VERSION;
+
+# Prevent make from treating arguments to bump-version as targets
+ifeq (bump-version,$(firstword $(MAKECMDGOALS)))
+%:
+	@:
+endif

package/README.md

@@ -1,4 +1,4 @@
-# Penrose [![CircleCI](https://circleci.com/gh/netbek/penrose.svg?style=svg)](https://circleci.com/gh/netbek/penrose)
+# Penrose
 
 Build derivative images.
 

package/devenv.lock

@@ -0,0 +1,123 @@
+{
+  "nodes": {
+    "devenv": {
+      "locked": {
+        "dir": "src/modules",
+        "lastModified": 1770833792,
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "1e5f2d43973d3f4a6e7bf3e13fd39e0c4d9af3de",
+        "type": "github"
+      },
+      "original": {
+        "dir": "src/modules",
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1767039857,
+        "owner": "NixOS",
+        "repo": "flake-compat",
+        "rev": "5edf11c44bc78a0d334f6334cdaf7d60d732daab",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "git-hooks": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1770726378,
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "rev": "5eaaedde414f6eb1aea8b8525c466dc37bba95ae",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "git-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1762808025,
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "cb5e3fdca1de58ccbc3ef53de65bd372b48f567c",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "inputs": {
+        "nixpkgs-src": "nixpkgs-src"
+      },
+      "locked": {
+        "lastModified": 1770434727,
+        "owner": "cachix",
+        "repo": "devenv-nixpkgs",
+        "rev": "8430f16a39c27bdeef236f1eeb56f0b51b33d348",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "rolling",
+        "repo": "devenv-nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-src": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1769922788,
+        "narHash": "sha256-H3AfG4ObMDTkTJYkd8cz1/RbY9LatN5Mk4UF48VuSXc=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "207d15f1a6603226e1e223dc79ac29c7846da32e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devenv": "devenv",
+        "git-hooks": "git-hooks",
+        "nixpkgs": "nixpkgs",
+        "pre-commit-hooks": [
+          "git-hooks"
+        ]
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

package/devenv.nix

@@ -0,0 +1,39 @@
+{
+  pkgs,
+  lib,
+  config,
+  inputs,
+  ...
+}:
+{
+  env.DEVENV_TASKS_QUIET = 1;
+
+  packages = with pkgs; [
+    graphicsmagick
+    nixfmt
+    pre-commit
+  ];
+
+  languages = {
+    javascript = {
+      enable = true;
+      package = pkgs.nodejs_24;
+      npm = {
+        enable = true;
+        install = {
+          enable = true;
+        };
+      };
+    };
+  };
+
+  dotenv = {
+    disableHint = true;
+  };
+
+  enterShell = ''
+    if [ -d ".git" ]; then
+      pre-commit install --overwrite > /dev/null 2>&1
+    fi
+  '';
+}

package/devenv.yaml

@@ -0,0 +1,4 @@
+# yaml-language-server: $schema=https://devenv.sh/devenv.schema.json
+inputs:
+  nixpkgs:
+    url: github:cachix/devenv-nixpkgs/rolling

package/lib/__tests__/penrose.test.js

@@ -217,54 +217,4 @@ describe('Penrose', () => {
       await fs.remove(path.join(dir, 'data/files/styles'));
     });
   });
-
-  describe('createMathFile', () => {
-    test('Should create math files', async () => {
-      await fs.remove(path.join(dir, 'data/files/math'));
-
-      const math = [
-        {
-          data: 'E = mc^2',
-          format: 'tex'
-        }
-      ];
-
-      const tasks = [];
-      const expected = [];
-
-      _.forEach(math, function (value) {
-        const outputFormat = 'svg';
-        const task = {
-          input: value.data,
-          inputFormat: value.format,
-          outputFormat: outputFormat
-        };
-        const filename = penrose.getMathFilename(task);
-        task.output = penrose.getMathPath(outputFormat, filename);
-
-        tasks.push(task);
-
-        expected.push(
-          path.join(config.schemes.public.path, 'math/svg', filename)
-        );
-      });
-
-      await Promise.mapSeries(tasks, function (task) {
-        return penrose.createMathFile(task);
-      });
-
-      const actual = await multiGlob(
-        _.map(config.schemes, function (scheme) {
-          return scheme.path + 'math/**/*';
-        }),
-        {
-          nodir: true
-        }
-      );
-
-      expect(actual).toEqual(expected);
-
-      await fs.remove(path.join(dir, 'data/files/math'));
-    });
-  });
 });

package/lib/penrose.js

@@ -1,12 +1,7 @@
 const _ = require('lodash');
-const canonStringify = require('canonical-json/index2');
 const chalk = require('chalk');
-const cheerio = require('cheerio');
-const crypto = require('crypto');
 const fs = require('fs-extra');
-const mathjax = require('mathjax-node/lib/mj-single.js');
 const path = require('path');
-const pkg = require('../package.json');
 const Promise = require('bluebird');
 const replaceExt = require('replace-ext');
 const sharp = require('sharp');
@@ -20,10 +15,6 @@ const JPEG = 'jpeg';
 const PNG = 'png';
 const SVG = 'svg';
 const WEBP = 'webp';
-const TEX = 'tex';
-const INLINE_TEX = 'inline-tex';
-const ASCIIMATH = 'asciimath';
-const MATHML = 'mathml';
 const RESIZE = 'resize';
 
 const EXTNAME_FORMAT_MAP = {
@@ -39,13 +30,6 @@ const FORMAT_EXTNAME_MAP = {
   [WEBP]: 'webp'
 };
 
-const MATHJAX_FORMAT_MAP = {
-  [TEX]: 'TeX',
-  [INLINE_TEX]: 'inline-TeX',
-  [ASCIIMATH]: 'AsciiMath',
-  [MATHML]: 'MathML'
-};
-
 const JPEG_OPTIONS = [
   'quality',
   'progressive',
@@ -89,57 +73,6 @@ const RESIZE_OPTIONS = [
 
 Promise.promisifyAll(fs);
 
-/**
- *
- * @param   {string} value
- * @param   {number} ex
- * @returns {number}
- */
-function exToPx(value, ex) {
-  const match = value.match(/^(.+)ex$/i);
-
-  if (match) {
-    return Number(match[1]) * ex;
-  }
-
-  return Number(value);
-}
-
-/**
- *
- * @param   {Object} args
- * @returns {Promise}
- */
-function typesetMath(args) {
-  const format = MATHJAX_FORMAT_MAP[args.inputFormat];
-
-  if (_.isUndefined(format)) {
-    throw new Error('Input format `' + args.inputFormat + '` is not supported');
-  }
-
-  if (!~[SVG].indexOf(args.outputFormat)) {
-    throw new Error(
-      'Output format `' + args.outputFormat + '` is not supported'
-    );
-  }
-
-  return new Promise((resolve, reject) => {
-    const config = _.assign(_.pick(args, ['ex', 'width']), {
-      math: args.input,
-      format: format,
-      svg: true
-    });
-
-    mathjax.typeset(config, (result) => {
-      if (result.errors) {
-        reject(result.errors);
-      } else {
-        resolve(result);
-      }
-    });
-  });
-}
-
 /**
  *
  * @param   {Object} config
@@ -147,30 +80,8 @@ function typesetMath(args) {
  */
 function Penrose(config) {
   this.config = {
-    ...config,
-    math: {
-      displayErrors: false,
-      displayMessages: false,
-      undefinedCharError: false,
-      MathJax: {
-        SVG: {
-          font: 'TeX'
-        }
-      },
-      ex: 6, // ex-size in pixels
-      width: 100, // Width of container (in ex) for linebreaking and tags
-      ...config.math
-    }
+    ...config
   };
-
-  mathjax.config(
-    _.pick(this.config.math, [
-      'displayErrors',
-      'displayMessages',
-      'undefinedCharError',
-      'MathJax'
-    ])
-  );
 }
 
 Penrose.prototype = {
@@ -234,140 +145,7 @@ Penrose.prototype = {
       return transformer.toFile(distPath).then(() => distPath);
     });
   },
-  /**
-   *
-   * @param   {Object} args
-   * @returns {Promise}
-   */
-  createMath: function (args) {
-    console.log('Typesetting math', chalk.cyan(args.input));
-
-    const config = _.assign(
-      _.pick(this.config.math, ['ex', 'width']),
-      _.pick(args, ['input', 'inputFormat', 'outputFormat', 'ex', 'width'])
-    );
-
-    if (SVG === config.outputFormat) {
-      return typesetMath(config).then((result) => {
-        const $svg = cheerio.load(result.svg)('svg');
-        const width = Math.ceil(exToPx($svg.attr('width'), config.ex));
-        const height = Math.ceil(exToPx($svg.attr('height'), config.ex));
-
-        return Promise.resolve({
-          data: result.svg,
-          width: width,
-          height: height
-        });
-      });
-    }
-
-    throw new Error(
-      'Output format `' + config.outputFormat + '` is not supported'
-    );
-  },
-  /**
-   *
-   * @param   {Object} args
-   * @returns {Promise}
-   */
-  createMathDataURIBase64: function (args) {
-    console.log('Typesetting math', chalk.cyan(args.input));
-
-    const config = _.assign(
-      _.pick(this.config.math, ['ex', 'width']),
-      _.pick(args, ['input', 'inputFormat', 'outputFormat', 'ex', 'width'])
-    );
-
-    if (SVG === config.outputFormat) {
-      return typesetMath(config).then((result) => {
-        const buffer = Buffer.from(result.svg, 'utf-8');
 
-        return Promise.resolve(
-          'data:image/svg+xml;base64,' + buffer.toString('base64')
-        );
-      });
-    }
-
-    if (PNG === config.outputFormat) {
-      config.outputFormat = SVG;
-
-      return typesetMath(config)
-        .then((result) => {
-          const buffer = Buffer.from(result.svg, 'utf-8');
-          const $svg = cheerio.load(result.svg)('svg');
-          const width = Math.ceil(exToPx($svg.attr('width'), config.ex));
-          const height = Math.ceil(exToPx($svg.attr('height'), config.ex));
-          const resize = {
-            width: width,
-            height: height
-          };
-
-          return sharp(buffer).resize(resize).toBuffer();
-        })
-        .then((buffer) =>
-          Promise.resolve('data:image/png;base64,' + buffer.toString('base64'))
-        );
-    }
-
-    throw new Error(
-      'Output format `' + config.outputFormat + '` is not supported'
-    );
-  },
-  /**
-   *
-   * @param   {Object} args
-   * @returns {Promise}
-   */
-  createMathFile: function (args) {
-    console.log('Typesetting math', chalk.cyan(args.input));
-
-    const config = _.assign(
-      _.pick(this.config.math, ['ex', 'width']),
-      _.pick(args, [
-        'input',
-        'inputFormat',
-        'output',
-        'outputFormat',
-        'ex',
-        'width'
-      ])
-    );
-    const outputResolved = this.resolvePath(config.output);
-
-    if (SVG === config.outputFormat) {
-      return fs
-        .mkdirp(path.dirname(outputResolved))
-        .then(() => typesetMath(config))
-        .then((result) =>
-          fs.writeFileAsync(outputResolved, result.svg, 'utf-8')
-        );
-    }
-
-    if (PNG === config.outputFormat) {
-      config.outputFormat = SVG;
-
-      return fs
-        .mkdirp(path.dirname(outputResolved))
-        .then(() => typesetMath(config))
-        .then((result) => {
-          const buffer = Buffer.from(result.svg, 'utf-8');
-          const $svg = cheerio.load(result.svg)('svg');
-          const width = Math.ceil(exToPx($svg.attr('width'), config.ex));
-          const height = Math.ceil(exToPx($svg.attr('height'), config.ex));
-          const resize = {
-            width: width,
-            height: height
-          };
-
-          return sharp(buffer).resize(resize).toBuffer();
-        })
-        .then((buffer) => fs.writeFileAsync(outputResolved, buffer));
-    }
-
-    throw new Error(
-      'Output format `' + config.outputFormat + '` is not supported'
-    );
-  },
   /**
    *
    * @param   {string} uri
@@ -382,6 +160,7 @@ Penrose.prototype = {
 
     return uri.substring(0, index);
   },
+
   /**
    *
    * @param   {string} uri
@@ -391,6 +170,7 @@ Penrose.prototype = {
   setScheme: function (uri, scheme) {
     return scheme + '://' + this.getTarget(uri);
   },
+
   /**
    *
    * @param   {string} uri
@@ -405,6 +185,7 @@ Penrose.prototype = {
 
     return uri.substring(index + 3);
   },
+
   /**
    * Returns absolute URL.
    *
@@ -420,6 +201,7 @@ Penrose.prototype = {
 
     return uri;
   },
+
   /**
    *
    * @param   {string} uri
@@ -443,6 +225,7 @@ Penrose.prototype = {
 
     return schemePath + target;
   },
+
   /**
    *
    * @param   {string} styleName
@@ -467,6 +250,7 @@ Penrose.prototype = {
 
     return scheme + '://styles/' + styleName + '/' + target;
   },
+
   /**
    * Returns absolute URL to derivative image.
    *
@@ -483,75 +267,6 @@ Penrose.prototype = {
       return '/' + this.resolvePath(uri);
     }
 
-    throw new Error('Scheme `' + scheme + '` not supported');
-  },
-  /**
-   *
-   * @param   {Object} args
-   * @returns {string}
-   */
-  getMathDigest: function (args) {
-    const config = _.assign(
-      _.pick(this.config.math, ['ex', 'width']),
-      _.pick(args, ['ex', 'width'])
-    );
-
-    const data =
-      pkg.version + ';' + canonStringify(config) + ';' + args.input.trim();
-
-    return crypto.createHash('md5').update(data).digest('hex');
-  },
-  /**
-   *
-   * @param   {Object} args
-   * @returns {string}
-   */
-  getMathFilename: function (args) {
-    let ext;
-
-    if (SVG === args.outputFormat) {
-      ext = '.svg';
-    } else if (PNG === args.outputFormat) {
-      ext = '.png';
-    } else {
-      throw new Error('Format `' + args.outputFormat + '` is not supported');
-    }
-
-    return this.getMathDigest(args) + ext;
-  },
-  /**
-   *
-   * @param   {string} outputFormat
-   * @param   {string} uri
-   * @returns {string}
-   */
-  getMathPath: function (outputFormat, uri) {
-    let scheme = this.getScheme(uri);
-    let target;
-
-    if (_.isUndefined(scheme)) {
-      scheme = PUBLIC;
-      target = uri;
-    } else {
-      target = this.getTarget(uri);
-    }
-
-    return scheme + '://math/' + outputFormat + '/' + target;
-  },
-  /**
-   *
-   * @param   {string} outputFormat
-   * @param   {string} path
-   * @returns {string}
-   */
-  getMathURL: function (outputFormat, path) {
-    const uri = this.getMathPath(outputFormat, path);
-    const scheme = this.getScheme(uri);
-
-    if (PUBLIC === scheme || TEMPORARY === scheme) {
-      return '/' + this.resolvePath(uri);
-    }
-
     throw new Error('Scheme `' + scheme + '` not supported');
   }
 };
@@ -561,10 +276,6 @@ module.exports = {
   PNG,
   SVG,
   WEBP,
-  TEX,
-  INLINE_TEX,
-  ASCIIMATH,
-  MATHML,
   RESIZE,
   PUBLIC,
   TEMPORARY,

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "penrose",
-  "version": "0.2.45",
+  "version": "0.3.0",
   "description": "Build derivative images",
   "main": "lib/penrose.js",
   "repository": {
     "type": "git",
-    "url": "git://github.com/netbek/penrose"
+    "url": "git://github.com/netbek/penrose.git"
   },
   "scripts": {
-    "format-js": "prettier --parser babel --write \"lib/**/*.js\"",
     "test": "vitest run"
   },
   "author": {
@@ -21,34 +20,30 @@
     "url": "https://github.com/netbek/penrose/issues"
   },
   "dependencies": {
-    "@babel/core": "7.26.0",
+    "@babel/core": "7.29.0",
     "babel-eslint": "10.1.0",
     "babel-loader": "8.4.1",
     "babel-plugin-lodash": "3.3.4",
     "babel-plugin-transform-class-properties": "6.24.1",
     "bluebird": "3.7.2",
-    "canonical-json": "0.0.4",
     "chalk": "4.1.2",
-    "cheerio": "0.22.0",
-    "fs-extra": "11.2.0",
-    "glob": "7.2.3",
-    "glob-promise": "4.2.2",
-    "lodash": "4.17.21",
+    "fs-extra": "11.3.5",
+    "glob-promise": "6.0.7",
+    "lodash": "4.18.1",
     "lodash-webpack-plugin": "0.11.6",
-    "mathjax": "2.7.9",
-    "mathjax-node": "0.5.2",
     "phantomjs-prebuilt": "2.1.16",
-    "prettier": "3.3.3",
+    "prettier": "3.8.3",
     "replace-ext": "2.0.0",
-    "sharp": "0.33.5"
+    "sharp": "0.34.5"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "7.18.0",
-    "@typescript-eslint/parser": "7.18.0",
+    "@typescript-eslint/eslint-plugin": "8.59.2",
+    "@typescript-eslint/parser": "8.59.2",
     "eslint": "8.57.1",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-prettier": "5.2.1",
-    "typescript": "5.6.3",
-    "vitest": "2.1.5"
+    "eslint-config-prettier": "9.1.2",
+    "eslint-plugin-prettier": "5.5.5",
+    "npm-check-updates": "22.1.1",
+    "typescript": "6.0.3",
+    "vitest": "3.2.4"
   }
 }

package/.circleci/config.yml

@@ -1,17 +0,0 @@
-version: 2
-jobs:
-  build:
-    docker:
-      - image: cimg/node:20.10.0-browsers
-    steps:
-      - checkout
-      - run:
-          name: Install dependencies
-          command: |
-            sudo npm install -g bower grunt-cli gulp-cli
-            sudo apt-get update -qq
-            sudo apt-get install -y -qq graphicsmagick
-            npm ci
-      - run:
-          name: Run tests
-          command: npm test