@18ways/eslint-plugin-translate 0.0.0-alpha.1aa37fb04f1f → 0.0.0-alpha.42e08a82e9b3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 18ways
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,215 +1,43 @@
+![18ways logo](https://18ways.com/18w-light.svg)
+
 # @18ways/eslint-plugin-translate
 
-ESLint plugin to detect untranslated strings that should use 18ways translate functionality.
+18ways makes i18n easy. SEO-ready, AI-powered translations for modern products.
+
+`@18ways/eslint-plugin-translate` is the ESLint plugin for 18ways. It catches hard-coded user-facing strings and nudges code toward `<T>` and `useT()`.
 
-## Installation
+## Install
 
 ```bash
-bun add -D @18ways/eslint-plugin-translate
+npm install -D @18ways/eslint-plugin-translate
 ```
 
-## Usage
-
-Add `@18ways/translate` to your ESLint configuration:
+## Basic config
 
-### ESLint Configuration (`.eslintrc.js`)
-
-```javascript
-module.exports = {
-  plugins: ['@18ways/translate'],
-  rules: {
-    '@18ways/translate/require-translation': 'error',
-  },
-};
-```
-
-### Using Preset Configurations
-
-#### Recommended Configuration
-
-```javascript
+```js
 module.exports = {
   extends: ['plugin:@18ways/translate/recommended'],
 };
 ```
 
-#### Strict Configuration
-
-```javascript
-module.exports = {
-  extends: ['plugin:@18ways/translate/strict'],
-};
-```
-
-## Rule: `require-translation`
-
-Detects user-facing strings that should be wrapped in 18ways translation components or hooks.
-
-### What it detects:
-
-1. **JSX Text Content** - Text directly in JSX elements
-2. **User-facing Attributes** - Attributes like `alt`, `placeholder`, `aria-label`, etc.
-3. **String Literals** - Hardcoded strings in user-facing contexts
-4. **Template Literals** - Template strings with user-facing content
-
-### Examples
-
-#### ❌ Invalid (will trigger the rule):
-
-```tsx
-// JSX text content
-<div>Hello World</div>
-<button>Click Me</button>
-
-// User-facing attributes
-<img src="/logo.png" alt="Company Logo" />
-<input placeholder="Enter your name" />
-<button aria-label="Close dialog">×</button>
-
-// String literals in JSX
-<div>{"Welcome to our site"}</div>
-
-// Template literals
-<div>{`Hello ${name}!`}</div>
-```
-
-#### ✅ Valid (properly translated):
+## Good / bad
 
 ```tsx
-// Using <T> component
-<T>Hello World</T>
-<button><T>Click Me</T></button>
-
-// Using useT hook
-const t = useT();
-const message = t("Hello World");
-
-// Non-user-facing content (automatically ignored)
-<div id="my-component" className="header">
-<img src="/images/logo.png" />
-<div>{42}</div>
-<a href="mailto:test@example.com">
-```
-
-### Rule Options
-
-```javascript
-{
-  "@18ways/translate/require-translation": ["error", {
-    "translateComponent": "T",           // Name of translation component (default: "T")
-    "translateHook": "useT",             // Name of translation hook (default: "useT")
-    "userFacingAttributes": [            // Attributes considered user-facing
-      "alt", "title", "aria-label",
-      "placeholder", "value", "label"
-    ],
-    "ignorePatterns": [                  // Regex patterns to ignore
-      "^[a-zA-Z0-9_-]{1,3}$",           // Very short identifiers (1-3 chars)
-      "^[A-Z_]+$",                       // Constants
-      "^\\d+$",                          // Numbers
-      "^[a-z]+://.*",                    // URLs
-      "^/.*",                            // Paths
-      "^#[a-fA-F0-9]{3,8}$",            // Hex colors
-      "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", // Emails
-      "^\\s*$"                           // Whitespace only
-    ],
-    "ignoreFiles": [                     // File patterns to ignore
-      ".*\\.test\\.[jt]sx?$",
-      ".*\\.spec\\.[jt]sx?$",
-      ".*/test/.*"
-    ]
-  }]
+// Bad
+export function Header() {
+  return <h1>Hello world</h1>;
 }
-```
 
-### Custom Translation Component
+// Good
+import { T } from '@18ways/react';
 
-If you use a custom translation component name:
-
-```javascript
-{
-  "@18ways/translate/require-translation": ["error", {
-    "translateComponent": "Translate"
-  }]
-}
-```
-
-Then use it like:
-
-```tsx
-<Translate>Hello World</Translate>
-```
-
-### Additional User-facing Attributes
-
-To check additional attributes:
-
-```javascript
-{
-  "@18ways/translate/require-translation": ["error", {
-    "userFacingAttributes": [
-      "alt", "title", "aria-label", "placeholder",
-      "data-tooltip", "summary", "caption"
-    ]
-  }]
-}
-```
-
-### Custom Ignore Patterns
-
-To ignore specific patterns:
-
-```javascript
-{
-  "@18ways/translate/require-translation": ["error", {
-    "ignorePatterns": [
-      "^[a-zA-Z0-9_-]+$",  // Default patterns
-      "^TEST_.*",           // Custom: ignore test constants
-      "^\\$.*"              // Custom: ignore $ prefixed strings
-    ]
-  }]
-}
-```
-
-## Integration with 18ways
-
-This plugin is designed to work with the 18ways translation system:
-
-```tsx
-import { Ways, T, useT } from '18ways';
-
-// Wrap your app
-<Ways apiKey="your-api-key" locale="en-US" baseLocale="en-US">
-  <Ways context="header">
-    <T>Welcome to our site</T>
-  </Ways>
-</Ways>;
-
-// Use translation hook
-function MyComponent() {
-  const t = useT();
-  return <p>{t('Learn more about our company')}</p>;
+export function Header() {
+  return (
+    <h1>
+      <T>Hello world</T>
+    </h1>
+  );
 }
 ```
 
-## Development
-
-```bash
-# Install dependencies
-bun install
-
-# Build the plugin
-bun run build
-
-# Run tests
-bun run test
-
-# Run tests in watch mode
-bun run test:watch
-
-# Lint the code
-bun run lint
-```
-
-## License
-
-MIT
+Docs: [18ways.com/docs](https://18ways.com/docs)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@18ways/eslint-plugin-translate",
-  "version": "0.0.0-alpha.1aa37fb04f1f",
+  "version": "0.0.0-alpha.42e08a82e9b3",
   "description": "ESLint plugin to detect untranslated strings that should use 18ways translate functionality",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",