Skip to content

farscrl/spellchecker-addin-office

Repository files navigation

Controlla ortografica rumantscha: Add-in Microsoft Office

A Romansh spellchecker add-in for Microsoft Word. This add-in integrates with Microsoft Word to provide real-time spellchecking for the Romansh language.

Features

  • Spellchecking for all six Romansh idioms:
    • Rumantsch Grischun
    • Sursilvan
    • Sutsilvan
    • Surmiran
    • Puter
    • Vallader
  • Inline error highlighting (on supported Word versions with API level 1.8+)
  • Fallback legacy view for older Word versions
  • Custom ignored words list
  • Works in Word desktop (Windows/macOS) and Word Online

Prerequisites

Getting started

  1. Install dependencies:

    pnpm install
  2. Generate SSL certificates for local development:

    pnpm run ssl:config

    Note: Certificates expire after 30 days. Re-run this command to regenerate them.

  3. Start the development server and Word:

    # start dev server
    pnpm run dev-server
    
    # For desktop Word
    pnpm run start:desktop
    
    # For Word Online (requires a document URL)
    pnpm run start:web -- --document https://your-document-url

Sideloading in web: https://learn.microsoft.com/en-us/office/dev/add-ins/testing/sideload-office-add-ins-for-testing#manually-sideload-an-add-in-to-office-on-the-web

If Word Online doesn't load the add-in on the first try, visit https://localhost:4200 first to trust the self-signed certificate.

Available scripts

Script Description
pnpm run dev-server Start the development server only
pnpm run start:desktop Start dev server and open Word desktop with add-in
pnpm run start:web Start dev server and open Word Online with add-in
pnpm run build:dev Development build (output in dist/)
pnpm run build:staging Staging build (output in dist/)
pnpm run build Production build (output in dist/)
pnpm run lint Lint the codebase
pnpm run validate Validate the dev Office add-in manifest
pnpm run validate:staging Validate the stagin Office add-in manifest
pnpm run validate:prod Validate the prod Office add-in manifest

Debugging

  • Word Online: Use your browser's developer tools (F12)
  • Word Desktop (Windows): Use F12 developer tools or attach a debugger from the task pane
  • Word Desktop (macOS): Use Safari Web Inspector

For detailed debugging instructions, see the Office Add-ins debugging documentation.

Project structure

src/
├── app/
│   ├── spellchecker-inline/  # Modern inline spellchecker (Word API 1.8+)
│   ├── spellchecker-legacy/  # Fallback for older Word versions
│   ├── settings/             # User settings component
│   ├── ignored-words/        # Custom ignored words management
│   ├── services/             # Spellchecking and API services
│   └── data/                 # Data types and constants
├── assets/                   # Icons and static assets
├── manifest.xml              # Development manifest
├── manifest-staging.xml      # Staging manifest
└── manifest-prod.xml         # Production manifest

Resources

License

MIT

About

Program da correctura rumantsch: Add-in Microsoft Office

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors