Skip to content

[typescript] Support esbuild, second attempt - #11465

Merged
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import
Apr 6, 2022
Merged

[typescript] Support esbuild, second attempt#11465
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import

Conversation

@bodograumann

Copy link
Copy Markdown
Contributor

The first try in #11298 did not work, because it broke the commonjs output.

Now I have differentiated between the two. When es6 is activated, we build an esmodule and when it is deactivated we build the classic commonjs format. For commonjs we don’t need to change our imports, because the esmodule import restrictions don’t apply to the commonjs format. For esmodule output we use a default import.

To make sure everything works, I have added a new sample that has supportsES6 enabled. The tests for it use esbuild as bundler. (Unfortunately a bundler is needed in any case, because we include commonjs polyfills. Ideally the esmodule output could just run in the browser as-is, but that is something for another day.)

As before I have included proper typings for url-parse.
I also had to expose the RequiredError exception type to allow explicit casting to it, because typescript regards errors in catch as unknown these days.
Pet API tests are run against http://localhost/v2 as base server, to prevent HSTS in the browser from forcing https.
Finally, I added more fields to package.json that include the module type and entry point, to improve compatibility with node and bundlers, especially when generating esmodule output.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Ugh, seems pupeteer does not readily work in the pipeline:

/home/circleci/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/typescript/tests/browser/node_modules/puppeteer/.local-chromium/linux-950341/chrome-linux/chrome: error while loading shared libraries: libgbm.so.1: cannot open shared object file: No such file or directory

I have added the chromium dependencies to circleci as per the pupeteer instructions. Hope this is the way to go.

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 3 times, most recently from 69b39df to 5a9a281CompareJanuary 31, 2022 13:03
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Neither libgbm1 nor libgbm-dev can be installed :-|.
Is the ci base image too old @wing328 ?

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 2 times, most recently from 005d2a5 to b090cbfCompareApril 6, 2022 07:27
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Yay it works! 🚀

Please have another look at this PR now.

@macjohnnymacjohnny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@macjohnny
macjohnny merged commit 510f799 into OpenAPITools:masterApr 6, 2022
@macjohnnymacjohnny added this to the 6.0.0 milestone Apr 6, 2022
cachescrubber pushed a commit to cachescrubber/openapi-generator that referenced this pull request Apr 9, 2022
* Install correct typings for url-parse
* Use es modules compat mode when es6 output is selected
* Consolidate typescript sample generation naming scheme
* Regenerate samples
* Create new typescript sample to test esmodules in browser
* Expose RequiredError type
* Make browser integration tests pass locally
* Remove cookie tests, because we don’t allow cross-origin cookies
* Add output type to package definition
* Execute new browser tests in pipeline
* Install headless chromium dependencies in circle ci
Sign up for freeto 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.

2 participants

@bodograumann@macjohnny
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[typescript] Support esbuild, second attempt by bodograumann · Pull Request #11465 · OpenAPITools/openapi-generator · GitHub
Skip to content

[typescript] Support esbuild, second attempt - #11465

Merged
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import
Apr 6, 2022
Merged

[typescript] Support esbuild, second attempt#11465
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import

Conversation

@bodograumann

Copy link
Copy Markdown
Contributor

The first try in #11298 did not work, because it broke the commonjs output.

Now I have differentiated between the two. When es6 is activated, we build an esmodule and when it is deactivated we build the classic commonjs format. For commonjs we don’t need to change our imports, because the esmodule import restrictions don’t apply to the commonjs format. For esmodule output we use a default import.

To make sure everything works, I have added a new sample that has supportsES6 enabled. The tests for it use esbuild as bundler. (Unfortunately a bundler is needed in any case, because we include commonjs polyfills. Ideally the esmodule output could just run in the browser as-is, but that is something for another day.)

