Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Global Save State VS Code Extension
# Contributing to Save Sync VS Code Extension

Thank you for considering contributing! Please follow these guidelines:

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ assignees: ['Life-Experimentalist']

### Extension Settings
```json
// Your Global Save State extension settings from settings.json
// Your Save Sync extension settings from settings.json
{
"globalSaveState.excludePatterns": [],
"globalSaveState.maxSavePoints": 50
Expand All @@ -61,7 +61,7 @@ assignees: ['Life-Experimentalist']

### Extension Output
```
[Paste extension output here - View > Output > Select "Global Save State"]
[Paste extension output here - View > Output > Select "Save Sync"]
```

### File System Errors
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ assignees: ['Life-Experimentalist']

- [ ] **README.md** - Main repository README
- [ ] **Extension Marketplace Page** - VS Code Marketplace description
- [ ] **Website** - life-experimentalist.github.io/global-save-state
- [ ] **Website** - life-experimentalist.github.io/save-sync
- [ ] **Code Comments** - Inline documentation in source code
- [ ] **CHANGELOG.md** - Version history documentation
- [ ] **Architecture Docs** - Technical documentation
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ project/
```

## ⚙️ Extension Configuration
**Your Global Save State settings:**
**Your Save Sync settings:**

```json
{
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ assignees: []
## 📖 Documentation Checked
**Have you checked these resources?**

- [ ] [README.md](https://github.com/Life-Experimentalist/global-save-state/blob/main/README.md)
- [ ] [README.md](https://github.com/Life-Experimentalist/save-sync/blob/main/README.md)
- [ ] [VS Code Marketplace Page](https://marketplace.visualstudio.com/items?itemName=VKrishna04.global-save-state)
- [ ] [Project Website](https://life-experimentalist.github.io/global-save-state/)
- [ ] [Project Website](https://life-experimentalist.github.io/save-sync/)
- [ ] Existing GitHub Issues
- [ ] Extension Settings in VS Code

Expand Down
2 changes: 1 addition & 1 deletion .vscode/build.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// build.js
// Enhanced build script for Global Save State VS Code Extension
// Enhanced build script for Save Sync VS Code Extension
// Provides better user interaction and optimized publishing workflow

const { execSync } = require("child_process");
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Change Log

All notable changes to the "Global Save State" extension will be documented in this file.
All notable changes to the "Save Sync" extension will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Contributing to Global Save State
# Contributing to Save Sync

🎮 Welcome to the Global Save State project! We're excited that you want to contribute to making VS Code feel more like your favorite video game!
🎮 Welcome to the Save Sync project! We're excited that you want to contribute to making VS Code feel more like your favorite video game!

## 🚀 Quick Start

1. **🍴 Fork** the repository
2. **📥 Clone** your fork: `git clone https://github.com/YOUR_USERNAME/global-save-state.git`
2. **📥 Clone** your fork: `git clone https://github.com/YOUR_USERNAME/save-sync.git`
3. **📦 Install** dependencies: `npm install`
4. **🔧 Build** the extension: `npm run compile`
5. **🧪 Test** your changes: `npm test`
Expand All @@ -21,8 +21,8 @@
### Local Development
```bash
# Clone and setup
git clone https://github.com/Life-Experimentalist/global-save-state.git
cd global-save-state
git clone https://github.com/Life-Experimentalist/save-sync.git
cd save-sync
npm install

# Build and watch for changes
Expand Down Expand Up @@ -209,7 +209,7 @@ Contributors will be:

## ❓ Questions?

- **💬 Discussions**: [GitHub Discussions](https://github.com/Life-Experimentalist/global-save-state/discussions)
- **💬 Discussions**: [GitHub Discussions](https://github.com/Life-Experimentalist/save-sync/discussions)
- **📧 Email**: krishnagsvv@gmail.com
- **🐛 Issues**: Use our detailed issue templates
- **💡 Ideas**: Start with a feature request issue
Expand Down
8 changes: 8 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Migration: Renamed to save-sync

This repository has been renamed from "Global Save State" (Global-Save-State) to "save-sync" (Save Sync).

- Old repo name: Global-Save-State
- New repo name: save-sync

GitHub will keep redirects from the old repository URL, but please update any external links or package metadata that reference the old path.
237 changes: 19 additions & 218 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,226 +1,27 @@
# 🎮 Global Save State
### *Save Points for Your Code - Just Like in Games!*
# save-sync

<div align="center">
save-sync — VS Code extension to create and manage working save points (project snapshots).

![Global Save State Logo](icon.jpg)
Note: This project was formerly named "Global Save State" (repo: Global-Save-State). The old name and repository path will continue to redirect, but this README and package metadata have been updated to reflect the new name "save-sync" (display name: Save Sync).

**Create checkpoints in your code projects just like save points in video games!**
Quick summary
- Create lightweight project snapshots (save points) inside VS Code so you can return to previous working states quickly.
- Local, fast, and workspace-focused snapshots — useful for experiments, refactors, and risky changes.

*Perfect for experiments, tutorials, learning, and quick prototypes where full version control feels like overkill*
Install
- Install from the VS Code Marketplace (when published) or install the .vsix file.

[![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/VKrishna04.global-save-state)](https://marketplace.visualstudio.com/items?itemName=VKrishna04.global-save-state)
[![Downloads](https://img.shields.io/visual-studio-marketplace/d/VKrishna04.global-save-state)](https://marketplace.visualstudio.com/items?itemName=VKrishna04.global-save-state)
[![Rating](https://img.shields.io/visual-studio-marketplace/r/VKrishna04.global-save-state)](https://marketplace.visualstudio.com/items?itemName=VKrishna04.global-save-state)
Quick start
1. Open the Command Palette (Ctrl/Cmd+Shift+P).
2. Run "Save Sync: Create save point" to save the current workspace state.
3. Run "Save Sync: Restore save point" to revert to a previously saved snapshot.

</div>
Notes for maintainers
- package.json's "name" and "displayName" fields should be updated to "save-sync" and "Save Sync" respectively.
- Ensure repository, bugs, and homepage URLs in package.json point to https://github.com/Life-Experimentalist/save-sync.

---
Contributing
- Please open issues or pull requests. Use the "enhancement" label for feature proposals.

## 🎯 Why Save Points for Code?

Remember playing **Zelda** and hitting that checkpoint right before `Ganondorf`? Or **`Dark Souls`** where you desperately needed that bonfire before the boss? **`Global Save State`** brings that same peace of mind to coding!

### 🎮 Perfect Gaming Scenarios:

| 🎯 **Game Situation** | 💻 **Code Equivalent** |
| ------------------------------ | --------------------------------- |
| 🏰 **Save before boss fight** | Save before major refactoring |
| 🧪 **Try different strategies** | Experiment with new approaches |
| 📚 **Chapter checkpoints** | Milestone completion in tutorials |
| 🎨 **Creative experimentation** | Art projects, creative coding |
| ⚡ **Speed runs** | Rapid prototyping cycles |
| 🔄 **Multiple playthroughs** | Different implementation attempts |

### 🚀 When to Use Your Code Save Points:
- **🧪 Experiments**: Try wild ideas without fear - restore if they don't work
- **📚 Learning**: Checkpoint your progress while following tutorials
- **🚀 Prototyping**: Quick saves for rapid iteration cycles
- **🔧 Refactoring**: Save before major changes, restore if things break
- **🎨 Creative Coding**: Art projects, game jams, creative experiments
- **📝 Documentation**: Save states while writing examples or demos

### 🚫 When to Use Git Instead:
- Large production codebases
- Team collaboration projects
- Code that needs detailed history tracking
- Professional development workflows

## ✨ Game Mechanics for Code

### 🎮 Just Like Your Favorite Games

| 🎯 **Game Feature** | 💻 **Global Save State** | 🔥 **Why It's Awesome** |
| ------------------------ | ----------------------- | ---------------------------- |
| 💾 **Quick Save** | `Ctrl+Shift+S` | Instant checkpoint creation |
| 🔄 **Quick Load** | `Ctrl+Alt+R` | Instant project restoration |
| 📍 **Named Saves** | "Before AI Integration" | Descriptive checkpoint names |
| 🎯 **Save Slots** | Up to 50 per project | Multiple restore points |
| ⚡ **No Loading Screens** | Instant restore | Zero wait time |
| 🎪 **Multiple Campaigns** | Multi-root workspaces | Independent save systems |

### 🚀 Core Features

- **💾 Create Named Save Points**: Capture your entire project state with custom names
- **🔄 Instant Restore**: Quickly restore to any previous save point
- **📁 Multi-Root Support**: Each workspace folder maintains its own save points independently
- **⚙️ Flexible Exclusions**: Configure exclusion patterns per folder via `.vscode/settings.json`
- **⚡ Smart Detection**: Automatically handles empty save points when no changes are detected
- **🎯 Not a VCS**: Lightweight alternative to version control for quick state management

## 📦 Installation

### 🎮 From VS Code Marketplace (Recommended)
1. Open VS Code
2. Go to Extensions (`Ctrl+Shift+X`)
3. Search for "**Global Save State**"
4. Click **Install**
5. Start creating save points! 🎉

### 📁 From VSIX File
1. Download the `.vsix` file from [releases](https://github.com/Life-Experimentalist/global-save-state/releases)
2. Open VS Code
3. Run `Extensions: Install from VSIX...` from Command Palette
4. Select the downloaded `.vsix` file

## 🎮 Quick Start Guide - Your First Save Point!

### 🕹️ Tutorial Mode (5 minutes)

**Step 1: Set the Scene** 🎬
```bash
# Open any project in VS Code
# Make some changes to your files
# Now you're ready for your first checkpoint!
```

**Step 2: Create Your First Save Point** 💾
1. Press `Ctrl+Shift+S` (your "Save Game" button)
2. Name it: **"Tutorial Checkpoint 1"**
3. Watch the magic happen! ✨

**Step 3: Make Some Changes** 🔨
```javascript
// Add some experimental code
function experimentalFeature() {
// This might break everything...
return 'risky code here';
}
```

**Step 4: Create Another Checkpoint** 📍
1. Press `Ctrl+Shift+S` again
2. Name it: **"Added Experimental Feature"**

**Step 5: Oh No! Something Broke!** 💥
1. Press `Ctrl+Alt+R` (your "Load Game" button)
2. Select **"Tutorial Checkpoint 1"**
3. **BOOM!** 🎉 You're back to safety!

> 💡 **Pro Gamer Tip**: Use descriptive save names like "Before Adding Database", "Working Login System", or "Pre-Boss-Fight-Refactor"

## 🎯 Advanced Usage
### 💾 Creating Save Points (Quick Save)
- **🎮 Keyboard**: `Ctrl+Shift+S` (or `Cmd+Shift+S` on Mac)
- **📝 Command Palette**: `Global Save State: Create Save Point`

**Multi-Workspace Projects:**
1. If multiple workspace folders are open, select which folder to save
2. Enter a descriptive name for your save point (think epic checkpoint names!)
3. The extension captures all files (excluding configured patterns)

### 🔄 Loading Save Points (Quick Load)
- **🎮 Keyboard**: `Ctrl+Alt+R` (or `Cmd+Alt+R` on Mac)
- **📝 Command Palette**: `Global Save State: Restore Save Point`

**Restore Process:**
1. If multiple workspace folders are open, select which folder to restore
2. Choose from your list of save points (sorted by newest first)
3. Your project is instantly restored to that exact state

> ⚠️ **Boss Fight Warning**: Just like in games, loading a save point will overwrite your current progress! Save first if you want to keep changes.

## ⚙️ Configuration

### Per-Folder Settings
Create `.vscode/settings.json` in any workspace folder:

```json
{
"globalSaveState.excludePatterns": [
"**/node_modules/**",
"**/.git/**",
"**/dist/**",
"**/build/**",
"**/.vscode/**",
"**/out/**",
"**/*.log"
]
}
```

### Global Settings
- **Max Save Points**: Configure maximum save points to keep (default: 50)
- **Default Exclusions**: Set global exclusion patterns

## 📋 Requirements

- VS Code 1.74.0 or higher
- Node.js 16.0.0 or higher

## 🔧 Development

```bash
# Clone the repository
git clone https://github.com/Life-Experimentalist/global-save-state

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Run tests
npm test

