stylemcp 0.1.0

package/packs/saas/cta_rules.yaml

@@ -0,0 +1,362 @@
+version: "1.0"
+name: "SaaS CTA Rules"
+description: "Call-to-action patterns and guidelines for B2B SaaS"
+
+guidelines:
+  verbStyle: imperative
+  maxWords: 4
+  capitalization: sentence
+  avoidWords:
+    - "Submit"
+    - "Click"
+    - "Click here"
+    - "Press"
+    - "Hit"
+    - "Go"
+    - "OK"
+    - "Yes"
+    - "No"
+    - "Proceed"
+    - "Continue" # unless genuinely continuing a process
+    - "Please"
+  preferWords:
+    - "Save"
+    - "Create"
+    - "Add"
+    - "Send"
+    - "Share"
+    - "Export"
+    - "Import"
+    - "Download"
+    - "Upload"
+    - "View"
+    - "Open"
+    - "Copy"
+    - "Delete"
+    - "Remove"
+    - "Cancel"
+    - "Sign up"
+    - "Log in"
+    - "Log out"
+    - "Try"
+    - "Start"
+    - "Upgrade"
+
+categories:
+  - name: "Primary Actions"
+    description: "Main actions users take"
+    ctas:
+      - id: cta-save
+        text: "Save"
+        context: ["forms", "settings", "editing"]
+        priority: primary
+        action: "persist changes"
+      - id: cta-save-changes
+        text: "Save changes"
+        context: ["forms with unsaved state"]
+        priority: primary
+      - id: cta-create
+        text: "Create"
+        context: ["new resource creation"]
+        priority: primary
+      - id: cta-create-item
+        text: "Create {{item}}"
+        context: ["specific resource creation"]
+        priority: primary
+      - id: cta-add
+        text: "Add"
+        context: ["adding to existing collection"]
+        priority: primary
+      - id: cta-send
+        text: "Send"
+        context: ["messages", "emails", "invitations"]
+        priority: primary
+      - id: cta-share
+        text: "Share"
+        context: ["sharing resources"]
+        priority: primary
+
+  - name: "Authentication"
+    description: "Login and signup flows"
+    ctas:
+      - id: cta-signup
+        text: "Sign up"
+        context: ["registration"]
+        priority: primary
+      - id: cta-signup-free
+        text: "Sign up free"
+        context: ["free tier registration"]
+        priority: primary
+      - id: cta-login
+        text: "Log in"
+        context: ["returning user"]
+        priority: primary
+      - id: cta-logout
+        text: "Log out"
+        context: ["session end"]
+        priority: secondary
+      - id: cta-forgot
+        text: "Forgot password?"
+        context: ["password recovery"]
+        priority: tertiary
+      - id: cta-reset
+        text: "Reset password"
+        context: ["password reset form"]
+        priority: primary
+
+  - name: "Data Actions"
+    description: "Importing and exporting data"
+    ctas:
+      - id: cta-export
+        text: "Export"
+        context: ["data export"]
+        priority: primary
+      - id: cta-export-format
+        text: "Export as {{format}}"
+        context: ["specific format export"]
+        priority: primary
+      - id: cta-download
+        text: "Download"
+        context: ["file download"]
+        priority: primary
+      - id: cta-import
+        text: "Import"
+        context: ["data import"]
+        priority: primary
+      - id: cta-upload
+        text: "Upload"
+        context: ["file upload"]
+        priority: primary
+      - id: cta-copy
+        text: "Copy"
+        context: ["clipboard copy"]
+        priority: secondary
+      - id: cta-copy-link
+        text: "Copy link"
+        context: ["sharing via link"]
+        priority: secondary
+
+  - name: "Destructive Actions"
+    description: "Irreversible or dangerous actions"
+    ctas:
+      - id: cta-delete
+        text: "Delete"
+        context: ["permanent removal"]
+        priority: primary
+        action: "permanent deletion"
+      - id: cta-delete-item
+        text: "Delete {{item}}"
+        context: ["specific item deletion"]
+        priority: primary
+      - id: cta-remove
+        text: "Remove"
+        context: ["removal from collection, reversible"]
+        priority: primary
+      - id: cta-cancel-action
+        text: "Cancel {{item}}"
+        context: ["canceling subscription, action"]
+        priority: primary
+
+  - name: "Navigation"
+    description: "Moving between views"
+    ctas:
+      - id: cta-view
+        text: "View"
+        context: ["viewing details"]
+        priority: secondary
+      - id: cta-view-all
+        text: "View all"
+        context: ["seeing full list"]
+        priority: secondary
+      - id: cta-view-details
+        text: "View details"
+        context: ["expanded view"]
+        priority: secondary
+      - id: cta-open
+        text: "Open"
+        context: ["opening resource"]
+        priority: secondary
+      - id: cta-back
+        text: "Back"
+        context: ["returning to previous"]
+        priority: tertiary
+      - id: cta-learn-more
+        text: "Learn more"
+        context: ["documentation link"]
+        priority: tertiary
+
+  - name: "Cancellation"
+    description: "Canceling or dismissing"
+    ctas:
+      - id: cta-cancel
+        text: "Cancel"
+        context: ["dismissing modal", "abandoning action"]
+        priority: secondary
+      - id: cta-dismiss
+        text: "Dismiss"
+        context: ["closing notification"]
+        priority: tertiary
+      - id: cta-close
+        text: "Close"
+        context: ["closing modal"]
+        priority: secondary
+      - id: cta-skip
+        text: "Skip"
+        context: ["optional onboarding"]
+        priority: tertiary
+      - id: cta-skip-for-now
+        text: "Skip for now"
+        context: ["optional but recommended step"]
+        priority: tertiary
+      - id: cta-not-now
+        text: "Not now"
+        context: ["dismissing soft prompt"]
+        priority: tertiary
+
+  - name: "Conversion"
+    description: "Upgrade and billing"
+    ctas:
+      - id: cta-upgrade
+        text: "Upgrade"
+        context: ["plan upgrade"]
+        priority: primary
+      - id: cta-upgrade-plan
+        text: "Upgrade plan"
+        context: ["explicit plan upgrade"]
+        priority: primary
+      - id: cta-view-plans
+        text: "View plans"
+        context: ["pricing comparison"]
+        priority: secondary
+      - id: cta-start-trial
+        text: "Start free trial"
+        context: ["trial initiation"]
+        priority: primary
+      - id: cta-try-free
+        text: "Try for free"
+        context: ["trial CTA"]
+        priority: primary
+      - id: cta-get-started
+        text: "Get started"
+        context: ["onboarding initiation"]
+        priority: primary
+
+  - name: "Communication"
+    description: "Reaching out"
+    ctas:
+      - id: cta-contact
+        text: "Contact us"
+        context: ["support", "sales"]
+        priority: secondary
+      - id: cta-contact-support
+        text: "Contact support"
+        context: ["help request"]
+        priority: secondary
+      - id: cta-contact-sales
+        text: "Contact sales"
+        context: ["enterprise inquiry"]
+        priority: primary
+      - id: cta-send-feedback
+        text: "Send feedback"
+        context: ["feedback form"]
+        priority: secondary
+      - id: cta-report-issue
+        text: "Report issue"
+        context: ["bug report"]
+        priority: secondary
+
+antiPatterns:
+  - pattern: "(?i)^submit$"
+    isRegex: true
+    reason: "Generic and unclear"
+    suggestion: "Use specific action: 'Save', 'Send', 'Create'"
+
+  - pattern: "(?i)^click here"
+    isRegex: true
+    reason: "Poor accessibility and unclear"
+    suggestion: "Describe the destination or action"
+
+  - pattern: "(?i)^yes$"
+    isRegex: true
+    reason: "Doesn't describe the action"
+    suggestion: "Use the specific action: 'Delete', 'Confirm', 'Log out'"
+
+  - pattern: "(?i)^no$"
+    isRegex: true
+    reason: "Doesn't describe the action"
+    suggestion: "Use 'Cancel' or 'Keep {{item}}'"
+
+  - pattern: "(?i)^ok$"
+    isRegex: true
+    reason: "Vague confirmation"
+    suggestion: "Use the specific action or 'Done'"
+
+  - pattern: "(?i)^go$"
+    isRegex: true
+    reason: "Doesn't describe what happens"
+    suggestion: "Use specific action: 'Search', 'View', 'Open'"
+
+  - pattern: "(?i)^proceed"
+    isRegex: true
+    reason: "Formal and unclear"
+    suggestion: "Use specific action"
+
+  - pattern: "(?i)^continue$"
+    isRegex: true
+    reason: "Only use when genuinely continuing a multi-step process"
+    suggestion: "Use specific action if not in a wizard"
+
+  - pattern: "(?i)!$"
+    isRegex: true
+    reason: "CTAs don't need exclamation marks"
+    suggestion: "Remove the exclamation mark"
+
+  - pattern: "(?i)^please "
+    isRegex: true
+    reason: "CTAs should be direct commands"
+    suggestion: "Remove 'please'"
+
+  - pattern: "(?i)\\bhere\\b"
+    isRegex: true
+    reason: "'here' is meaningless in CTAs"
+    suggestion: "Describe the destination"
+
+contextualRules:
+  - context: "Destructive action confirmation"
+    required: []
+    forbidden:
+      - "Yes"
+      - "OK"
+      - "Confirm"
+    preferred:
+      - "Delete"
+      - "Remove"
+      - "Cancel {{item}}"
+
+  - context: "Form submission"
+    required: []
+    forbidden:
+      - "Submit"
+    preferred:
+      - "Save"
+      - "Create"
+      - "Send"
+      - "Add"
+
+  - context: "Modal dismissal"
+    required: []
+    forbidden:
+      - "X" # as text, icon is fine
+    preferred:
+      - "Cancel"
+      - "Close"
+      - "Done"
+
+  - context: "Onboarding skip"
+    required: []
+    forbidden:
+      - "No thanks"
+    preferred:
+      - "Skip"
+      - "Skip for now"
+      - "Set up later"

