feat(imports): add doT template engine
#1024
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch adds the [`doT`](https://npmjs.org/dot) template engine to `axe.imports`. This is required for a runtime localization (a WIP feature). A lot of hackery was required to get this working, since `doT` doesn't expose a UMD wrapper that our build system supports. Rather than attempting to get our existing tooling to "unwrap" `doT`'s custom UMD, I've decided to save a lot of time/effort and just wrap it in an IIFE. There are likely 1,000,000s of variations of UMD in the wild and it's unreasonable for us to attempt to support them all. The added IIFE method works in cases where the code functions exactly the same regarless of enviroment (this does not include libraries like Axios). IMHO the only reasonable solution to this problem is to use a proper bundler for building `axe-core`.
marcysutton
reviewed
Jul 30, 2018
| * @param {string} sourceUrl path to the distributable of the library | ||
| * @param {string} sourceCode source code for the library | ||
| * @param {Object} [options] Optional options | ||
| * @property {Boolean} umd Does the library contain a UMD wrapper |
There was a problem hiding this comment.
Out of curiosity, what's the distinction between param and property here in jsdoc?
There was a problem hiding this comment.
property is a member of the above param
build/tasks/generate-imports.js
Outdated
|
|
||
| // If there was a global prior to our script, make sure we | ||
| // "save" it (think "$.noConflict()"). | ||
| var __old_global__ = global["${global}"]; |
There was a problem hiding this comment.
There are two global variables in use here, so the code is a little hard to follow (the global passed in and the variable set to the current scope). How can you reset to the old global when it has been overwritten with a new variable?
There was a problem hiding this comment.
The passed global is a library name. I'll rename to make that clearer.
To be sure its reset, see a few LOC below.
WilcoFiers
previously approved these changes
Jul 31, 2018
isner
previously approved these changes
Jul 31, 2018
WilcoFiers
approved these changes
Jul 31, 2018
stephenmathieson
added a commit
that referenced
this pull request
Jul 31, 2018
* develop: feat(imports): add `doT` template engine (#1024) doc: ensure client is closed doc: fix comment doc: fix "parity" typo doc: ensure user starts chrome chore(package): auto-format *.ts files (#1029) build: replace babel-preset-es2015 with babel-preset-env (#1027) chore: remove `.jshintrc` files (#1028) chore: add `.npmrc` (#1026) chore: upgrade Prettier and run the formatter (#1030) doc(examples): add simple CDP example ci: Speed up builds by caching node_modules (#1025)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch adds the
doTtemplate engine toaxe.imports. This is required for a runtime localization (a WIP feature).We're continuing to use
doTrather than replacing it with a maintained template engine because all of our rules/checks/messaging currently use it. Changing this now would be a very large task, which is outside of the scope of the feature I'm working on.A lot of hackery was required to get this working, since
doTdoesn't expose a UMD wrapper that our build system supports. Rather than attempting to get our existing tooling to "unwrap"doT's custom UMD, I've decided to save a lot of time/effort and just wrap it in an IIFE. There are likely 1,000s of variations of UMD in the wild and it's unreasonable for us to attempt to support them all. The added IIFE method works in cases where the code functions exactly the same regarless of enviroment (this does not include libraries like Axios). IMHO the only reasonable solution to this problem is to use a proper bundler for buildingaxe-core.Reviewer checks
Required fields, to be filled out by PR reviewer(s)