lint

Author: Ffloriel

.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "node": true,
+        "es6": true
+    },
+    "extends": "eslint:recommended",
+    "globals": {
+        "Atomics": "readonly",
+        "SharedArrayBuffer": "readonly"
+    },
+    "parserOptions": {
+        "ecmaVersion": 2018,
+        "sourceType": "module"
+    },
+    "rules": {
+    }
+};

__tests__/integration.test.js

@@ -1,53 +1,52 @@
-import path from 'path'
-import { exec } from 'child_process'
-import { promisify } from 'util'
-import { init } from './../src/index'
-import { shouldHideMessage } from '../src/utils/misc';
+import path from "path";
+import { exec } from "child_process";
+import { promisify } from "util";
+import { init } from "./../src/index";
+import { shouldHideMessage } from "../src/utils/misc";
 
-describe('Integration test', () => {
-  const pkgPath = path.resolve('__tests__/fixtures/pkg');
+describe("Integration test", () => {
+  const pkgPath = path.resolve("__tests__/fixtures/pkg");
 
-  const consolelog = global.console.log
+  const consolelog = global.console.log;
 
-  it('prints everything', async () => {
-
-    let log = ''
+  it("prints everything", async () => {
+    let log = "";
     console.log = jest.fn().mockImplementation((str1, str2) => {
-      log += str1 + str2
-    })
+      log += str1 + str2;
+    });
 
-    await init(pkgPath, false)
+    await init(pkgPath, false);
 
-    console.log = consolelog
+    console.log = consolelog;
     const content = [
-      'Thanks for installing pkg',
-      'Please consider donating to help us maintain this package.',
-      'GitHub',
-      'https://github.com/users/Jack/sponsorship',
-      'Patreon',
-      'https://patreon.com/Jack',
-      'Open Collective'
-    ]
+      "Thanks for installing pkg",
+      "Please consider donating to help us maintain this package.",
+      "GitHub",
+      "https://github.com/users/Jack/sponsorship",
+      "Patreon",
+      "https://patreon.com/Jack",
+      "Open Collective"
+    ];
 
     content.forEach(sentence => {
-      expect(log.includes(sentence)).toBe(true)
-    })
-  })
-
+      expect(log.includes(sentence)).toBe(true);
+    });
+  });
+
+  it("returns expected result on postinstall script", async () => {
+    process.env.GITHUB_SPONSORS_FORCE = true;
+    const { stdout: rawStdout } = await promisify(exec)("npm run postinstall", {
+      cwd: pkgPath,
+      env: process.env
+    });
+    const stdout = rawStdout.toString("utf8");
 
-  it('returns expected result on postinstall script', async () => {
-    process.env.GITHUB_SPONSORS_FORCE = true
-    const { stdout: rawStdout } = await promisify(exec)('npm run postinstall', { cwd: pkgPath, env: process.env })
-    const stdout = rawStdout.toString('utf8')
-  
     const content = [
-      'Thanks for installing pkg',
-      'Please consider donating to help us maintain this package.'
-    ]
+      "Thanks for installing pkg",
+      "Please consider donating to help us maintain this package."
+    ];
     content.forEach(sentence => {
-      expect(stdout.includes(sentence)).toBe(true)
-    })
-  })
-
-
-})
+      expect(stdout.includes(sentence)).toBe(true);
+    });
+  });
+});

__tests__/misc.test.js

@@ -1,45 +1,43 @@
-import {shouldHideMessage} from './../src/utils/misc'
-
-describe('shouldHideMessage()', () => {
+import { shouldHideMessage } from "./../src/utils/misc";
 
+describe("shouldHideMessage()", () => {
   // Force message
-  ;[1, true].forEach(truthy => {
+  [1, true].forEach(truthy => {
     it(`should not hide message when GITHUB_SPONSORS_FORCE is set to ${truthy}`, () => {
-      const env = { GITHUB_SPONSORS_FORCE: truthy}
+      const env = { GITHUB_SPONSORS_FORCE: truthy };
       expect(shouldHideMessage(env)).toBe(false);
-    })
-  })
+    });
+  });
 
   // Oracle postinstall
-  ;[1, true].forEach(truthy => {
+  [1, true].forEach(truthy => {
     it(`should hide message when OC_POSTINSTALL_TEST is set to ${truthy}`, () => {
-      const env = { OC_POSTINSTALL_TEST: truthy }
+      const env = { OC_POSTINSTALL_TEST: truthy };
       expect(shouldHideMessage(env)).toBe(true);
-    })
-  })
+    });
+  });
 
   // CI with CI env