As before I have included proper typings for url-parse.
I also had to expose the RequiredError exception type to allow explicit casting to it, because typescript regards errors in catch as unknown these days.
Pet API tests are run against http://localhost/v2 as base server, to prevent HSTS in the browser from forcing https.
Finally, I added more fields to package.json that include the module type and entry point, to improve compatibility with node and bundlers, especially when generating esmodule output.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Ugh, seems pupeteer does not readily work in the pipeline:

/home/circleci/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/typescript/tests/browser/node_modules/puppeteer/.local-chromium/linux-950341/chrome-linux/chrome: error while loading shared libraries: libgbm.so.1: cannot open shared object file: No such file or directory

I have added the chromium dependencies to circleci as per the pupeteer instructions. Hope this is the way to go.

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 3 times, most recently from 69b39df to 5a9a281CompareJanuary 31, 2022 13:03
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Neither libgbm1 nor libgbm-dev can be installed :-|.
Is the ci base image too old @wing328 ?

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 2 times, most recently from 005d2a5 to b090cbfCompareApril 6, 2022 07:27
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Yay it works! 🚀

Please have another look at this PR now.

@macjohnnymacjohnny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@macjohnny
macjohnny merged commit 510f799 into OpenAPITools:masterApr 6, 2022
@macjohnnymacjohnny added this to the 6.0.0 milestone Apr 6, 2022
cachescrubber pushed a commit to cachescrubber/openapi-generator that referenced this pull request Apr 9, 2022
* Install correct typings for url-parse
* Use es modules compat mode when es6 output is selected
* Consolidate typescript sample generation naming scheme
* Regenerate samples
* Create new typescript sample to test esmodules in browser
* Expose RequiredError type
* Make browser integration tests pass locally
* Remove cookie tests, because we don’t allow cross-origin cookies
* Add output type to package definition
* Execute new browser tests in pipeline
* Install headless chromium dependencies in circle ci
Sign up for freeto 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.

2 participants

@bodograumann@macjohnny
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [typescript] Support esbuild, second attempt by bodograumann · Pull Request #11465 · OpenAPITools/openapi-generator · GitHub
Skip to content

[typescript] Support esbuild, second attempt - #11465

Merged
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import
Apr 6, 2022
Merged

[typescript] Support esbuild, second attempt#11465
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import

Conversation

@bodograumann

Copy link
Copy Markdown
Contributor

The first try in #11298 did not work, because it broke the commonjs output.

Now I have differentiated between the two. When es6 is activated, we build an esmodule and when it is deactivated we build the classic commonjs format. For commonjs we don’t need to change our imports, because the esmodule import restrictions don’t apply to the commonjs format. For esmodule output we use a default import.

To make sure everything works, I have added a new sample that has supportsES6 enabled. The tests for it use esbuild as bundler. (Unfortunately a bundler is needed in any case, because we include commonjs polyfills. Ideally the esmodule output could just run in the browser as-is, but that is something for another day.)

As before I have included proper typings for url-parse.
I also had to expose the RequiredError exception type to allow explicit casting to it, because typescript regards errors in catch as unknown these days.
Pet API tests are run against http://localhost/v2 as base server, to prevent HSTS in the browser from forcing https.
Finally, I added more fields to package.json that include the module type and entry point, to improve compatibility with node and bundlers, especially when generating esmodule output.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Ugh, seems pupeteer does not readily work in the pipeline:

/home/circleci/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/typescript/tests/browser/node_modules/puppeteer/.local-chromium/linux-950341/chrome-linux/chrome: error while loading shared libraries: libgbm.so.1: cannot open shared object file: No such file or directory

I have added the chromium dependencies to circleci as per the pupeteer instructions. Hope this is the way to go.

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 3 times, most recently from 69b39df to 5a9a281CompareJanuary 31, 2022 13:03
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Neither libgbm1 nor libgbm-dev can be installed :-|.
Is the ci base image too old @wing328 ?

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 2 times, most recently from 005d2a5 to b090cbfCompareApril 6, 2022 07:27
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Yay it works! 🚀

Please have another look at this PR now.

