Merge branch 'main' into feature/prefer-collections-with-pagination

# Conflicts:
#	eslint-plugin/README.md
#	eslint-plugin/lib/index.js

Author: utarwyn

.github/workflows/build.yml

@@ -32,6 +32,7 @@ jobs:
   sonarcloud:
     name: SonarCloud
     runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
 
     steps:
       - uses: actions/checkout@v3

.gitignore

@@ -1,6 +1,7 @@
 # Editors & OS
 .DS_Store
 .idea
+.vscode
 *.iml
 
 # Yarn

.yarn/versions/0a63a0fb.yml

@@ -0,0 +1,2 @@
+releases:
+  "@ecocode/eslint-plugin": minor

.yarn/versions/37179847.yml

@@ -0,0 +1,2 @@
+releases:
+  "@ecocode/eslint-plugin": minor

.yarn/versions/89666e13.yml

@@ -0,0 +1,2 @@
+releases:
+  "@ecocode/eslint-plugin": minor

eslint-plugin/CHANGELOG.md

@@ -7,16 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add rule `@ecocode/avoid-high-accuracy-geolocation`
+- Add rule `@ecocode/no-import-all-from-library`
+
 ## [0.1.0] - 2023-03-24
 
 ### Added
 
--   First alpha version of the ESLint plugin 🚀
--   Add rule `@ecocode/no-multiple-access-dom-element`
--   Create tooling script to generate SonarQube rules
--   Setup mocha and nyc for tests and coverage
--   Setup basic coding style tools
--   Write complete contributing guide
+- First alpha version of the ESLint plugin 🚀
+- Add rule `@ecocode/no-multiple-access-dom-element`
+- Create tooling script to generate SonarQube rules
+- Setup mocha and nyc for tests and coverage
+- Setup basic coding style tools
+- Write complete contributing guide
 
 [Unreleased]: https://github.com/green-code-initiative/ecoCode-linter/compare/eslint-plugin/0.1.0...HEAD
 

eslint-plugin/README.md

@@ -65,10 +65,12 @@ to have more information about the integration.
 ⚠️ Configurations set to warn in.\
 ✅ Set in the `recommended` configuration.
 
-| Name                                                                                   | Description                                   | ⚠️ |
-| :------------------------------------------------------------------------------------- | :-------------------------------------------- | :- |
-| [no-multiple-access-dom-element](docs/rules/no-multiple-access-dom-element.md)         | Disallow multiple access of same DOM element. | ✅  |
-| [prefer-collections-with-pagination](docs/rules/prefer-collections-with-pagination.md) | Prefer API collections with pagination        | ✅  |
+| Name                                                                                   | Description                                                | ⚠️ |
+| :------------------------------------------------------------------------------------- | :--------------------------------------------------------- | :- |
+| [avoid-high-accuracy-geolocation](docs/rules/avoid-high-accuracy-geolocation.md)       | Avoid using high accuracy geolocation in web applications. | ✅  |
+| [no-import-all-from-library](docs/rules/no-import-all-from-library.md)                 | Should not import all from library                         | ✅  |
+| [no-multiple-access-dom-element](docs/rules/no-multiple-access-dom-element.md)         | Disallow multiple access of same DOM element.              | ✅  |
+| [prefer-collections-with-pagination](docs/rules/prefer-collections-with-pagination.md) | Prefer API collections with pagination.                    | ✅  |
 
 <!-- end auto-generated rules list -->
 

eslint-plugin/docs/images/no-import-all-from-library.jpg

@@ -0,0 +1,49 @@
+# Avoid using high accuracy geolocation in web applications (`@ecocode/avoid-high-accuracy-geolocation`)
+
+⚠️ This rule _warns_ in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
+
+## Rule details
+
+This rule aims at reducing CPU consumption by telling the device to use a less accurate yet more eco friendly geolocation, when geolocation API is used.
+
+## Examples
+
+Examples of **non compliant** code for this rule:
+
+```js
+var options = { enableHighAccuracy: true, timeout: 5000, maximumAge: 0 };
+function success(pos) {
+  console.log(pos.coords);
+}
+
+function error(err) {
+  console.warn(err);
+}
+
+navigator.geolocation.getCurrentPosition(success, error, options);
+```
+
+Examples of **compliant** code for this rule:
+
+```js
+// enableHighAccuracy is false by default, so not declaring it is correct
+function success(pos) {
+  console.log(pos);
+}
+navigator.geolocation.getCurrentPosition(success);
+```
+
+```js
+var options = { enableHighAccuracy: false, timeout: 5000, maximumAge: 0 };
+function success(pos) {
+  console.log(pos.coords);
+}
+
+function error(err) {
+  console.warn(err);
+}
+
+navigator.geolocation.getCurrentPosition(success, error, options);
+```

eslint-plugin/docs/rules/avoid-high-accuracy-geolocation.md

@@ -0,0 +1,60 @@
+# Should not import all from library (`@ecocode/no-import-all-from-library`)
+
+⚠️ This rule _warns_ in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
+
+## Rule details
+
+This rule aims to reduce weight of programs by using only needed modules. Many libraries export only one module by
+default, but some of them are exporting ES modules or submodules. We should use them to select more precisly needed
+modules and avoid unnecessarily overloading files weight.
+
+![Example with lodash](https://raw.githubusercontent.com/green-code-initiative/ecoCode-linter/main/eslint-plugin/docs/images/no-import-all-from-library.jpg)
+
+*Example with the well-known [lodash](https://lodash.com/) library, if you only need "isEmpty" method.*
+
+## Options
+
+You can externally add your own libraries to be checked.
+To add your own libraries you need to modify your .eslintrc.js by adding the following rule configuration:
+
+```js
+module.exports = {
+  ...yourConf,
+  rules: {
+    "no-import-all-from-library": [
+      "warn",
+      {
+        notAllowedLibraries: ["some-lib"], // will check for -> import someLib from "some-lib"
+        importByNamespaceNotAllowedLibraries: ["some-other-lib"], // will check for -> import * as someOtherLib from "some-other-lib"
+      },
+    ],
+  },
+};
+```
+
+## Examples
+
+Examples of **non-compliant** code for this rule:
+
+```js
+// Example with lodash
+import lodash from "lodash";
+import { isEmpty } from "lodash";
+import * as lodash from "lodash";
+
+// Example with underscore
+import _ from "underscore";
+```
+
+Examples of **compliant** code for this rule:
+
+```js
+// Example with lodash (uses submodules)
+import isEmpty from "lodash/isEmpty";
+import intersect from "lodash/intersect";
+
+// Example with underscore (uses esm modules)
+import map from "underscore/modules/map.js";
+```