@cognite/aura 0.1.4 → 0.1.6

package/README.md

@@ -0,0 +1,68 @@
+# Aura
+
+Aura exports Cognite's UI components, styles, utilities, and ESLint guidance for preserving the design system in downstream apps.
+
+## ESLint
+
+Aura ships an ESLint plugin at `@cognite/aura/eslint`.
+
+### What it does
+
+The `aura/no-overriding-styles` rule warns when consumers pass visual Tailwind-style utilities to Aura or Aura Labs components via `className`.
+
+It is intended to preserve Aura's out-of-the-box appearance while still allowing host apps to control layout and sizing.
+
+Allowed examples:
+
+- `w-full`
+- `ml-auto`
+- `hidden md:flex`
+- `grid-cols-2`
+- `max-w-[32rem]`
+
+Warned examples:
+
+- `bg-card`
+- `text-xs`
+- `rounded-lg`
+- `shadow-none`
+- `animate-pulse`
+
+The rule also provides suggestions and autofix for simple static `className` values by removing disallowed classes and keeping layout-safe utilities.
+
+### Usage
+
+Add the Aura plugin to your ESLint config and enable the rule:
+
+```js
+import { auraEslintPlugin } from '@cognite/aura/eslint';
+
+export default [
+  {
+    files: ['**/*.{ts,tsx,js,jsx}'],
+    plugins: {
+      aura: auraEslintPlugin,
+    },
+    rules: {
+      'aura/no-overriding-styles': 'warn',
+    },
+  },
+];
+```
+
+### Example
+
+```tsx
+import { Button } from '@cognite/aura/components';
+
+export function Example() {
+  return <Button className="w-full ml-auto bg-card rounded-lg" />;
+}
+```
+
+The rule keeps the layout-safe classes and warns about the visual overrides:
+
+- kept: `w-full`, `ml-auto`
+- warned: `bg-card`, `rounded-lg`
+
+Use Aura variants, props, or composition when you need to change the component's appearance.