Apply PR feedbacks

Author: utarwyn

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 -   [#40](https://github.com/green-code-initiative/creedengo-javascript/pull/40) Add rule `@creedengo/avoid-autoplay` (GCI36)
+-   [#45](https://github.com/green-code-initiative/creedengo-javascript/pull/45) Add rule `@creedengo/avoid-keep-awake` (GCI505)
 -   [#46](https://github.com/green-code-initiative/creedengo-javascript/pull/46) Add rule `@creedengo/prefer-lighter-formats-for-image-files` (GCI31)
 
 ## [2.0.0] - 2025-01-22

eslint-plugin/README.md

@@ -61,8 +61,8 @@ Add `@creedengo` to the `plugins` section of your `.eslintrc`, followed by rules
 
 <!-- begin auto-generated configs list -->
 
-|     | Name          |
-| :-- | :------------ |
+|    | Name          |
+| :- | :------------ |
 | ✅  | `recommended` |
 
 <!-- end auto-generated configs list -->
@@ -74,12 +74,13 @@ Add `@creedengo` to the `plugins` section of your `.eslintrc`, followed by rules
 ⚠️ Configurations set to warn in.\
 ✅ Set in the `recommended` configuration.
 
-| Name                                                                                           | Description                                               | ⚠️  |
-| :--------------------------------------------------------------------------------------------- | :-------------------------------------------------------- | :-- |
+| Name                                                                                           | Description                                               | ⚠️ |
+| :--------------------------------------------------------------------------------------------- | :-------------------------------------------------------- | :- |
 | [avoid-autoplay](docs/rules/avoid-autoplay.md)                                                 | Avoid autoplay for videos and audio content               | ✅  |
 | [avoid-brightness-override](docs/rules/avoid-brightness-override.md)                           | Should avoid to override brightness                       | ✅  |
 | [avoid-css-animations](docs/rules/avoid-css-animations.md)                                     | Avoid usage of CSS animations                             | ✅  |
 | [avoid-high-accuracy-geolocation](docs/rules/avoid-high-accuracy-geolocation.md)               | Avoid using high accuracy geolocation in web applications | ✅  |
+| [avoid-keep-awake](docs/rules/avoid-keep-awake.md)                                             | Avoid screen keep awake                                   | ✅  |
 | [limit-db-query-results](docs/rules/limit-db-query-results.md)                                 | Should limit the number of returns for a SQL query        | ✅  |
 | [no-empty-image-src-attribute](docs/rules/no-empty-image-src-attribute.md)                     | Disallow usage of image with empty source attribute       | ✅  |
 | [no-import-all-from-library](docs/rules/no-import-all-from-library.md)                         | Should not import all from library                        | ✅  |

eslint-plugin/docs/rules/avoid-keep-awake.md

@@ -1,4 +1,4 @@
-# Avoid screen keep awake (`@ecocode/avoid-keep-awake`)
+# Avoid screen keep awake (`@creedengo/avoid-keep-awake`)
 
 ⚠️ This rule _warns_ in the ✅ `recommended` config.
 
@@ -9,25 +9,32 @@
 To avoid draining the battery, an Android device that is left idle quickly falls asleep.
 Hence, keeping the screen on should be avoided, unless it is absolutely necessary.
 
+> **Note**: This rule currently only supports detecting `expo-keep-awake` package usage. Support for other keep-awake packages may be added in future versions.
+
 ```js
+import { useKeepAwake } from "expo-keep-awake";
+
 export default function KeepAwakeExample() {
   useKeepAwake(); // Non compliant
   return (
-    <View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
+    <View style={{ flex: 1, alignItems: "center", justifyContent: "center" }}>
       <Text>This screen will never sleep!</Text>
     </View>
   );
 }
 ```
 
 ```js
+import { activateKeepAwake } from "expo-keep-awake";
+
 _activate = () => {
-    activateKeepAwake(); // Non-compliant
-    alert('Activated!');
-  };
+  activateKeepAwake(); // Non-compliant
+  alert("Activated!");
+};
 ```
 
 ## Resources
 
 ### Documentation
 
+- [Expo Docs](https://docs.expo.dev/versions/latest/sdk/keep-awake/) - Expo KeepAwake

eslint-plugin/lib/rules/avoid-keep-awake.js

@@ -1,6 +1,6 @@
 /*
- * ecoCode JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
- * Copyright © 2023 Green Code Initiative (https://www.ecocode.io)
+ * creedengo JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
+ * Copyright © 2023 Green Code Initiative (https://green-code-initiative.org)
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,6 +18,10 @@
 
 "use strict";
 
+const keepAwakeLibrariesMethods = {
+  "expo-keep-awake": ["activateKeepAwake", "useKeepAwake"],
+};
+
 /** @type {import("eslint").Rule.RuleModule} */
 module.exports = {
   meta: {
@@ -33,16 +37,25 @@ module.exports = {
     schema: [],
   },
   create: function (context) {
+    const librariesFoundInImports = [];
+
     return {
-      Identifier(node) {
+      ImportDeclaration(node) {
+        const currentLibrary = node.source.value;
+
+        if (keepAwakeLibrariesMethods[currentLibrary]) {
+          librariesFoundInImports.push(currentLibrary);
+        }
+      },
+      CallExpression(node) {
+        if (librariesFoundInImports.length === 0) {
+          return;
+        }
+
         if (
-          node?.name === "useKeepAwake" &&
-          node?.parent.type === "CallExpression"
-        ) {
-          context.report({ node, messageId: "AvoidKeepAwake" });
-        } else if (
-          node?.name === "activateKeepAwake" &&
-          node?.parent.type === "CallExpression"
+          librariesFoundInImports.some((library) =>
+            keepAwakeLibrariesMethods[library].includes(node.callee.name),
+          )
         ) {
           context.report({ node, messageId: "AvoidKeepAwake" });
         }

eslint-plugin/tests/lib/rules/avoid-keep-awake.js

@@ -1,6 +1,6 @@
 /*
- * ecoCode JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
- * Copyright © 2023 Green Code Initiative (https://www.ecocode.io)
+ * creedengo JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
+ * Copyright © 2023 Green Code Initiative (https://green-code-initiative.org)
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -41,12 +41,12 @@ const ruleTester = new RuleTester({
 
 const expectedErrorHook = {
   messageId: "AvoidKeepAwake",
-  type: "Identifier",
+  type: "CallExpression",
 };
 
 const expectedErrorFunction = {
   messageId: "AvoidKeepAwake",
-  type: "Identifier",
+  type: "CallExpression",
 };
 
 ruleTester.run("avoid-keep-awake", rule, {
@@ -68,10 +68,12 @@ ruleTester.run("avoid-keep-awake", rule, {
     {
       code: `
       import React from 'react';
+      import { useKeepAwake } from 'other-library';
       import { Button, View } from 'react-native';
       
       export default class ValidExample extends React.Component {
         render() {
+          useKeepAwake();
           return (
             <View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
             </View>

sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/AvoidKeepAwake.java

@@ -1,6 +1,6 @@
 /*
- * ecoCode JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
- * Copyright © 2023 Green Code Initiative (https://www.ecocode.io)
+ * Creedengo JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
+ * Copyright © 2023 Green Code Initiative (https://green-code-initiative.org)
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

sonar-plugin/src/main/resources/org/greencodeinitiative/creedengo/profiles/javascript_profile.json

@@ -11,6 +11,7 @@
     "GCI30",
     "GCI31",
     "GCI36",
+    "GCI505",
     "GCI523",
     "GCI530"
   ]