@macjohnnymacjohnny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@macjohnny
macjohnny merged commit 510f799 into OpenAPITools:masterApr 6, 2022
@macjohnnymacjohnny added this to the 6.0.0 milestone Apr 6, 2022
cachescrubber pushed a commit to cachescrubber/openapi-generator that referenced this pull request Apr 9, 2022
* Install correct typings for url-parse
* Use es modules compat mode when es6 output is selected
* Consolidate typescript sample generation naming scheme
* Regenerate samples
* Create new typescript sample to test esmodules in browser
* Expose RequiredError type
* Make browser integration tests pass locally
* Remove cookie tests, because we don’t allow cross-origin cookies
* Add output type to package definition
* Execute new browser tests in pipeline
* Install headless chromium dependencies in circle ci
Sign up for freeto 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.

2 participants

@bodograumann@macjohnny
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [typescript] Support esbuild, second attempt by bodograumann · Pull Request #11465 · OpenAPITools/openapi-generator · GitHub
Skip to content

[typescript] Support esbuild, second attempt - #11465

Merged
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import
Apr 6, 2022
Merged

[typescript] Support esbuild, second attempt#11465
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import

Conversation

@bodograumann

Copy link
Copy Markdown
Contributor

The first try in #11298 did not work, because it broke the commonjs output.

Now I have differentiated between the two. When es6 is activated, we build an esmodule and when it is deactivated we build the classic commonjs format. For commonjs we don’t need to change our imports, because the esmodule import restrictions don’t apply to the commonjs format. For esmodule output we use a default import.

To make sure everything works, I have added a new sample that has supportsES6 enabled. The tests for it use esbuild as bundler. (Unfortunately a bundler is needed in any case, because we include commonjs polyfills. Ideally the esmodule output could just run in the browser as-is, but that is something for another day.)

As before I have included proper typings for url-parse.
I also had to expose the RequiredError exception type to allow explicit casting to it, because typescript regards errors in catch as unknown these days.
Pet API tests are run against http://localhost/v2 as base server, to prevent HSTS in the browser from forcing https.
Finally, I added more fields to package.json that include the module type and entry point, to improve compatibility with node and bundlers, especially when generating esmodule output.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Ugh, seems pupeteer does not readily work in the pipeline:

/home/circleci/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/typescript/tests/browser/node_modules/puppeteer/.local-chromium/linux-950341/chrome-linux/chrome: error while loading shared libraries: libgbm.so.1: cannot open shared object file: No such file or directory

I have added the chromium dependencies to circleci as per the pupeteer instructions. Hope this is the way to go.

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 3 times, most recently from 69b39df to 5a9a281CompareJanuary 31, 2022 13:03
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Neither libgbm1 nor libgbm-dev can be installed :-|.
Is the ci base image too old @wing328 ?

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 2 times, most recently from 005d2a5 to b090cbfCompareApril 6, 2022 07:27
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Yay it works! 🚀

Please have another look at this PR now.

@macjohnnymacjohnny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@macjohnny
macjohnny merged commit 510f799 into OpenAPITools:masterApr 6, 2022
@macjohnnymacjohnny added this to the 6.0.0 milestone Apr 6, 2022
cachescrubber pushed a commit to cachescrubber/openapi-generator that referenced this pull request Apr 9, 2022
* Install correct typings for url-parse
* Use es modules compat mode when es6 output is selected
* Consolidate typescript sample generation naming scheme
* Regenerate samples
* Create new typescript sample to test esmodules in browser
* Expose RequiredError type
* Make browser integration tests pass locally
* Remove cookie tests, because we don’t allow cross-origin cookies
* Add output type to package definition
* Execute new browser tests in pipeline
* Install headless chromium dependencies in circle ci
Sign up for freeto 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.

2 participants

@bodograumann@macjohnny
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' [typescript] Support esbuild, second attempt by bodograumann · Pull Request #11465 · OpenAPITools/openapi-generator · GitHub
Skip to content

[typescript] Support esbuild, second attempt - #11465