package/packs/saas/manifest.yaml

@@ -0,0 +1,16 @@
+name: saas
+version: "1.0.0"
+description: "Default style pack for B2B SaaS products. Professional, clear, helpful."
+author: StyleMCP
+license: MIT
+
+files:
+  voice: voice.yaml
+  copyPatterns: copy_patterns.yaml
+  ctaRules: cta_rules.yaml
+  tokens: tokens.json
+  tests: tests.yaml
+
+config:
+  strictMode: false
+  minScore: 70

package/packs/saas/tests.yaml

@@ -0,0 +1,305 @@
+version: "1.0"
+name: "SaaS Pack Tests"
+description: "Test cases for the SaaS style pack"
+
+config:
+  stopOnFirstFailure: false
+  verbose: true
+
+tests:
+  # SHOULD PASS
+  - id: pass-simple-success
+    name: "Simple success message"
+    input: "Project created."
+    expect:
+      pass: true
+      minScore: 90
+    tags: ["success", "simple"]
+
+  - id: pass-error-with-solution
+    name: "Error with specific solution"
+    input: "We couldn't process your payment. Your card was declined. Try a different card or contact your bank."
+    expect:
+      pass: true
+      minScore: 80
+    tags: ["error", "actionable"]
+
+  - id: pass-clear-cta
+    name: "Clear descriptive CTA"
+    input: "View your dashboard"
+    expect:
+      pass: true
+      minScore: 95
+    tags: ["cta"]
+
+  - id: pass-specific-empty-state
+    name: "Empty state with clear action"
+    input: "No projects yet. Create one to start tracking your work."
+    expect:
+      pass: true
+      minScore: 85
+    tags: ["empty-state"]
+
+  - id: pass-concrete-claim
+    name: "Concrete claim without jargon"
+    input: "Our search returns results in under 100ms."
+    expect:
+      pass: true
+      minScore: 85
+    tags: ["marketing"]
+
+  - id: pass-form-validation
+    name: "Helpful form validation"
+    input: "Password must be at least 8 characters. You have 6."
+    expect:
+      pass: true
+      minScore: 90
+    tags: ["validation"]
+
+  - id: pass-destructive-confirmation
+    name: "Clear destructive confirmation"
+    input: "Delete this project? You'll lose all 47 tasks and 12 files."
+    expect:
+      pass: true
+      minScore: 85
+    tags: ["confirmation", "destructive"]
+
+  # SHOULD FAIL - Forbidden phrases
+  - id: fail-revolutionary
+    name: "Uses forbidden 'revolutionary'"
+    input: "Our revolutionary new feature will transform your workflow."
+    expect:
+      pass: false
+      maxScore: 60
+      violations:
+        - rule: vocabulary.forbidden
+          severity: error
+    tags: ["forbidden", "marketing-speak"]
+
+  - id: fail-synergy
+    name: "Uses forbidden 'synergy'"
+    input: "We leverage synergies to maximize value for stakeholders."
+    expect:
+      pass: false
+      violations:
+        - rule: vocabulary.forbidden
+    tags: ["forbidden", "jargon"]
+
+  - id: fail-cutting-edge
+    name: "Uses forbidden 'cutting-edge'"
+    input: "Built with cutting-edge technology."
+    expect:
+      pass: false
+      violations:
+        - rule: vocabulary.forbidden
+    tags: ["forbidden"]
+
+  # SHOULD FAIL - doNot patterns
+  - id: fail-click-here
+    name: "Uses 'click here'"
+    input: "Click here to learn more about our features."
+    expect:
+      pass: false
+      violations:
+        - rule: doNot.click-here
+          severity: error
+    tags: ["accessibility", "cta"]
+
+  - id: fail-sorry-inconvenience
+    name: "Uses corporate non-apology"
+    input: "We're sorry for any inconvenience this may have caused."
+    expect:
+      pass: false
+      violations:
+        - rule: doNot.corporate-apology
+          severity: error
+    tags: ["error", "apology"]
+
+  - id: fail-simply
+    name: "Uses dismissive 'simply'"
+    input: "Simply configure your settings and you're done."
+    expect:
+      pass: false
+      violations:
+        - rule: doNot.dismissive-adverbs
+          severity: warning
+    tags: ["dismissive"]
+
+  - id: fail-obviously
+    name: "Uses dismissive 'obviously'"
+    input: "Obviously, you'll want to set up your profile first."
+    expect:
+      pass: false
+      violations:
+        - rule: doNot.dismissive-adverbs
+    tags: ["dismissive"]
+
+  - id: fail-dont-hesitate
+    name: "Uses 'don't hesitate'"
+    input: "Please don't hesitate to reach out if you have questions."
+    expect:
+      pass: false
+      violations:
+        - rule: doNot.hesitation
+    tags: ["filler"]
+
+  - id: fail-intensifiers
+    name: "Uses weak intensifiers"
+    input: "We're really excited to announce this incredibly amazing feature."
+    expect:
+      pass: false
+      violations:
+        - rule: doNot.intensifiers
+    tags: ["intensifiers"]
+
+  # SHOULD FAIL - Vocabulary rules
+  - id: fail-utilize
+    name: "Uses 'utilize' instead of 'use'"
+    input: "Utilize our API to build integrations."
+    expect:
+      pass: false
+      violations:
+        - rule: vocabulary.preferred
+    tags: ["vocabulary"]
+
+  - id: fail-leverage
+    name: "Uses 'leverage' as verb"
+    input: "Leverage our platform to grow your business."
+    expect:
+      pass: false
+      violations:
+        - rule: vocabulary.forbidden
+    tags: ["vocabulary", "jargon"]
+
+  - id: fail-facilitate
+    name: "Uses 'facilitate' instead of 'help'"
+    input: "Our tool facilitates team collaboration."
+    expect:
+      pass: false
+      violations:
+        - rule: vocabulary.preferred
+    tags: ["vocabulary"]
+
+  # SHOULD FAIL - Bad patterns
+  - id: fail-vague-error
+    name: "Vague error message"
+    input: "An error occurred."
+    expect:
+      pass: false
+      maxScore: 50
+    tags: ["error", "vague"]
+
+  - id: fail-generic-success
+    name: "Generic success with exclamation"
+    input: "Success!"
+    expect:
+      pass: false
+      violations:
+        - rule: doNot.exclamation
+    tags: ["success", "exclamation"]
+
+  - id: fail-excited-announcement
+    name: "Over-excited announcement"
+    input: "We're excited to announce our amazing new feature!"
+    expect:
+      pass: false
+    tags: ["marketing", "exclamation", "intensifiers"]
+
+  - id: fail-oops
+    name: "Informal error with emoji"
+    input: "Oops! Something went wrong 😅"
+    expect:
+      pass: false
+      maxScore: 40
+    tags: ["error", "informal"]
+
+  - id: fail-empty-nothing
+    name: "Unhelpful empty state"
+    input: "Nothing to see here!"
+    expect:
+      pass: false
+    tags: ["empty-state", "exclamation"]
+
+  - id: fail-invalid-input
+    name: "Unhelpful validation"
+    input: "Invalid input."
+    expect:
+      pass: false
+      maxScore: 50
+    tags: ["validation", "vague"]
+
+  - id: fail-are-you-sure
+    name: "Vague confirmation dialog"
+    input: "Are you sure?"
+    expect:
+      pass: false
+      maxScore: 60
+    tags: ["confirmation", "vague"]
+
+  # CTA failures
+  - id: fail-cta-submit
+    name: "Generic submit CTA"
+    input: "Submit"
+    expect:
+      pass: false
+      violations:
+        - rule: cta.antiPattern
+    tags: ["cta"]
+    context:
+      type: ui-copy
+      component: button
+
+  - id: fail-cta-yes
+    name: "Yes as confirmation CTA"
+    input: "Yes"
+    expect:
+      pass: false
+      violations:
+        - rule: cta.antiPattern
+    tags: ["cta", "confirmation"]
+    context:
+      component: button
+
+  - id: fail-cta-exclamation
+    name: "CTA with exclamation"
+    input: "Get started!"
+    expect:
+      pass: false
+      violations:
+        - rule: cta.antiPattern
+    tags: ["cta", "exclamation"]
+
+  # Constraint failures
+  - id: fail-long-sentence
+    name: "Sentence exceeds max length"
+    input: "This is an extremely long sentence that goes on and on and contains way too many words for any reasonable person to read and understand in a single breath without losing track of what the original point was supposed to be in the first place."
+    expect:
+      pass: false
+      violations:
+        - rule: constraints.maxSentenceLength
+    tags: ["constraints", "length"]
+
+  # Edge cases
+  - id: pass-technical-term
+    name: "Technical term is acceptable"
+    input: "Configure your API key in Settings."
+    expect:
+      pass: true
+      minScore: 80
+    tags: ["technical"]
+
+  - id: pass-contraction
+    name: "Contractions are allowed"
+    input: "You'll receive an email when it's ready."
+    expect:
+      pass: true
+      minScore: 85
+    tags: ["contractions"]
+
+  - id: pass-first-plural
+    name: "First person plural is preferred"
+    input: "We couldn't find that page. Here's what you can do."
+    expect:
+      pass: true
+      minScore: 80
+    tags: ["pov"]