JuliaDocs/Documenter.jl

Reconsider how we deploy JS assets (aka. let's get rid of RequireJS)

Open

#2,158 opened on Jun 29, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (910 stars) (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Description

Right now, we take all the .js files from here and "compile" them into a single JS file where each of them also gets wrapped in a RequireJS require call. The idea here, back in the day, was to separate the JS snippets from each other (e.g. so that you wouldn't get variable name clashes), and to manage their dependencies.

But RequireJS is a bit dated, and is slowly starting to cause problems. Not all JS libraries are ameanable to it anymore, for example.

This is low-priority, but we should think how to architect a better system here that keeps the two properties: (1) Isolation of the different modules, and (2) still allows us to manage dependencies somehow (e.g. that we wouldn't just load multiple versions of the same library). Maybe we can use native JS modules or something nowadays?

X-refs:

  • #1247
  • #1433
  • #2471
  • #1433
  • #2702

Contributor guide

Tech stack
javascript
Domain
frontendbuild system
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of JavaScript modulesFamiliarity with RequireJSKnowledge of JavaScript build tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Look into alternatives to RequireJS for bundling JavaScript modules, such as ES modules with a bundler like Rollup or Webpack. Consider how to maintain module isolation and dependency management. Check existing issues #1247, #1433, #2471, #2702 for prior discussions. Propose a concrete architecture change.