Merged
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import
Apr 6, 2022
Merged

[typescript] Support esbuild, second attempt#11465
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import

Conversation

@bodograumann

Copy link
Copy Markdown
Contributor

The first try in #11298 did not work, because it broke the commonjs output.

Now I have differentiated between the two. When es6 is activated, we build an esmodule and when it is deactivated we build the classic commonjs format. For commonjs we don’t need to change our imports, because the esmodule import restrictions don’t apply to the commonjs format. For esmodule output we use a default import.

To make sure everything works, I have added a new sample that has supportsES6 enabled. The tests for it use esbuild as bundler. (Unfortunately a bundler is needed in any case, because we include commonjs polyfills. Ideally the esmodule output could just run in the browser as-is, but that is something for another day.)

As before I have included proper typings for url-parse.
I also had to expose the RequiredError exception type to allow explicit casting to it, because typescript regards errors in catch as unknown these days.
Pet API tests are run against http://localhost/v2 as base server, to prevent HSTS in the browser from forcing https.
Finally, I added more fields to package.json that include the module type and entry point, to improve compatibility with node and bundlers, especially when generating esmodule output.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Ugh, seems pupeteer does not readily work in the pipeline:

/home/circleci/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/typescript/tests/browser/node_modules/puppeteer/.local-chromium/linux-950341/chrome-linux/chrome: error while loading shared libraries: libgbm.so.1: cannot open shared object file: No such file or directory

I have added the chromium dependencies to circleci as per the pupeteer instructions. Hope this is the way to go.

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 3 times, most recently from 69b39df to 5a9a281CompareJanuary 31, 2022 13:03
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Neither libgbm1 nor libgbm-dev can be installed :-|.
Is the ci base image too old @wing328 ?

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 2 times, most recently from 005d2a5 to b090cbfCompareApril 6, 2022 07:27
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Yay it works! 🚀

Please have another look at this PR now.

@macjohnnymacjohnny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@macjohnny
macjohnny merged commit 510f799 into OpenAPITools:masterApr 6, 2022
@macjohnnymacjohnny added this to the 6.0.0 milestone Apr 6, 2022
cachescrubber pushed a commit to cachescrubber/openapi-generator that referenced this pull request Apr 9, 2022
* Install correct typings for url-parse
* Use es modules compat mode when es6 output is selected
* Consolidate typescript sample generation naming scheme
* Regenerate samples
* Create new typescript sample to test esmodules in browser
* Expose RequiredError type
* Make browser integration tests pass locally
* Remove cookie tests, because we don’t allow cross-origin cookies
* Add output type to package definition
* Execute new browser tests in pipeline
* Install headless chromium dependencies in circle ci
Sign up for freeto 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.

2 participants

@bodograumann@macjohnny
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [typescript] Support esbuild, second attempt by bodograumann · Pull Request #11465 · OpenAPITools/openapi-generator · GitHub
Skip to content

[typescript] Support esbuild, second attempt - #11465

Merged
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import
Apr 6, 2022
Merged

[typescript] Support esbuild, second attempt#11465
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import

Conversation

@bodograumann

Copy link
Copy Markdown
Contributor

The first try in #11298 did not work, because it broke the commonjs output.

Now I have differentiated between the two. When es6 is activated, we build an esmodule and when it is deactivated we build the classic commonjs format. For commonjs we don’t need to change our imports, because the esmodule import restrictions don’t apply to the commonjs format. For esmodule output we use a default import.

To make sure everything works, I have added a new sample that has supportsES6 enabled. The tests for it use esbuild as bundler. (Unfortunately a bundler is needed in any case, because we include commonjs polyfills. Ideally the esmodule output could just run in the browser as-is, but that is something for another day.)

As before I have included proper typings for url-parse.
I also had to expose the RequiredError exception type to allow explicit casting to it, because typescript regards errors in catch as unknown these days.
Pet API tests are run against http://localhost/v2 as base server, to prevent HSTS in the browser from forcing https.
Finally, I added more fields to package.json that include the module type and entry point, to improve compatibility with node and bundlers, especially when generating esmodule output.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Ugh, seems pupeteer does not readily work in the pipeline:

