lint doc updates

Author: raju-opti

eslint-local-rules/README.md

@@ -6,53 +6,53 @@ This directory contains custom ESLint rules specific to this project.
 
 ### `require-platform-declaration`
 
-**Purpose:** **Enforces that every non-test source file exports `__platforms`** to declare which platforms it supports.
+**Purpose:** **Enforces that every configured source file exports `__platforms`** to declare which platforms it supports.
 
-**Why:** This is a mandatory requirement for platform isolation. The rule catches missing declarations at lint time, before build or runtime.
+**Why:** This is a mandatory requirement for platform isolation. The rule catches missing declarations at lint time.
 
-**Requirement:** Every `.ts`/`.js` file in `lib/` (except tests) MUST export `__platforms` array with valid platform values.
-
-**Enforcement:**
-- ✅ Enabled for all `.ts` files in `lib/` directory
-- ❌ Disabled for test files (`.spec.ts`, `.test.ts`, etc.)
-- ❌ Disabled for `__mocks__` and `tests` directories
+**Requirement:** Every configured source file MUST export `__platforms` array with valid platform values.
 
 **Valid Examples:**
 
 ```typescript
 // Universal file (all platforms)
-export const __platforms = ['__universal__'] as const;
+export const __platforms: Platform[] = ['__universal__'];
 
 // Platform-specific file
-export const __platforms = ['browser', 'node'] as const;
+export const __platforms: Platform[] = ['browser', 'node'];
 
-// With type annotation
-export const __platforms: Platform[] = ['react_native'] as const;
+// Single platform
+export const __platforms: Platform[] = ['react_native'];
 ```
 
 **Invalid:**
 
 ```typescript
 // Missing __platforms export
-// ESLint Error: File must export __platforms to declare which platforms it supports
+// ESLint Error: File must export __platforms to declare which platforms it supports. Example: export const __platforms = ['__universal__'];
+
+// Not an array
+export const __platforms: Platform[] = 'browser';
+// ESLint Error: __platforms must be an array literal. Example: export const __platforms = ['browser', 'node'];
+
+// Empty array
+export const __platforms: Platform[] = [];
+// ESLint Error: __platforms array cannot be empty. Specify at least one platform or use ['__universal__'].
+
+// Using variables or computed values
+const myPlatform = 'browser';
+export const __platforms: Platform[] = [myPlatform];
+// ESLint Error: __platforms must only contain string literals. Do NOT use variables, computed values, or spread operators.
+
+// Invalid platform value
+export const __platforms: Platform[] = ['desktop'];
+// ESLint Error: Invalid platform value "desktop". Valid platforms are: 'browser', 'node', 'react_native', '__universal__'
 ```
 
 ## Configuration
 
 The rules are loaded via `eslint-plugin-local-rules` and configured in `.eslintrc.js`:
 
-```javascript
-{
-  plugins: ['local-rules'],
-  overrides: [{
-    files: ['*.ts', '!*.spec.ts', '!*.test.ts'],
-    rules: {
-      'local-rules/require-platform-declaration': 'error'
-    }
-  }]
-}
-```
-
 ## Adding New Rules
 
 1. Create a new rule file in this directory (e.g., `my-rule.js`)

eslint-local-rules/index.js

@@ -1,3 +1,19 @@
+/**
+ * Copyright 2025, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 /**
  * Local ESLint Rules
  * 

eslint-local-rules/require-platform-declaration.js

@@ -1,3 +1,19 @@
+/**
+ * Copyright 2025, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 /**
  * ESLint Rule: require-platform-declaration
  * 
@@ -17,6 +33,8 @@
  *   // Not exported as const array
  */
 
+/* eslint-disable @typescript-eslint/no-var-requires */
+
 const { getValidPlatforms } = require('../scripts/platform-utils');
 
 module.exports = {