Add Void Keep a wake

Author: FanchGadjo

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

@@ -0,0 +1,15 @@
+# Avoid using keepAwake in web applications (`@ecocode/avoid-keep-awake`)
+
+⚠️ This rule _warns_ in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
+
+## Why is this an issue?
+
+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. If so, developers typically use the FLAG_KEEP_SCREEN_ON in their activity. Another way to implement this is in their application's layout XML file, by using the android:keepScreenOn attribute.
+
+## Resources
+
+### Documentation
+

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

@@ -0,0 +1,47 @@
+/*
+ * ecoCode JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
+ * Copyright © 2023 Green Code Initiative (https://www.ecocode.io)
+ *
+ * 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+"use strict";
+
+/** @type {import("eslint").Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Avoid screen keep awake",
+      category: "eco-design",
+      recommended: "warn",
+    },
+    messages: {
+      AvoidKeepAwake: "Avoid screen keep awake",
+    },
+    schema: [],
+  },
+  create: function (context) {
+    return {
+        Identifier(node){
+        if (
+          node?.name === "useKeepAwake" 
+          && node?.parent.type === "CallExpression"
+        ) {
+          context.report({ node, messageId: "AvoidKeepAwake" });
+        }
+      },
+    };
+  },
+};

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

@@ -0,0 +1,85 @@
+/*
+ * ecoCode JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
+ * Copyright © 2023 Green Code Initiative (https://www.ecocode.io)
+ *
+ * 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/avoid-keep-awake");
+const RuleTester = require("eslint").RuleTester;
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 2015, //es6
+    sourceType: "module",
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+});
+const expectedError = {
+  messageId: "AvoidKeepAwake",
+  type: "Identifier", 
+};
+
+ruleTester.run("avoid-keep-awake", rule, {
+  valid: [
+    {
+      code: `
+      import React from 'react';
+      import { Text, View } from 'react-native';
+      
+      export default function ValidExample() {
+        return (
+          <View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
+            <Text>This screen will sleep!</Text>
+          </View>
+        );
+      }
+     `,
+      errors: [expectedError],
+    },
+    ,
+  ],
+  invalid: [
+    {
+      code: `
+      import { useKeepAwake } from 'expo-keep-awake';
+      import React from 'react';
+      import { Text, View } from 'react-native';
+      
+      export default function KeepAwakeExample() {
+        useKeepAwake();
+        return (
+          <View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
+            <Text>This screen will never sleep!</Text>
+          </View>
+        );
+      }
+     `,
+      errors: [expectedError],
+    },
+    ,
+  ],
+});

sonar-plugin/src/main/java/io/ecocode/javascript/CheckList.java

@@ -36,6 +36,7 @@ public static List<Class<? extends JavaScriptCheck>> getAllChecks() {
         return Arrays.asList(
                 AvoidCSSAnimations.class,
                 AvoidHighAccuracyGeolocation.class,
+                AvoidKeepAwake.class,
                 LimitDbQueryResult.class,
                 NoEmptyImageSrcAttribute.class,
                 NoImportAllFromLibrary.class,

sonar-plugin/src/main/java/io/ecocode/javascript/checks/AvoidKeepAwake.java

@@ -0,0 +1,37 @@
+/*
+ * ecoCode JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
+ * Copyright © 2023 Green Code Initiative (https://www.ecocode.io)
+ *
+ * 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package io.ecocode.javascript.checks;
+
+import org.sonar.check.Rule;
+import org.sonar.plugins.javascript.api.EslintBasedCheck;
+import org.sonar.plugins.javascript.api.JavaScriptRule;
+import org.sonar.plugins.javascript.api.TypeScriptRule;
+
+@JavaScriptRule
+@TypeScriptRule
+@Rule(key = AvoidKeepAwake.RULE_KEY)
+public class AvoidKeepAwake implements EslintBasedCheck {
+
+    public static final String RULE_KEY = "EC505";
+
+    @Override
+    public String eslintKey() {
+        return "@ecocode/avoid-keep-awake";
+    }
+
+}

sonar-plugin/src/main/resources/io/ecocode/profiles/ecocode_javascript_profile.json

@@ -9,6 +9,7 @@
     "EC25",
     "EC26",
     "EC29",
-    "EC30"
+    "EC30",
+    "EC505"
   ]
 }