Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Package tooling reorganization and README.md cleanup #42

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

jgrosspietsch
Copy link
Collaborator

@jgrosspietsch jgrosspietsch commented Sep 11, 2019

On this branch

Include a description of changes introduced on branch here

Verify

  • Confirm that cross browser testing has been completed.

  • Verify that no errors are present in the GPT console window.googletag.openConsole().

Comments

I changed/cleaned a bunch of this codebase to make it more maintainable. Most of the changes in this PR are from properly reconfiguring ESLint.

Minor changes/fixes:

  • Removed the dependencies we had listed as production dependencies: esdoc, esdoc-standard-plugin, and promise-polyfill. These were exclusively getting used as dev dependencies so I moved them there.
  • The repo had both a package-lock.json as well as a Yarn.lock which were out of sync with each other. The beginning of the README mentioned using NPM, while Yarn was mentioned more near the end. I saw no reason to use Yarn so I removed the Yarn.lock and updated the package-lock.json.
  • Jest tests wouldn't work. I had to add a testURL and upgrade Jest to get the tests to run.
  • Fixed the spelling, formatting, and phrasing for a lot of README.md.
  • ESLint rules were being set and overridden arbitrarily. If you're going to import the AirBnB rules, just use those. I basically started over with our ESLint configuration. Only one rule override in the config. Anything else can and should be overridden inline.
  • The dist directory wasn't in our .gitignore.

Webpack changes:

  • Upgraded to Webpack 4.
  • Webpack now builds two separate bundles, one use as a bundled library and the other as a UMD to be imported in a script tag. The library bundle uses @babel/plugin-transform-runtime and uses core-js polyfills. The UMD bundle uses @babel/preset-env with core-js polyfills.
  • promise-polyfill wasn't being used anyway so I uninstalled it. It's been replaced with core-js Promises.
  • Removed redundant babel-core and updated @babel/core.

(This is a draft PR because rigorous cross-browser testing is still needed.)

(Also, I would release this as a major update.)

@jgrosspietsch jgrosspietsch changed the title Cleanup and Package tooling reorganization and README.md cleanup Sep 11, 2019
@JackHowa JackHowa mentioned this pull request Oct 9, 2020
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants