chore: use prettier (#55)

paypal · Jun 30, 2022 · 250fea3 · 250fea3
1 parent b7576df
commit 250fea3
Show file tree

Hide file tree

Showing 45 changed files with 1,145 additions and 1,026 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,33 +1,34 @@
 /* @flow */
 
 module.exports = {
-    'extends': './node_modules/@krakenjs/grumbler-scripts/config/.eslintrc-browser.js',
+  extends:
+    "./node_modules/@krakenjs/grumbler-scripts/config/.eslintrc-browser.js",
 
-    'globals': {
-        'Promise': false,
-        '__PAYPAL_CHECKOUT__': true,
-        '__paypal_checkout__': true,
-        '__sdk__': true,
-        '__LOCALE__': true,
-        '__CLIENT_ID__': true,
-        '__MERCHANT_ID__': true,
-        '__INTENT__': true,
-        '__COMMIT__': true,
-        '__VAULT__': true,
-        '__PORT__': true,
-        '__STAGE_HOST__': true,
-        '__HOST__': true,
-        '__PATH__': true,
-        '__COMPONENTS__': true
-    },
+  globals: {
+    Promise: false,
+    __PAYPAL_CHECKOUT__: true,
+    __paypal_checkout__: true,
+    __sdk__: true,
+    __LOCALE__: true,
+    __CLIENT_ID__: true,
+    __MERCHANT_ID__: true,
+    __INTENT__: true,
+    __COMMIT__: true,
+    __VAULT__: true,
+    __PORT__: true,
+    __STAGE_HOST__: true,
+    __HOST__: true,
+    __PATH__: true,
+    __COMPONENTS__: true,
+  },
 
-    'rules': {
-        'complexity': 'off',
-        'max-nested-callbacks': [ 'error', 5 ],
-        'react/prop-types': 'off',
-        'react/style-prop-object': 'off',
-        'react/display-name': 'off',
-        'react/require-default-props': 'off',
-        'react/forbid-component-props': 'off'
-    }
-};
+  rules: {
+    complexity: "off",
+    "max-nested-callbacks": ["error", 5],
+    "react/prop-types": "off",
+    "react/style-prop-object": "off",
+    "react/display-name": "off",
+    "react/require-default-props": "off",
+    "react/forbid-component-props": "off",
+  },
+};
diff --git a/.github/renovate.json b/.github/renovate.json
@@ -1,18 +1,13 @@
 {
-  "extends": [
-    "config:base",
-    ":preserveSemverRanges"
-  ],
+  "extends": ["config:base", ":preserveSemverRanges"],
   "prCreation": "immediate",
   "prHourlyLimit": 0,
   "rangeStrategy": "status-success",
   "separateMajorMinor": false,
   "semanticCommits": true,
   "timezone": "America/Los_Angeles",
   "rebaseStalePrs": true,
-  "labels": [
-    ":christmas_tree: dependencies"
-  ],
+  "labels": [":christmas_tree: dependencies"],
   "packageRules": [
     {
       "packagePatterns": "^babel",

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -16,7 +16,7 @@ jobs:
       - name: ⎔ Setup node
         uses: actions/setup-node@v2
         with:
-          node-version: '14'
+          node-version: "14"
 
       - name: 📥 Download deps
         uses: bahmutov/npm-install@v1

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -15,8 +15,8 @@ jobs:
         # sets up the .npmrc file to publish to npm
         uses: actions/setup-node@v2
         with:
-          node-version: '14'
-          registry-url: 'https://registry.npmjs.org'
+          node-version: "14"
+          registry-url: "https://registry.npmjs.org"
 
       - name: 📥 Download deps
         uses: bahmutov/npm-install@v1

diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,5 @@
+build
+dist
+coverage
+flow-typed
+CHANGELOG.md
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1 @@
+{}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,7 +6,9 @@ Feel free to raise a pull request to us. Our team would review your proposed mod
 your changes into our code. Ideas and other comments are also welcome.
 
 ## Getting Started
+
 1. Create your own [fork](https://help.github.com/articles/fork-a-repo) of this [repository](../../fork).
+
 ```bash
 # Clone it
 $ git clone [email protected]:me/paypal-checkout.git
@@ -28,10 +30,12 @@ $ npm test
 ```
 
 ## Making Changes
+
 1. Make sure that your changes adhere to the current coding conventions used throughout the project, indentation, accurate comments, etc.
 2. Ensure existing tests pass (`$ npm test`) and include test cases which fail without your change and succeed with it.
 
 ## Submitting Changes
+
 1. Ensure that no errors are generated by ESLint (run during `$ npm test`).
 2. Commit your changes in logical chunks, i.e. keep your changes small per single commit.
 3. Locally merge (or rebase) the upstream branch into your topic branch: `$ git pull upstream && git merge`.

diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-PayPal Common Components
-------------------------
+## PayPal Common Components
 
 [![build status][build-badge]][build]
 [![code coverage][coverage-badge]][coverage]
@@ -42,13 +41,14 @@ npm run dev
 ```
 
 ## Test Tasks
+
 ```
 npm test
 ```
 
-| Flags  | Description |
-| ------------- | ------------- |
-| --clear-cache | Clear Babel Loader and PhantomJS cache |
-| --debug | Debug mode.  PhantomJS, Karma, and CheckoutJS  |
-| --quick | Fastest testing.  Minimal output, no coverage |
-| --browser | Choose Browser |
+| Flags         | Description                                  |
+| ------------- | -------------------------------------------- |
+| --clear-cache | Clear Babel Loader and PhantomJS cache       |
+| --debug       | Debug mode. PhantomJS, Karma, and CheckoutJS |
+| --quick       | Fastest testing. Minimal output, no coverage |
+| --browser     | Choose Browser                               |
diff --git a/__sdk__.js b/__sdk__.js
@@ -1,12 +1,12 @@
 /* @flow */
 /* eslint unicorn/filename-case: 0, import/unambiguous: 0, import/no-commonjs: 0 */
 
-const globals = require('./globals');
+const globals = require("./globals");
 
 module.exports = {
-    common: {
-        automatic: true,
-        entry:     './src/interface',
-        globals
-    }
+  common: {
+    automatic: true,
+    entry: "./src/interface",
+    globals,
+  },
 };
diff --git a/babel.config.json b/babel.config.json
@@ -1,3 +1,3 @@
 {
   "extends": "@krakenjs/grumbler-scripts/config/.babelrc-node"
-}
+}
diff --git a/globals.js b/globals.js
@@ -1,23 +1,22 @@
 /* eslint import/no-commonjs: off, flowtype/require-valid-file-annotation: off, flowtype/require-return-type: off */
 
-const postRobotGlobals = require('@krakenjs/post-robot/globals');
-const zoidGlobals = require('@krakenjs/zoid/globals');
+const postRobotGlobals = require("@krakenjs/post-robot/globals");
+const zoidGlobals = require("@krakenjs/zoid/globals");
 
 module.exports = {
+  __ZOID__: {
+    ...zoidGlobals.__ZOID__,
+    __DEFAULT_CONTAINER__: true,
+    __DEFAULT_PRERENDER__: true,
+    __FRAMEWORK_SUPPORT__: true,
+  },
 
-    __ZOID__: {
-        ...zoidGlobals.__ZOID__,
-        __DEFAULT_CONTAINER__: true,
-        __DEFAULT_PRERENDER__: true,
-        __FRAMEWORK_SUPPORT__: true
-    },
+  __POST_ROBOT__: {
+    ...postRobotGlobals.__POST_ROBOT__,
+    __IE_POPUP_SUPPORT__: false,
+  },
 
-    __POST_ROBOT__: {
-        ...postRobotGlobals.__POST_ROBOT__,
-        __IE_POPUP_SUPPORT__: false
-    },
-
-    __PAYPAL_CHECKOUT__: {
-        __REMEMBERED_FUNDING__: []
-    }
+  __PAYPAL_CHECKOUT__: {
+    __REMEMBERED_FUNDING__: [],
+  },
 };
diff --git a/jest.config.js b/jest.config.js
@@ -1,5 +1,3 @@
 /* eslint import/no-commonjs: off, flowtype/require-valid-file-annotation: off */
 
-module.exports = {
-
-};
+module.exports = {};
diff --git a/karma.conf.js b/karma.conf.js
@@ -1,44 +1,43 @@
 /* @flow */
 /* eslint import/no-default-export: off */
 
-import { getKarmaConfig } from '@krakenjs/grumbler-scripts/config/karma.conf';
-
-import { WEBPACK_CONFIG_TEST } from './webpack.config';
-
-export default function configKarma(karma : Object) {
-
-    const karmaConfig = getKarmaConfig(karma, {
-        basePath:  __dirname,
-        testDir:   'test',
-        windowDir: 'test/integration/windows',
-        entry:     'test/integration/index.js',
-        webpack:   WEBPACK_CONFIG_TEST
-    });
-
-    karma.set({
-        ...karmaConfig,
-
-        files: [
-            {
-                pattern:  'test/integration/globals.js',
-                included: true,
-                served:   true
-            },
-
-            {
-                pattern:  'test/paypal.js',
-                included: true,
-                served:   true
-            },
-
-            ...karmaConfig.files
-        ],
-
-        preprocessors: {
-            ...karmaConfig.preprocessors,
-
-            'src/index.js': [ 'webpack', 'sourcemap' ],
-            'src/**/*.js':  [ 'sourcemap' ]
-        }
-    });
+import { getKarmaConfig } from "@krakenjs/grumbler-scripts/config/karma.conf";
+
+import { WEBPACK_CONFIG_TEST } from "./webpack.config";
+
+export default function configKarma(karma: Object) {
+  const karmaConfig = getKarmaConfig(karma, {
+    basePath: __dirname,
+    testDir: "test",
+    windowDir: "test/integration/windows",
+    entry: "test/integration/index.js",
+    webpack: WEBPACK_CONFIG_TEST,
+  });
+
+  karma.set({
+    ...karmaConfig,
+
+    files: [
+      {
+        pattern: "test/integration/globals.js",
+        included: true,
+        served: true,
+      },
+
+      {
+        pattern: "test/paypal.js",
+        included: true,
+        served: true,
+      },
+
+      ...karmaConfig.files,
+    ],
+
+    preprocessors: {
+      ...karmaConfig.preprocessors,
+
+      "src/index.js": ["webpack", "sourcemap"],
+      "src/**/*.js": ["sourcemap"],
+    },
+  });
 }
diff --git a/package.json b/package.json
@@ -8,7 +8,9 @@
     "flow-typed": "rm -rf flow-typed && flow-typed install",
     "flow": "flow",
     "karma": "cross-env NODE_ENV=test babel-node $(npm bin)/karma start",
-    "test": "npm run lint && npm run flow-typed && npm run flow && npm run karma",
+    "format": "prettier --write --ignore-unknown .",
+    "format:check": "prettier --check .",
+    "test": "npm run format:check && npm run lint && npm run flow-typed && npm run flow && npm run karma",
     "build": "npm run test && npm run webpack",
     "release": "./scripts/publish.sh",
     "release:patch": "./scripts/publish.sh patch",
@@ -21,7 +23,8 @@
     "reinstall": "rimraf flow-typed && rimraf node_modules && npm install && flow-typed install",
     "debug": "cross-env NODE_ENV=debug",
     "webpack": "babel-node --plugins=transform-es2015-modules-commonjs ./node_modules/.bin/webpack --progress",
-    "eslint-find-rules": "eslint-find-rules --current .eslintrc.js --unused --plugin"
+    "eslint-find-rules": "eslint-find-rules --current .eslintrc.js --unused --plugin",
+    "prepare": "husky install"
   },
   "files": [
     "src/",
@@ -52,19 +55,22 @@
   "license": "Apache-2.0",
   "readmeFilename": "README.md",
   "devDependencies": {
-    "@krakenjs/grumbler-scripts": "^6.0.2",
+    "@krakenjs/grumbler-scripts": "^7.0.0",
     "@krakenjs/sync-browser-mocks": "^3.0.0",
     "babel-core": "^7.0.0-bridge.0",
     "conventional-changelog-cli": "^2.0.11",
     "flow-bin": "0.135.0",
     "fs-extra": "^4.0.2",
+    "husky": "^8.0.1",
     "imagemagick": "^0.1.3",
     "imgur": "^0.2.1",
+    "lint-staged": "^13.0.3",
     "memory-fs": "^0.4.1",
     "mocha": "^4",
     "mocketeer": "^0.3.0",
     "pixelmatch": "^4.0.2",
     "pngjs": "^3.3.0",
+    "prettier": "2.7.1",
     "serve": "^10.1.2"
   },
   "dependencies": {
@@ -76,5 +82,8 @@
     "@krakenjs/post-robot": "^11.0.0",
     "@krakenjs/zalgo-promise": "^2.0.0",
     "@krakenjs/zoid": "^10.0.0"
+  },
+  "lint-staged": {
+    "**/*": "prettier --write --ignore-unknown"
   }
 }