Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 1.14 KB

File metadata and controls

76 lines (56 loc) · 1.14 KB

🛠️ AcroSense Developer Guide

This guide helps contributors, maintainers, and curious developers get started quickly.

📦 Prerequisites

  • Node.js + pnpm
  • VS Code
  • vsce (for packaging)
  • Git

🏗 Project Structure

acrosense/
 ├─ src/
 │   └─ extension.ts
 ├─ dist/
 ├─ package.json
 ├─ acros.json (example)
 └─ README.md

▶️ Run the Extension Locally

  1. Install deps:

    pnpm install
  2. Start dev mode with auto‑build:

    pnpm run watch
  3. Press F5 in VS Code to launch the Extension Development Host.

  4. Open any project inside the Dev Host window and test acronym hover.

🧪 Testing

Compile tests:

pnpm run compile-tests

Run them:

pnpm test

🚀 Publishing

  1. Login:

    vsce login <publisher>
  2. Package:

    vsce package
  3. Publish:

    vsce publish

📥 Contribution Workflow

  1. Fork the repo
  2. Create a feature branch
  3. Run pnpm run watch to develop
  4. Submit a PR with a screenshot of your change

Thanks for contributing ❤️