Code Monkey home page Code Monkey logo

brackets-persistent-history's Introduction

Brackets Persistent History

Extension that saves editing history between changing projects or while Brackets is closed.

Created to supplement this Trello card (Local history versioning).

Note

This extension is still under work, but the basics should work. Help by filing issues, figuring out edge cases and suggesting new features!

How does it work?

Saving history

When a file has been edited (so that it's CodeMirror history has been modified) and user saves the current file following happens:

  • the actual history is saved to state.json (key is the full path)
  • a cached version the file is saved to modules/cache (as first-10-letters-of-path-converted-to-sha-1.tmp)

Loading history

When user opens a file, the extension checks first checks if the cache folder contains a cached copy of the file and the diff's it against the current document using JsDiff. This step is important, as CodeMirror history works line/character basis, which makes any changes to the document invalidate the entire history.

Regardless of whether the cached version differs from the original, the extension proceeds to reinserting the history. However, if the document was modified, the extension first reverts the document to the cached version, applies the history and then returns the document to original state. This way the redo history get invalidated, but undo history works as intended:

current document โ†’ cached document โ†’ history

Preferences

Following configuration options are available (under petetnt.brackets-persistent-history):

persistHistory (Boolean)

Default: true - Enables or disables persistent history

cacheTimeToLiveInDays (Integer)

Default: 14 - How many days should the cache (=== editing history + files) live. Note that working with many large files might bloat the size of the cache very quickly, so modify accordingly.

TODO

  • Create unit tests

Contributing

Contributions are welcome! Just open a new issue and/or send a pull request.

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.