@amazon-devices/eslint-plugin-kepler 0.1.4

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Amazon.com, Inc. or its affiliates.  All rights reserved.
+
+These materials are licensed as "Program Materials" under the Program Materials License Agreement (the "Agreement").  The Agreement is available at https://developer.amazon.com/support/legal/pml.  See the Agreement for the specific terms and conditions of the Agreement.  Capitalized terms not defined in this file have the meanings given to them in the Agreement.  
+
+If you do not agree to the above terms and conditions, you may not use any file in this package. 
+
+YOUR USE OF THE PROGRAM MATERIALS IN OR ASSOCIATED WITH THIS PACKAGE IS AT YOUR SOLE RISK.  IN NO EVENT WILL AMAZON BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, CONSEQUENTIAL, SPECIAL, INCIDENTAL, OR PUNITIVE DAMAGES (INCLUDING FOR ANY LOSS OF GOODWILL, BUSINESS INTERRUPTION, LOST PROFITS OR DATA, OR COMPUTER FAILURE OR MALFUNCTION) ARISING FROM OR RELATING TO SUCH PROGRAM MATERIALS, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, EVEN IF AMAZON HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS AND DISCLAIMERS APPLY EXCEPT TO THE EXTENT PROHIBITED BY APPLICABLE LAW.

package/README.md

@@ -0,0 +1,71 @@
+
+# eslint-plugin-kepler
+
+An ESLint Plugin to suggest Kepler App Development best practices.
+
+## Install
+  1. Make sure that you can access kepler NPM repo: See [Start installing SDK](https://developer.amazon.com/docs/kepler/install-kepler-sdk.html).
+  2. Add this package to `devDependencies` section of `package.json`:
+
+    ```bash
+     npm install --save-dev @amazon-devices/eslint-plugin-kepler
+    ```
+
+## Set up
+
+To use Kepler ESLint Plugin, complete the below steps in your Kepler App Project.
+
+1. Configure Kepler rules in the App's eslint config
+
+    KeplerESLintPlugin provides default configs that can be directly imported in App projects. To do so, add the following configuration in Kepler App's ESLint config file `.eslintrc.js`.
+
+    ``` javascript
+    module.exports = {
+        plugins: ["@amazon-devices/eslint-plugin-kepler"],
+        extends: ["plugin:@amazon-devices/eslint-plugin-kepler/performance"],
+    }
+    ```
+
+    You can also override severity of specific rules according do your use case like below
+    ```javascript
+    module.exports = {
+        plugins: ["@amazon-devices/eslint-plugin-kepler"],
+        extends: ["plugin:@amazon-devices/eslint-plugin-kepler/performance"],
+        rules: {
+            "@amazon-devices/kepler/flat-list": "error",
+        }
+    }
+    ```
+
+2. Specify formatter on lint tasks:
+    ```javascript
+      "scripts": {
+            :
+        "lint": "eslint src test --ext .ts,.tsx --format node_modules/@amazon-devices/eslint-plugin-kepler/dist/formatters/default.js",
+        "lint:fix": "eslint src test --ext .ts,.tsx --fix --format node_modules/@amazon-devices/eslint-plugin-kepler/dist/formatters/default.js",
+    ```
+
+3. Run Kepler ESLint Plugin
+
+    ```bash 
+    $ npm run lint
+    ```
+
+    Example:
+
+    ```bash
+    $ npm run lint
+
+    > @amazon-devices/kepler-eslint-testapp@0.1.0 lint
+    > eslint src test --ext .ts,.tsx  --format node_modules/@amazon-devices/eslint-plugin-kepler/dist/formatters/default.js
+    
+    
+    /Volumes/workspace/KeplerESLint/src/KeplerESLintTestApp/src/components/Link.tsx
+     32:5 ❌ 'useNativeDriver' property is set to 'false'. Set useNativeDriver to 'true' to run animations on UI thread for better performance. See https://developer.amazon.com/docs/kepler-tv/best_practices.html#animations for more. @amazon-devices/kepler/animated
+     43:5 ⚠️ Subscription must be kept in variable so that it can be cleaned up on the component is detached. See https://developer.amazon.com/docs/kepler-tv/best_practices.html#listeners-event-subscriptions-and-timers for more. @amazon-devices/kepler/check-subscription
+     64:11 ⚠️ FlatList missing props: 'initialNumToRender,windowSize,removeClippedSubviews,maxToRenderPerBatch,updateCellsBatchingPeriod'. FlatList performance is not fully unlocked without these props. See https://developer.amazon.com/docs/kepler-tv/best_practices.html#flatlist for more. @amazon-devices/kepler/flat-list
+    ```
+
+4. Kepler ESLint Plugin generated warnings will show in VS Code Editor when [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) is installed.
+
+    ![](./assets/checkSubscription.png)