-  ;[1, true].forEach(truthy => {
+  [1, true].forEach(truthy => {
     it(`should hide message when CI is set to ${truthy}`, () => {
-      const env = { CI: truthy }
+      const env = { CI: truthy };
       expect(shouldHideMessage(env)).toBe(true);
-    })
-  })
+    });
+  });
 
   // CI with CONTINUOUS_INTEGRATION env
-  ;[1, true].forEach(truthy => {
+  [1, true].forEach(truthy => {
     it(`should hide message when CONTINUOUS_INTEGRATION is set to ${truthy}`, () => {
-      const env = { CONTINUOUS_INTEGRATION: truthy }
+      const env = { CONTINUOUS_INTEGRATION: truthy };
       expect(shouldHideMessage(env)).toBe(true);
-    })
-  })
+    });
+  });
 
   // Dev environment
-  ;['test', 'production'].forEach(nodeEnv => {
+  ["test", "production"].forEach(nodeEnv => {
     it(`should hide message when node environment is not development`, () => {
-      const env = { NODE_ENV: nodeEnv }
+      const env = { NODE_ENV: nodeEnv };
       expect(shouldHideMessage(env)).toBe(true);
-    })
-  })
-
-})
+    });
+  });
+});

package.json

@@ -15,7 +15,7 @@
     "dev": "rollup -c rollup.config.js -w",
     "build": "rollup -c rollup.config.js",
     "prettier": "prettier --no-config --write '{src,__{tests,mocks}__}/**/*.js'",
-    "lint": "eslint",
+    "lint": "eslint src/",
     "justatest": "./bin/github-sponsors.js",
     "docs:dev": "vuepress dev docs",
     "docs:build": "vuepress build docs"

src/index.js

@@ -1,15 +1,17 @@
+/* eslint-disable no-console */
+
 import { parseFundingFile } from "./utils/parse";
 import { printDonationMessage } from "./utils/print";
 import { shouldHideMessage } from "./utils/misc";
 
-export async function init(path = process.cwd(), hideMessage = shouldHideMessage()) {
+export async function init(
+  path = process.cwd(),
+  hideMessage = shouldHideMessage()
+) {
   if (hideMessage) return;
   try {
     const fundingConfig = await parseFundingFile(path);
-    printDonationMessage(
-      fundingConfig,
-      path
-    );
+    printDonationMessage(fundingConfig, path);
   } catch (e) {
     console.error(e);
   }

src/utils/parse.js

@@ -1,6 +1,5 @@
 import fs from "fs";
 import { promisify } from "util";
-import path from "path";
 import YAML from "yaml";
 
 const readFile = promisify(fs.readFile);
@@ -10,10 +9,9 @@ const FUNDING_FILENAME = "FUNDING.yml";
 
 // Parse the FUNDING.yml and return the content
 export const parseFundingFile = async (path = process.cwd()) => {
-  let isFileExist = false;
   const pathToFile = `${path}/.github/${FUNDING_FILENAME}`;
   try {
-    isFileExist = await access(pathToFile, fs.constants.R_OK);
+    await access(pathToFile, fs.constants.R_OK);
   } catch (e) {
     throw new Error("FUNDING.yml file not found");
   }

src/utils/print.js

@@ -1,6 +1,9 @@
+/* eslint-disable no-console */
+/* eslint-disable no-control-regex */
+
 import { execSync } from "child_process";
-import path from 'path';
 import chalk from "chalk";
+import path from "path";
 
 // from nuxt/opencollective
 
@@ -36,11 +39,8 @@ export const print = (color = null) => (str = "") => {
   console.log(leftPadding, str);
 };
 
-export const printDonationMessage = (
-  fundingConfig,
-  pkgPath
-) => {
-  const packageJson = require(path.resolve(pkgPath) + '/package.json');
+export const printDonationMessage = (fundingConfig, pkgPath) => {
+  const packageJson = require(path.resolve(pkgPath) + "/package.json");
   const dim = print("dim");
   const yellow = print("yellow");
   const emptyLine = print();