# Build extension package
npm run build
```

## 📖 Documentation

- [Architecture](docs/ARCHITECTURE.md): System design and diagrams
- [Roadmap](docs/ROADMAP.md): Milestones and future plans
- [TODO](docs/TODO.md): Tasks and bugs
- [Changelog](docs/CHANGELOG.md): Release notes
- [License](LICENSE.md): License information
- [Code of Conduct](docs/CODE_OF_CONDUCT.md): Community guidelines

## 🤝 Contributing

See [Contributing Guide](.github/ISSUE_TEMPLATE/CONTRIBUTING.md) for details on:
- Code style guidelines
- How to submit pull requests
- Bug reporting process

## 📄 License

Licensed under the [Apache 2.0 License](LICENSE.md).

## 🐛 Issues & Support

- Report bugs: [GitHub Issues](https://github.com/Life-Experimentalist/global-save-state/issues)
- Feature requests: [GitHub Issues](https://github.com/Life-Experimentalist/global-save-state/issues)
- Email: krishnagsvv@gmail.com

---

<div align="center">

**🎮 Happy Coding with Save Points! 🎉**

*Made with ❤️ for developers who miss game checkpoints in their code*

[🌟 Star on GitHub](https://github.com/Life-Experimentalist/global-save-state) | [📦 VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Life-Experimentalist.global-save-state)

</div>
License
- (Keep existing license; add SPDX identifier here.)
Loading