nuxt-scramble

A Nuxt module that obfuscates emails, phone numbers and custom text patterns in your HTML to help prevent scraping. Works by encoding sensitive data at build time with XOR encryption and decoding it client side.

[!NOTE] This wont stop scrapers with JS enabled, but it raises the bar significantly for simple HTML scrapers

• ✨  Release Notes

Features

• Automatic detection and obfuscation of emails and phone numbers in your HTML
• Server side rendering with encoded fallbacks for better SEO
• Client side decoding
• Automatic link generation (mailto: and tel:)
• Custom regex patterns for protecting other sensitive data
• <ScrambleText> component for control
• New encryption key generated per build

Quick Setup

Install the module to your Nuxt application with one command:

npx nuxt module add nuxt-scramble

That's it! You can now use nuxt-scramble in your Nuxt app ✨

How It Works

1. At build time, a random XOR encryption key is generated
2. Matching patterns in HTML are encoded with this key on the server
3. SSR renders a placeholder with the encoded data in a data-scramble attribute
4. Client side JS decodes and replaces the placeholder with the real content
5. A new key is generated for each build, making it harder for scrapers

Usage

ScrambleText Component

For explicit control, use the <ScrambleText> component:

<template>
  <ScrambleText text="[email protected]" type="email" :link="false" />
  <ScrambleText text="+1 123-456-7891" type="phone" />
  <ScrambleText text="I dont want this scraped" type="custom" />
</template>

Auto Scramble

When autoScramble is enabled (disabled by default), the module automatically finds and scrambles emails and phone numbers in your rendered HTML using a Nitro server plugin. This is ideal for prerendered/static sites.

Set autoScramble: true to enable with default patterns, or pass an object to customize, see below.

[!NOTE] Auto scramble has an performance impact on SSR as it processes all rendered HTML. Only enable it for prerendered/static sites.

Configuration

export default defineNuxtConfig({
  modules: ["nuxt-scramble"],
  scramble: {
    // automatically scramble matching patterns in rendered html (default: false)
    autoScramble: {
      // include default email/phone patterns (default: true)
      defaultPatterns: true,

      // custom patterns
      patterns: [
        {
          name: "custom",
          pattern: "\\d{3}-\\d{2}-\\d{4}",
          // optional regex flags, see https://www.w3schools.com/js/js_regexp_flags.asp
          flags: "gi",
        },
      ],
    },

    // auto generate mailto:/tel: links (default: true)
    autoLink: true,

    // placeholder text for no-JS fallback (default: '[protected]')
    placeholder: "[protected]",

    // customize data attribute (default: 'data-scramble')
    attribute: "data-scramble",

    // CSS class for scrambled elements (default: 'scrambled')
    className: "scrambled",
  },
});

Contribution

# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Run ESLint
pnpm run lint

# Run Vitest
pnpm run test
pnpm run test:watch

# Run E2E tests
pnpm test:e2e --project=ssr-dev-chrome    # Quick single check
pnpm test:e2e --project="*-firefox"       # All Firefox tests
pnpm test:e2e --project="ssg-*"           # All SSG tests
pnpm test:e2e                             # Full matrix (CI)

# Release new version
pnpm run release
pnpm run release:major