antfu/magic-string-stack

magic-string with the capability of committing changes.

magic-string-stack

magic-string with the capability of committing changes.

One of the great features of MagicString is that it always relates to the original string positions. However, in some cases, you want to make changes on top of the previously changed string. Usually, you will need to create a new MagicString instance and apply the changes again, which then will end up with multiple sourcemaps that you also need to combine manually. This package makes it magically work on a single instance and generate a single auto-combined sourcemap.

This package extends MagicString class by adding two methods .commit() and .rollback(). Under the hood, it also proxies all the operations methods.

Usage

.commit()

Commit all the changes made so far to MagicString. s.original will become the current transformed result. And the positions will now be based on the new string. Under the hood, it creates a new MagicString instance and swaps all the methods to the new instance.

.rollback()

Rollback to the state before the last commit. It throws an error if there is no previous commit.

.generateMap()

Supercharge the original generateMap method. Where there are multiple commits, it will generate a combined sourcemap using @ampproject/remapping.

Example

import MagicStringStack from 'magic-string-stack'

const s = new MagicStringStack('problems = 99')

s.replace('problems', 'issues')
  .prepend('var ')

s.toString() // 'var issues = 99'
s.original // 'problems = 99' (original string)

s.commit() // this will commit the changes

s.original // 'var issues = 99' (applied with previous changes)
s.replace('issues', 'problems')
s.toString() // 'var problems = 99'

s.generateMap() // generate sourcemap, if multiple commits happened, it will generate a combined sourcemap

Sponsors

License

MIT License © 2023-PRESENT Anthony Fu

magic-string-stack's Issues

Named commit and rollback to any named stage

Clear and concise description of the problem

The function commit update the MagicString to the new one.
I wonder If it is possible that you can commit with name, and rollback the named stage to use the relative position of any committed one?

Suggested solution

Like this:

const s = new MagicStringStack('problems = 99') //now we named it `origin`

s.replace('problems', 'issues')
  .append('var ')

s.toString() 
s.original 

s.commit("Middle") // now we named the staged `Middle`

s.original
s.replace('issues', 'problems')
s.toString() 

//many named stage

s.rollback('Middle') //now we go back to 'Middle' stage

s.rollback('origin')  //now we go back the origin one
//...

s.generateMap()

Alternative

No response

Additional context

No response

Validations

• Follow our Code of Conduct
• Read the Contributing Guide.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.