/home/circleci/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/typescript/tests/browser/node_modules/puppeteer/.local-chromium/linux-950341/chrome-linux/chrome: error while loading shared libraries: libgbm.so.1: cannot open shared object file: No such file or directory

I have added the chromium dependencies to circleci as per the pupeteer instructions. Hope this is the way to go.

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 3 times, most recently from 69b39df to 5a9a281CompareJanuary 31, 2022 13:03
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Neither libgbm1 nor libgbm-dev can be installed :-|.
Is the ci base image too old @wing328 ?

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 2 times, most recently from 005d2a5 to b090cbfCompareApril 6, 2022 07:27
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Yay it works! 🚀

Please have another look at this PR now.

@macjohnnymacjohnny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@macjohnny
macjohnny merged commit 510f799 into OpenAPITools:masterApr 6, 2022
@macjohnnymacjohnny added this to the 6.0.0 milestone Apr 6, 2022
cachescrubber pushed a commit to cachescrubber/openapi-generator that referenced this pull request Apr 9, 2022
* Install correct typings for url-parse
* Use es modules compat mode when es6 output is selected
* Consolidate typescript sample generation naming scheme
* Regenerate samples
* Create new typescript sample to test esmodules in browser
* Expose RequiredError type
* Make browser integration tests pass locally
* Remove cookie tests, because we don’t allow cross-origin cookies
* Add output type to package definition
* Execute new browser tests in pipeline
* Install headless chromium dependencies in circle ci
Sign up for freeto 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.

2 participants

@bodograumann@macjohnny
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [typescript] Support esbuild, second attempt by bodograumann · Pull Request #11465 · OpenAPITools/openapi-generator · GitHub
Skip to content

[typescript] Support esbuild, second attempt - #11465

Merged
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import
Apr 6, 2022
Merged

[typescript] Support esbuild, second attempt#11465
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import

Conversation

@bodograumann

Copy link
Copy Markdown
Contributor

The first try in #11298 did not work, because it broke the commonjs output.

Now I have differentiated between the two. When es6 is activated, we build an esmodule and when it is deactivated we build the classic commonjs format. For commonjs we don’t need to change our imports, because the esmodule import restrictions don’t apply to the commonjs format. For esmodule output we use a default import.

To make sure everything works, I have added a new sample that has supportsES6 enabled. The tests for it use esbuild as bundler. (Unfortunately a bundler is needed in any case, because we include commonjs polyfills. Ideally the esmodule output could just run in the browser as-is, but that is something for another day.)

As before I have included proper typings for url-parse.
I also had to expose the RequiredError exception type to allow explicit casting to it, because typescript regards errors in catch as unknown these days.
Pet API tests are run against http://localhost/v2 as base server, to prevent HSTS in the browser from forcing https.
Finally, I added more fields to package.json that include the module type and entry point, to improve compatibility with node and bundlers, especially when generating esmodule output.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Ugh, seems pupeteer does not readily work in the pipeline:

/home/circleci/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/typescript/tests/browser/node_modules/puppeteer/.local-chromium/linux-950341/chrome-linux/chrome: error while loading shared libraries: libgbm.so.1: cannot open shared object file: No such file or directory

I have added the chromium dependencies to circleci as per the pupeteer instructions. Hope this is the way to go.

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 3 times, most recently from 69b39df to 5a9a281CompareJanuary 31, 2022 13:03
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Neither libgbm1 nor libgbm-dev can be installed :-|.
Is the ci base image too old @wing328 ?

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 2 times, most recently from 005d2a5 to b090cbfCompareApril 6, 2022 07:27
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Yay it works! 🚀

Please have another look at this PR now.

