LavaMoat / LavaMoat/lavamoat.github.io

SES incompatibility guide

Open
#19 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
MDX
Stars
3
Forks
3
PR merge metrics
No merged PRs in 30d

Description

We should have a guide on how to solve SES compatibility warnings. The three that I'm aware of are:

  • primordial mutation
  • dynamic require
  • strict mode violation

Future:

  • dynamic import (lavamoat/lavamoat#1566)

@lavamoat/node will link to the specific section(s) of the guide when these warnings are displayed. I'm unsure how @lavamoat/webpack handles this.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how @lavamoat/node displays SES compatibility warnings and determine how @lavamoat/webpack handles them. Create a guide covering primordial mutation, dynamic require, and strict mode violation, with a section for the future dynamic import warning. Done means @lavamoat/node can link to specific guide sections.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.