@amazon-devices/eslint-plugin-kepler 0.1.8 → 0.1.11

package/README.md

@@ -36,11 +36,11 @@ To use Vega ESLint Plugin, complete the below steps in your Vega App Project.
     ```
 
     Available configs:
-    - `kepler` - All Kepler rules (performance + system distributed library checks + API privileges + backward compatibility)
+    - `kepler` - All Vega rules (performance + system distributed library checks + API privileges + backward compatibility)
     - `performance` - Performance-related rules only
     - `system-distributed-libs` - System distributed library checks (package.json validation and import informational flagging)
     - `api-privileges` - API privileges validation rules
-    - `backward-compatibility` - Backward compatibility validation rules for Kepler library projects
+    - `backward-compatibility` - Backward compatibility validation rules for Vega library projects
     
     You can use multiple configs:
     ```javascript
@@ -75,7 +75,8 @@ To use Vega ESLint Plugin, complete the below steps in your Vega App Project.
             "@amazon-devices/kepler/api-privileges-check": "error",
             "@amazon-devices/kepler/api-privilege-state-check": "error",
             "@amazon-devices/kepler/backward-compatibility": "error",
-            "@amazon-devices/kepler/backward-compatibility-copy-on-pack": "error"
+            "@amazon-devices/kepler/backward-compatibility-copy-on-pack": "error",
+            "@amazon-devices/kepler/package-migration": "error"
         }
     }
     ```
@@ -201,20 +202,25 @@ Flags imports of system distributed libraries with informational messages to ens
 
 ## Backward Compatibility Rules
 
-The plugin includes rules for managing backward compatibility in Kepler library projects:
+The plugin includes rules for managing backward compatibility in Vega library projects:
 
 ### `@amazon-devices/kepler/backward-compatibility`
-Validates that Kepler library projects have proper version compatibility configuration:
+Validates that Vega library projects have proper version compatibility configuration:
 - Checks for the existence of `kepler-compatibility.json` file in the project root
 - Validates that the current package version is listed in the compatibility file
-- Only runs in Brazil repositories with SDL project configuration
+- Only runs in repositories with SDL project configuration
 
 ### `@amazon-devices/kepler/backward-compatibility-copy-on-pack`
 Ensures that the `kepler-compatibility.json` file is included in npm packages:
 - Validates that `kepler-compatibility.json` is listed in the `files` array of `package.json`
-- Only runs in Brazil repositories with SDL project configuration
+- Only runs in repositories with SDL project configuration
 - Required for proper version compatibility validation in published packages
 
+### `@amazon-devices/kepler/package-migration`
+Validates that packages requiring migration to system distributed libraries are updated to newer versions:
+- Checks specific packages that have been released as system distributed libraries
+- Provides package version recommendations to make use of SDL released libs
+
 ## API Privileges Rules
 
 The plugin includes two rules for validating API privilege requirements:
@@ -236,10 +242,6 @@ The rule checks imports of known privilege-requiring packages and ensures the co
 ### `@amazon-devices/kepler/api-privilege-state-check`
 Validates that APIs requiring user privilege prompts have proper SecurityManager implementation. Some APIs require explicit user consent through privilege request dialogs.
 
-**Requirements for APIs with user prompts:**
-- SecurityManager package dependency (`@amazon-devices/security-manager-lib` or `@amazon-devices/security-manager-lib`) in `package.json`
-- SecurityManager method calls (`SecurityManager.getPrivilegeState` and `SecurityManager.requestPrivilege`) in the codebase
-
 **Example error:**
 ```
 The API @amazon-devices/kepler-identifiers requires you prompt the user for privilige acceptance. See the Vega documentation for this API as well as for SecurityManager.