@macjohnnymacjohnny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@macjohnny
macjohnny merged commit 510f799 into OpenAPITools:masterApr 6, 2022
@macjohnnymacjohnny added this to the 6.0.0 milestone Apr 6, 2022
cachescrubber pushed a commit to cachescrubber/openapi-generator that referenced this pull request Apr 9, 2022
* Install correct typings for url-parse
* Use es modules compat mode when es6 output is selected
* Consolidate typescript sample generation naming scheme
* Regenerate samples
* Create new typescript sample to test esmodules in browser
* Expose RequiredError type
* Make browser integration tests pass locally
* Remove cookie tests, because we don’t allow cross-origin cookies
* Add output type to package definition
* Execute new browser tests in pipeline
* Install headless chromium dependencies in circle ci
Sign up for freeto 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.

2 participants

@bodograumann@macjohnny
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); [typescript] Support esbuild, second attempt by bodograumann · Pull Request #11465 · OpenAPITools/openapi-generator · GitHub
Skip to content

[typescript] Support esbuild, second attempt - #11465

Merged
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import
Apr 6, 2022
Merged

[typescript] Support esbuild, second attempt#11465
macjohnny merged 11 commits into
OpenAPITools:masterfrom
bodograumann:ts-url-parse-import

Conversation

@bodograumann

Copy link
Copy Markdown
Contributor

The first try in #11298 did not work, because it broke the commonjs output.

Now I have differentiated between the two. When es6 is activated, we build an esmodule and when it is deactivated we build the classic commonjs format. For commonjs we don’t need to change our imports, because the esmodule import restrictions don’t apply to the commonjs format. For esmodule output we use a default import.

To make sure everything works, I have added a new sample that has supportsES6 enabled. The tests for it use esbuild as bundler. (Unfortunately a bundler is needed in any case, because we include commonjs polyfills. Ideally the esmodule output could just run in the browser as-is, but that is something for another day.)

As before I have included proper typings for url-parse.
I also had to expose the RequiredError exception type to allow explicit casting to it, because typescript regards errors in catch as unknown these days.
Pet API tests are run against http://localhost/v2 as base server, to prevent HSTS in the browser from forcing https.
Finally, I added more fields to package.json that include the module type and entry point, to improve compatibility with node and bundlers, especially when generating esmodule output.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Ugh, seems pupeteer does not readily work in the pipeline:

/home/circleci/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/typescript/tests/browser/node_modules/puppeteer/.local-chromium/linux-950341/chrome-linux/chrome: error while loading shared libraries: libgbm.so.1: cannot open shared object file: No such file or directory

I have added the chromium dependencies to circleci as per the pupeteer instructions. Hope this is the way to go.

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 3 times, most recently from 69b39df to 5a9a281CompareJanuary 31, 2022 13:03
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Neither libgbm1 nor libgbm-dev can be installed :-|.
Is the ci base image too old @wing328 ?

@bodograumann
bodograumannforce-pushed the ts-url-parse-import branch 2 times, most recently from 005d2a5 to b090cbfCompareApril 6, 2022 07:27
@bodograumann

Copy link
Copy Markdown
ContributorAuthor

Yay it works! 🚀

Please have another look at this PR now.

@macjohnnymacjohnny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@macjohnny
macjohnny merged commit 510f799 into OpenAPITools:masterApr 6, 2022
@macjohnnymacjohnny added this to the 6.0.0 milestone Apr 6, 2022
cachescrubber pushed a commit to cachescrubber/openapi-generator that referenced this pull request Apr 9, 2022
* Install correct typings for url-parse
* Use es modules compat mode when es6 output is selected
* Consolidate typescript sample generation naming scheme
* Regenerate samples
* Create new typescript sample to test esmodules in browser
* Expose RequiredError type
* Make browser integration tests pass locally
* Remove cookie tests, because we don’t allow cross-origin cookies
* Add output type to package definition
* Execute new browser tests in pipeline
* Install headless chromium dependencies in circle ci
Sign up for freeto 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.

2 participants

@bodograumann@macjohnny