From e3be73c8c9fdf05015931f7ec21124e7183c9180 Mon Sep 17 00:00:00 2001 From: Westin Wrzesinski Date: Tue, 1 Mar 2022 10:04:11 -0600 Subject: [PATCH] chore: add tooling for code coverage, changelogs, and conventional commits (#103) * update license * upgrade to grumbler-scripts v5 * setup codecov and badges * commitlint and standard version setup --- .github/workflows/main.yaml | 5 + .github/workflows/publish.yml | 32 ++++++ .husky/commit-msg | 4 + LICENSE | 201 ++++++++++++++++++++++++++++++++++ LICENSE.txt | 14 --- README.md | 6 + commitlint.config.js | 6 + package.json | 66 ++++++++--- publish.sh | 27 ----- src/serialize/window.js | 25 +++-- test/.eslintrc.js | 3 +- 11 files changed, 319 insertions(+), 70 deletions(-) create mode 100644 .github/workflows/publish.yml create mode 100755 .husky/commit-msg create mode 100644 LICENSE delete mode 100644 LICENSE.txt create mode 100644 commitlint.config.js delete mode 100755 publish.sh diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index d0b53261..e497e2e7 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -24,9 +24,14 @@ jobs: with: useLockFile: false + - name: 👕 Lint commit messages + uses: wagoid/commitlint-github-action@v4 + - name: ▶️ Run flow-typed script run: npm run flow-typed - name: ▶️ Run build script run: npm run build + - name: ⬆️ Upload karma coverage report + uses: codecov/codecov-action@v2 diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 00000000..918c6df6 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,32 @@ +name: "publish to npm" +on: workflow_dispatch +jobs: + main: + runs-on: ubuntu-latest + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v2 + with: + token: ${{ secrets.ACCESS_TOKEN }} + fetch-depth: 0 + + - name: ⎔ Setup node + # sets up the .npmrc file to publish to npm + uses: actions/setup-node@v2 + with: + node-version: "14" + registry-url: "https://registry.npmjs.org" + + - name: 📥 Download deps + uses: bahmutov/npm-install@v1 + with: + useLockFile: false + + - name: Configure git user + run: | + git config --global user.email ${{ github.actor }}@users.noreply.github.com + git config --global user.name ${{ github.actor }} + - name: ▶️ Run release + run: npm run release + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/.husky/commit-msg b/.husky/commit-msg new file mode 100755 index 00000000..3b4299ef --- /dev/null +++ b/.husky/commit-msg @@ -0,0 +1,4 @@ +#!/bin/sh +. "$(dirname "$0")/_/husky.sh" + +npx --no -- commitlint --edit "$1" diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..09a6d715 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2016 PayPal + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE.txt b/LICENSE.txt deleted file mode 100644 index f0127a0d..00000000 --- a/LICENSE.txt +++ /dev/null @@ -1,14 +0,0 @@ -/*───────────────────────────────────────────────────────────────────────────*\ -│ Copyright (C) 2016 PayPal │ -│ │ -│ │ -│ Licensed under the Apache License, Version 2.0 (the "License"); you may │ -│ not use this file except in compliance with the License. You may obtain │ -│ a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 │ -│ │ -│ Unless required by applicable law or agreed to in writing, software │ -│ distributed under the License is distributed on an "AS IS" BASIS, │ -│ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. │ -│ See the License for the specific language governing permissions and │ -│ limitations under the License. │ -\*───────────────────────────────────────────────────────────────────────────*/ diff --git a/README.md b/README.md index 4b10102d..b49da9b2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ # post-robot [:]-\\-< +[![build status][build-badge]][build] +[![code coverage][coverage-badge]][coverage] [![npm version][version-badge]][package] +[build-badge]: https://img.shields.io/github/workflow/status/krakenjs/post-robot/build?logo=github&style=flat-square +[build]: https://github.com/krakenjs/post-robot/actions?query=workflow%3Abuild +[coverage-badge]: https://img.shields.io/codecov/c/github/krakenjs/post-robot.svg?style=flat-square +[coverage]: https://codecov.io/github/krakenjs/post-robot/ [version-badge]: https://img.shields.io/npm/v/post-robot.svg?style=flat-square [package]: https://www.npmjs.com/package/post-robot diff --git a/commitlint.config.js b/commitlint.config.js new file mode 100644 index 00000000..e0e1077c --- /dev/null +++ b/commitlint.config.js @@ -0,0 +1,6 @@ +/* @flow */ +/* eslint import/no-commonjs: off */ + +module.exports = { + extends: [ '@commitlint/config-conventional' ] +}; diff --git a/package.json b/package.json index 3665cd1f..e9c60b2e 100644 --- a/package.json +++ b/package.json @@ -13,14 +13,53 @@ "webpack": "babel-node --config-file ./node_modules/grumbler-scripts/config/.babelrc-node --plugins=transform-es2015-modules-commonjs ./node_modules/.bin/webpack --display-optimization-bailout --progress", "test": "npm run lint && npm run flow-typed && npm run flow && npm run karma", "build": "npm run test && npm run babel && npm run webpack -- $@", - "release": "./publish.sh", - "release:patch": "./publish.sh patch", - "release:minor": "./publish.sh minor", - "release:major": "./publish.sh major", "clean": "rimraf dist coverage", "reinstall": "rimraf flow-typed && rimraf node_modules && npm install && flow-typed install", "debug": "cross-env NODE_ENV=debug", - "changelog": "./node_modules/.bin/auto-changelog" + "prepare": "husky install", + "prerelease": "npm run clean && npm run build && git add dist && git commit -m 'ci: check in dist folder' || echo 'Nothing to distribute'", + "release": "standard-version", + "postrelease": "git push && git push --follow-tags && npm publish" + }, + "standard-version": { + "types": [ + { + "type": "feat", + "section": "Features" + }, + { + "type": "fix", + "section": "Bug Fixes" + }, + { + "type": "chore", + "hidden": false + }, + { + "type": "docs", + "hidden": false + }, + { + "type": "style", + "hidden": false + }, + { + "type": "refactor", + "hidden": false + }, + { + "type": "perf", + "hidden": false + }, + { + "type": "test", + "hidden": false + }, + { + "type": "ci", + "hidden": true + } + ] }, "repository": { "type": "git", @@ -47,19 +86,14 @@ "globals.js" ], "readmeFilename": "README.md", - "auto-changelog": { - "output": "CHANGELOG.md", - "template": "compact", - "unreleased": false, - "commitLimit": 10, - "backfillLimit": 10, - "ignoreCommitPattern": "Dist" - }, "devDependencies": { - "auto-changelog": "^1.11.0", + "@commitlint/cli": "^16.2.1", + "@commitlint/config-conventional": "^16.2.1", "flow-bin": "0.155.0", - "grumbler-scripts": "^3", - "mocha": "^4" + "grumbler-scripts": "^5.0.3", + "husky": "^7.0.4", + "mocha": "^4", + "standard-version": "^9.3.2" }, "dependencies": { "belter": "^1.0.41", diff --git a/publish.sh b/publish.sh deleted file mode 100755 index c32e3418..00000000 --- a/publish.sh +++ /dev/null @@ -1,27 +0,0 @@ -#!/bin/sh - -set -e; - -if ! git diff-files --quiet; then - echo "Can not publish with unstaged uncommited changes"; - exit 1; -fi; - -if ! git diff-index --quiet --cached HEAD; then - echo "Can not publish with staged uncommited changes"; - exit 1; -fi; - -rm -rf node_modules/cross-domain-safe-weakmap node_modules/zalgo-promise node_modules/cross-domain-utils node_modules/belter -npm install cross-domain-safe-weakmap zalgo-promise cross-domain-utils belter - -npm run build -- --level=${1-patch}; - -git add dist; -git commit -m "Dist" || echo "Nothing to distribute"; - -npm version ${1-patch}; - -git push; -git push --tags; -npm publish; diff --git a/src/serialize/window.js b/src/serialize/window.js index 91f32988..bf6f7e99 100644 --- a/src/serialize/window.js +++ b/src/serialize/window.js @@ -1,4 +1,5 @@ /* @flow */ +/* eslint no-use-before-define: off */ import { isSameDomain, isWindowClosed, type CrossDomainWindowType, closeWindow, type DomainMatcher, getOpener, WINDOW_TYPE, isWindow, assertSameDomain, getFrameForWindow } from 'cross-domain-utils/src'; @@ -42,13 +43,13 @@ type SerializedWindowType = {| |}; function getSerializedWindow(winPromise : ZalgoPromise, { send, id = uniqueID() } : {| send : SendType, id? : string |}) : SerializedWindowType { - + let windowNamePromise = winPromise.then(win => { if (isSameDomain(win)) { return assertSameDomain(win).name; } }); - + const windowTypePromise = winPromise.then(window => { if (!isWindowClosed(window)) { return getOpener(window) ? WINDOW_TYPE.POPUP : WINDOW_TYPE.IFRAME; @@ -159,18 +160,18 @@ function getSerializedWindow(winPromise : ZalgoPromise, { export class ProxyWindow { - id : string - isProxyWindow : true = true - serializedWindow : SerializedWindowType - actualWindow : ?CrossDomainWindowType - actualWindowPromise : ZalgoPromise - send : SendType - name : string + id : string; + isProxyWindow : true = true; + serializedWindow : SerializedWindowType; + actualWindow : ?CrossDomainWindowType; + actualWindowPromise : ZalgoPromise; + send : SendType; + name : string; constructor({ send, win, serializedWindow } : {| win? : CrossDomainWindowType, serializedWindow? : SerializedWindowType, send : SendType |}) { this.actualWindowPromise = new ZalgoPromise(); this.serializedWindow = serializedWindow || getSerializedWindow(this.actualWindowPromise, { send }); - + globalStore('idToProxyWindow').set(this.getID(), this); if (win) { this.setWindow(win, { send }); @@ -248,7 +249,7 @@ export class ProxyWindow { if (this.actualWindow) { return win === this.actualWindow; } - + return ZalgoPromise.hash({ proxyInstanceID: this.getInstanceID(), knownWindowInstanceID: getWindowInstanceID(win, { send }) @@ -312,7 +313,7 @@ export class ProxyWindow { // $FlowFixMe const actualWindow : CrossDomainWindowType = win; - + return windowStore('winToProxyWindow').get(actualWindow) || new ProxyWindow({ win: actualWindow, send }); } } diff --git a/test/.eslintrc.js b/test/.eslintrc.js index b4b32e76..9eb6a983 100644 --- a/test/.eslintrc.js +++ b/test/.eslintrc.js @@ -1,5 +1,6 @@ /* @flow */ +/* eslint import/no-commonjs: off */ module.exports = { 'extends': '../node_modules/grumbler-scripts/config/.eslintrc-browser-test.js' -}; \ No newline at end of file +};