Skip to content

Commit 04386d4

Browse files
committed
Documentation and GH action updates
1 parent 0369460 commit 04386d4

24 files changed

+169
-264
lines changed

.github/workflows/ci.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,18 @@ name: VS Code Extension CI/CD
22
on:
33
push:
44
branches: [main, release/**, wip/**, hotfix/**]
5+
paths-ignore:
6+
- "**.md"
7+
- "docs/**"
8+
- ".github/**"
9+
- ".vscode/**"
510
pull_request:
611
branches: [main, release/**, wip/**, hotfix/**]
7-
12+
paths-ignore:
13+
- "**.md"
14+
- "docs/**"
15+
- ".github/**"
16+
- ".vscode/**"
817

918
jobs:
1019
test:

.github/workflows/release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ on:
1313
- "**.md"
1414
- "docs/**"
1515
- ".github/**"
16+
- ".vscode/**"
1617
# Manual workflow dispatch for emergency releases
1718
workflow_dispatch:
1819
inputs:

.vscode/settings.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
// Excel Power Query Editor settings for dev container
1515
"excel-power-query-editor.verboseMode": true,
16-
"excel-power-query-editor.watchAlways": false,
16+
"excel-power-query-editor.watchAlways": true,
1717
"excel-power-query-editor.backupLocation": "sameFolder",
1818
"excel-power-query-editor.customBackupPath": "./VSCodeBackups",
1919
"excel-power-query-editor.debugMode": true,
@@ -73,5 +73,6 @@
7373
"c:/DEV/ewc3labs/excel-power-query-editor/.vscode/excel-pq-symbols"
7474
],
7575
"excel-power-query-editor.watch.checkExcelWriteable": true,
76-
"excel-power-query-editor.watchAlwaysMaxFiles": 100
76+
"excel-power-query-editor.watchAlwaysMaxFiles": 100,
77+
"excel-power-query-editor.sync.openExcelAfterWrite": true
7778
}

CHANGELOG.md

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,8 @@
1-
<!-- HEADER_TABLE -->
2-
<table align="center">
3-
<tr>
4-
<td width="112" align="center" valign="middle">
5-
<img src="assets/excel-power-query-editor-logo-128x128.png" width="128" height="128"><br>
6-
<strong>E · P · Q · E</strong>
7-
</td>
8-
9-
<td align="center" valign="middle">
10-
<h1 align="center">Excel Power Query Editor</h1>
11-
<p align="left">
12-
<b>Edit Power Query M code directly from Excel files in VS Code. No Excel needed. No bullshit. It Just Works™.</b><br>
13-
<sub>
14-
Built by <strong>EWC3 Labs</strong> — where we rage-build the tools everyone needs, but nobody <del>cares to build</del>
15-
<em>is deranged enough to spend days perfecting until it actually works right.</em>
16-
</sub>
17-
</p>
18-
</td>
19-
20-
<td width="112" align="center" valign="middle">
21-
<img src="assets/EWC3LabsLogo-blue-128x128.png" width="128" height="128"><br>
22-
<strong><em>QA Officer</em></strong>
23-
</td>
24-
</tr>
25-
</table>
26-
<!-- /HEADER_TABLE -->
1+
# Excel Power Query Editor
2+
3+
A modern, reliable VS Code extension for editing Power Query M code directly from Excel files.
4+
5+
---
276

287
# Changelog
298

README.md

Lines changed: 49 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -1,158 +1,67 @@
1-
<!-- HEADER_TABLE -->
2-
<table align="center">
3-
<tr>
4-
<td width="112" align="center" valign="middle">
5-
<img src="assets/excel-power-query-editor-logo-128x128.png" width="128" height="128"><br>
6-
<strong>E · P · Q · E</strong>
7-
</td>
1+
# Excel Power Query Editor
82

9-
<td align="center" valign="middle">
10-
<h1 align="center">Excel Power Query Editor</h1>
11-
<p align="left">
12-
<b>Edit Power Query M code directly from Excel files in VS Code. No Excel needed. No bullshit. It Just Works™.</b><br>
13-
<sub>
14-
Built by <strong>EWC3 Labs</strong> — where we rage-build the tools everyone needs, but nobody <del>cares to build</del>
15-
<em>is deranged enough to spend days perfecting until it actually works right.</em>
16-
</sub>
17-
</p>
18-
</td>
19-
20-
<td width="112" align="center" valign="middle">
21-
<img src="assets/EWC3LabsLogo-blue-128x128.png" width="128" height="128"><br>
22-
<strong><em>QA Officer</em></strong>
23-
</td>
24-
</tr>
25-
</table>
26-
<!-- /HEADER_TABLE -->
27-
28-
<!-- BADGES -->
29-
<p align="center">
30-
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg">
31-
<img alt="Version" src="https://img.shields.io/badge/Version-0.5.0-brightgreen.svg">
32-
<img alt="Tests Passing" src="https://img.shields.io/badge/tests-71%20passing-brightgreen.svg">
33-
<img alt="VS Code" src="https://img.shields.io/badge/VS_Code-Marketplace-blue.svg">
34-
<img alt="Buy Me a Coffee" src="https://img.shields.io/badge/Buy%20Me%20a%20Coffee-yellow?logo=buy-me-a-coffee&logoColor=white">
35-
</p>
36-
<!-- /BADGES -->
3+
A modern, reliable VS Code extension for editing Power Query M code directly from Excel files — fast, cross-platform, and Excel-free. Built by EWC3 Labs, where we rage-build the tools we wish already existed.
374

385
---
396

40-
### 🛠️ About This Extension
41-
42-
At **EWC3 Labs**, we don’t just build tools — we rage-build solutions to common problems that grind our gears on the daily. We got tired of fighting Excel’s half-baked Power Query editor and decided to _**just rip the M code**_ straight into VS Code, where it belongs and where CoPilot _lives_. Other devs built the foundational pieces _(see Acknowledgments below)_, and we stitched them together like caffeinated mad scientists in a lightning storm.
43-
44-
This extension exists because the existing workflow is clunky, fragile, and dumb. There’s no Excel or COM (_or Windows_) requirement, and no popup that says “something went wrong” with no actionable info. Just clean `.m` files. One context. Full references. You save — we sync. Done.
45-
46-
This is Dev/Power User tooling that finally respects your time.
47-
7+
☕️ **Support this project:** [Buy Me a Coffee](https://www.buymeacoffee.com/ewc3labs)
8+
9+
## 🚀 What It Does
10+
- **Edit Power Query M code directly from Excel files** (`.xlsx`, `.xlsm`, `.xlsb`) — no Excel required, no COM, no drama.
11+
- **Intelligent Auto-Watch:** Real-time sync with configurable file limits (1–100 files).
12+
- **Professional Logging:** Emoji-enhanced logs with multiple verbosity levels (🪲🔍ℹ️✅⚠️❌).
13+
- **Excel Symbols:** Auto-installs Excel-specific IntelliSense for `Excel.CurrentWorkbook()` and more.
14+
- **Automatic Backups:** Your data is safe — every change is backed up before it hits your Excel file.
15+
- **Zero Dependencies:** Works on Windows, macOS, and Linux. No Excel install needed.
16+
- **Full IntelliSense:** Complete M language support with syntax highlighting.
17+
- **Copilot & AI Ready:** Works seamlessly with GitHub Copilot and other VS Code AI tools.
4818
---
49-
50-
## ⚡ Quick Start
19+
## 🤔 Why Use Excel Power Query Editor?
20+
Let’s be honest: Excel’s built-in Power Query editor is... not great. It’s slow, clunky, Windows-only, and the Advanced Editor is barely an editor at all. We got tired of losing work to random syntax errors, fighting with popups, and being told we could only edit ONE query at a time—while Excel locks up the rest of your workflow. So we built the tool we wanted: fast, reliable, and actually respects your time.
21+
**Excel Power Query Editor** gives you:
22+
- A modern, cross-platform development experience in VS Code
23+
- Clean, reliable M code editing with full references and context
24+
- Fast, safe workflows with no dependency on Excel installation
25+
- Professional logging and backup so you never lose work
26+
- A little EWC3 Labs attitude — because dev tools should respect your time
27+
---
28+
## 🚀 Quick Start
5129

5230
### 1. Install
53-
54-
Open VS Code → Extensions (`Ctrl+Shift+X`) → Search **"Excel Power Query Editor"** → Install
31+
- Open VS Code → **Extensions** (`Ctrl+Shift+X`).
32+
- Search for **“Excel Power Query Editor”**.
33+
- Click **Install**.
5534

5635
### 2. Extract & Edit
57-
58-
1. Right-click any Excel file (`.xlsx`, `.xlsm`, `.xlsb`) in Explorer
59-
2. Select **"Extract Power Query from Excel"**
60-
3. Edit the generated `.m` file with full VS Code features
36+
- Right-click an Excel file → **“Extract Power Query from Excel”**.
37+
- Edit the generated `.m` file with full VS Code features.
6138

6239
### 3. Auto-Sync
40+
- Right-click the `.m` file → **“Toggle Watch”**.
41+
- Changes are automatically synced to Excel when you save.
42+
- Enable Watch Always setting to automatically start watching every extracted Power Query file.
6343

64-
1. Right-click the `.m` file → **"Toggle Watch"**
65-
2. Your changes automatically sync to Excel when you save
66-
3. Automatic backups keep your data safe
67-
68-
## 🚀 Key Features
69-
70-
- **🔄 Bidirectional Sync**: Extract from Excel → Edit in VS Code → Sync back seamlessly
71-
- **👁️ Intelligent Auto-Watch**: Real-time sync with configurable file limits (1-100 files, default 25)
72-
- **📊 Professional Logging**: Emoji-enhanced logging with 6 verbosity levels (🪲🔍ℹ️✅⚠️❌)
73-
- **🤖 Smart Excel Symbols**: Auto-installs Excel-specific IntelliSense for `Excel.CurrentWorkbook()` and more
74-
- **🛡️ Smart Backups**: Automatic Excel backups before any changes with intelligent cleanup
75-
- **🔧 Zero Dependencies**: No Excel installation required, works on Windows/Mac/Linux
76-
- **💡 Full IntelliSense**: Complete M language support with syntax highlighting
77-
- **⚙️ Production Ready**: Professional UX with optimal performance for large workspaces
78-
79-
## 📖 Documentation & Support
80-
81-
**[Complete Documentation Hub](docs/README_docs.md)** - All guides, references, and resources
82-
**[User Guide](docs/USER_GUIDE.md)** - Feature documentation and workflows
83-
**[Configuration Reference](docs/CONFIGURATION.md)** - All settings and customization options
84-
**[Contributing Guide](docs/CONTRIBUTING.md)** - Development setup, testing, and automation
85-
**[Publishing Guide](docs/PUBLISHING_GUIDE.md)** - GitHub Actions automation and marketplace publishing
86-
**[Release Summary v0.5.0](docs/RELEASE_SUMMARY_v0.5.0.md)** - Latest features and improvements
87-
88-
## Why This Extension?
89-
90-
Excel's Power Query editor is **painful to use**. This extension brings the **power of VS Code** to Power Query development:
91-
92-
- 🚀 **Modern Architecture**: No COM/ActiveX dependencies that break with VS Code updates
93-
- 🔧 **Reliable**: Direct Excel file parsing - no Excel installation required
94-
- 🌐 **Cross-Platform**: Works on Windows, macOS, and Linux
95-
-**Fast**: Instant startup, no waiting for COM objects
96-
- 🎨 **Beautiful**: Syntax highlighting, IntelliSense, and professional emoji logging
97-
- 📊 **Intelligent**: Configurable auto-watch limits prevent performance issues in large workspaces
98-
-**Fast**: Instant startup, no waiting for COM objects
99-
- 🎨 **Beautiful**: Syntax highlighting, IntelliSense, and proper formatting
100-
101-
## The Problem This Solves
102-
103-
**Excel's built-in editor** and legacy extensions suffer from:
104-
105-
- ❌ Breaks with every VS Code update (COM/ActiveX issues)
106-
- ❌ Windows-only, requires Excel installed
107-
- ❌ Leaves Excel zombie processes
108-
- ❌ Unreliable startup (popup dependencies)
109-
- ❌ Terrible editing experience
110-
111-
**This extension** provides:
112-
113-
- ✅ Update-resistant architecture
114-
- ✅ Works without Excel installed
115-
- ✅ Clean, reliable operation
116-
- ✅ Cross-platform compatibility
117-
- ✅ Modern VS Code integration
118-
- ✅ Professional emoji-enhanced logging (6 levels: 🪲🔍ℹ️✅⚠️❌)
119-
- ✅ Intelligent auto-watch with configurable limits (1-100 files)
120-
- ✅ Automatic Excel symbols installation for enhanced IntelliSense
121-
122-
## 📚 Complete Documentation
123-
124-
- **📖 [User Guide](docs/USER_GUIDE.md)** - Complete workflows, advanced features, troubleshooting
125-
- **⚙️ [Configuration](docs/CONFIGURATION.md)** - All settings, examples, use cases
126-
- **🤝 [Contributing](docs/CONTRIBUTING.md)** - Development setup, testing, contribution guidelines
127-
- **📝 [Changelog](CHANGELOG.md)** - Version history and feature updates
128-
- **🚀 [Publishing Guide](docs/PUBLISHING_GUIDE.md)** - GitHub Actions automation and release process
129-
- **📋 [Release Summary v0.5.0](docs/RELEASE_SUMMARY_v0.5.0.md)** - Latest features and technical improvements
130-
131-
## 🆘 Need Help?
132-
133-
- **Issues**: [GitHub Issues](https://github.com/ewc3labs/excel-power-query-editor/issues)
134-
- **Discussions**: [GitHub Discussions](https://github.com/ewc3labs/excel-power-query-editor/discussions)
135-
- **Support**: [![Buy Me a Coffee](https://img.shields.io/badge/-Buy%20Me%20a%20Coffee-ffdd00?style=flat&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/ewc3labs)
136-
137-
## 🤝 Acknowledgments & Credits
138-
139-
This extension builds upon the excellent work of several key contributors to the Power Query ecosystem:
140-
141-
**Inspired by:**
142-
143-
- **[Alexander Malanov](https://github.com/amalanov)** - Creator of the original [EditExcelPQM](https://github.com/amalanov/EditExcelPQM) extension, which pioneered Power Query editing in VS Code
144-
145-
**Powered by:**
146-
147-
- **[Microsoft Power Query / M Language Extension](https://marketplace.visualstudio.com/items?itemName=powerquery.vscode-powerquery)** - Provides essential M language syntax highlighting and IntelliSense
148-
- **[MESCIUS Excel Viewer](https://marketplace.visualstudio.com/items?itemName=MESCIUS.gc-excelviewer)** - Enables Excel file viewing in VS Code for seamless CoPilot workflows
44+
---
14945

150-
**Technical Foundation:**
46+
## 📚 Documentation & Support
47+
- **[User Guide](https://github.com/ewc3labs/excel-power-query-editor/blob/main/docs/USER_GUIDE.md)** – Workflows, commands, and tips
48+
- **[Release Summary v0.5.0](https://github.com/ewc3labs/excel-power-query-editor/blob/main/docs/RELEASE_SUMMARY_v0.5.0.md)** – Latest changes and features
49+
- **[GitHub Repository](https://github.com/ewc3labs/excel-power-query-editor)** – Source code, issues, and full documentation
15150

152-
- **[excel-datamashup](https://github.com/Vladinator/excel-datamashup)** by [Vladinator](https://github.com/Vladinator) - Robust Excel Power Query extraction library
51+
---
15352

154-
This extension represents a complete architectural rewrite focused on reliability, cross-platform compatibility, and modern VS Code integration patterns.
53+
## 🙏 Acknowledgments
54+
This project builds on the open-source work of the Power Query community:
55+
- **[Alexander Malanov](https://github.com/amalanov)**[EditExcelPQM](https://github.com/amalanov/EditExcelPQM)
56+
- **[Vladinator](https://github.com/Vladinator)**[excel-datamashup](https://github.com/Vladinator/excel-datamashup)
57+
- **[Microsoft](https://marketplace.visualstudio.com/publishers/Microsoft)**[Power Query / M Language Extension](https://marketplace.visualstudio.com/items?itemName=PowerQuery.vscode-powerquery)
58+
- **[MESCIUS Excel Viewer](https://marketplace.visualstudio.com/items?itemName=GrapeCity.gc-excelviewer)** – Optional Excel file previewing in VS Code
15559

15660
---
15761

158-
**Excel Power Query Editor** - _Because Power Query development shouldn't be painful_
62+
<p align="center">
63+
<img src="assets/EWC3LabsLogo-blue-128x128.png" width="128" height="128" alt="Georgie the QA Officer"><br>
64+
<sub><b>Georgie, our QA Officer</b></sub>
65+
</p>
66+
67+
**Excel Power Query Editor**_Because Power Query development shouldn’t be painful._

SUPPORT.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,23 @@ Give the project a star on GitHub to help others discover it.
4242

4343
For technical support and questions:
4444

45-
1. 📖 Check the [User Guide](USER_GUIDE.md) for detailed instructions
46-
2. ⚙️ Review [Configuration Guide](CONFIGURATION.md) for settings
47-
3. 🔍 Enable verbose mode for troubleshooting
48-
4. 🐛 Use debug mode for complex issues
45+
1. 📖 Check the [User Guide](docs/USER_GUIDE.md) for detailed instructions
46+
2. ⚙️ Review [Configuration Guide](docs/CONFIGURATION.md) for settings
47+
3. 🤝 See the [Contributing Guide](docs/CONTRIBUTING.md) for developer setup and automation
48+
4. � Review the [Release Summary](docs/RELEASE_SUMMARY_v0.5.0.md) for the latest features and technical notes
49+
5. �🔍 Enable verbose mode for troubleshooting
50+
6. 🐛 Use debug mode for complex issues
4951

5052
---
5153

5254
**Thank you for supporting the Power Query development community!**
5355

56+
---
57+
<p align="center">
58+
<img src="assets/EWC3LabsLogo-blue-128x128.png" width="128" height="128" alt="Georgie the QA Officer"><br>
59+
<sub><b>Georgie, our QA Officer</b></sub>
60+
</p>
61+
62+
---
63+
5464
*Every contribution, no matter how small, helps make this extension better for everyone.*

docs/BETA_DOWNLOADS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# Excel Power Query Editor
2+
A modern, reliable VS Code extension for editing Power Query M code directly from Excel files
3+
4+
---
5+
16
# 🧪 Beta Downloads & Nightly Builds
27

38
Get early access to the latest features and fixes before they hit the VS Code Marketplace!
@@ -66,4 +71,11 @@ Having issues with a beta?
6671

6772
---
6873

74+
<p align="center">
75+
<img src="assets/EWC3LabsLogo-blue-128x128.png" width="128" height="128" alt="Georgie the QA Officer"><br>
76+
<sub><b>Georgie, our QA Officer</b></sub>
77+
</p>
78+
79+
---
80+
6981
**Happy testing!** 🧪✨

docs/CONFIGURATION.md

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,9 @@
1-
<!-- HEADER_TABLE -->
2-
<table align="center">
3-
<tr>
4-
<td width="112" align="center" valign="middle">
5-
<img src="assets/excel-power-query-editor-logo-128x128.png" width="128" height="128"><br>
6-
<strong>E · P · Q · E</strong>
7-
</td>
8-
9-
<td align="center" valign="middle">
10-
<h1 align="center">Excel Power Query Editor</h1>
11-
<p align="left">
12-
<b>Edit Power Query M code directly from Excel files in VS Code. No Excel needed. No bullshit. It Just Works™.</b><br>
13-
<sub>
14-
Built by <strong>EWC3 Labs</strong> — where we rage-build the tools everyone needs, but nobody <del>cares to build</del>
15-
<em>is deranged enough to spend days perfecting until it actually works right.</em>
16-
</sub>
17-
</p>
18-
</td>
19-
20-
<td width="112" align="center" valign="middle">
21-
<img src="assets/EWC3LabsLogo-blue-128x128.png" width="128" height="128"><br>
22-
<strong><em>QA Officer</em></strong>
23-
</td>
24-
</tr>
25-
</table>
26-
<!-- /HEADER_TABLE -->
1+
# Excel Power Query Editor
2+
A modern, reliable VS Code extension for editing Power Query M code directly from Excel files
273

284
---
295

6+
307
## Configuration Reference
318

329
> **Complete settings guide with real-world use cases and optimization examples**
@@ -411,4 +388,9 @@ Then check: `View > Output > "Excel Power Query Editor"`
411388

412389
---
413390

391+
<p align="center">
392+
<img src="assets/EWC3LabsLogo-blue-128x128.png" width="128" height="128" alt="Georgie the QA Officer"><br>
393+
<sub><b>Georgie, our QA Officer</b></sub>
394+
</p>
395+
414396
**Excel Power Query Editor v0.5.0** - Professional configuration for every workflow

0 commit comments

Comments
 (0)