Skip to content

Convert camera and update doc generation - #2057

Merged
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts
Aug 2, 2022
Merged

Convert camera and update doc generation#2057
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts

Conversation

@naftalibeder

@naftalibedernaftalibeder commented Jul 19, 2022

Copy link
Copy Markdown
Collaborator

Description

This converts the camera to functional component written in Typescript, and updates doc generation to correctly read props in a component like this.

I tried to keep the changes as minimal as possible, although this means that the Atmosphere documentation is overwritten with a less useful version. This is because of the larger issue with the generator, where imported types do not get expanded, but local types in the component file do.

Checklist

  • I have tested this on a device/simulator for each compatible OS
  • I updated the documentation with running yarn generate in the root folder
  • I mentioned this change in CHANGELOG.md
  • I updated the typings files (index.d.ts)
  • I added/ updated a sample (/example)

Comment threadexample/src/examples/V10/TerrainSkyAtmosphere.tsx Outdated
Comment threaddocs/Atmosphere.md
Comment threadscripts/autogenHelpers/DocJSONBuilder.js Outdated
Comment on lines +267 to +269
content = content.replace(/memo\(forwardRef\((.+?)\)\)/, '$1');
content = content.replace(/useCallback\(([^,]+), [^)]+\)/g, '$1');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think those can now be removed with 6.0.0-alpha.3 of react-docgen

Comment threadpackage.json Outdated
"prettier": "2.6.2",
"react": "17.0.2",
"react-docgen": "^5.0.0-beta.1",
"react-docgen": "rnmapbox/react-docgen#rnmapbox",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
"react-docgen": "rnmapbox/react-docgen#rnmapbox",
"react-docgen": "6.0.0-alpha.3",

I think it now contains the fixes we need See 592

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

So if I integrate this, imported types (e.g. AtmosphereLayerStyleProps in Atmosphere.tsx) still don't expand in the documentation, and methods on the ref don't appear in component.methods anymore. Any idea how you want to handle this?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I just realized this is still open: reactjs/react-docgen#591. Would you want to rebase and we point to your fork? Or I would be happy to set up a patch.

Would really like to just get this merged 😭 🤣

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've updated the PR and also pushed the merged version to: https://github.com/rnmapbox/react-docgen/tree/basic-hook-support. But last time I was checking it did not generate methods, because our structure is different to what's supported, but worth a try.

Comment threadscripts/autogenHelpers/DocJSONBuilder.js
@mfazekas

Copy link
Copy Markdown
Contributor

@naftalibeder test are failing, otherwise it's looks good to go for me

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Everything should be good. I tried pointing to the fork of docgen you pointed out, but I wasn't able to get it building properly, so I thought we could push that off to another PR if that's ok.

Feel free to merge / let me know if I can!

@mfazekas
mfazekas merged commit a8a589d into rnmapbox:mainAug 2, 2022
@mfazekas

Copy link
Copy Markdown
Contributor

Thanks much, for the hard work and patience!

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Haha thanks for sticking with this to the end!

@naftalibeder
naftalibeder deleted the chore/camera-ts branch December 22, 2023 16:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@naftalibeder@mfazekas
, '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" + '
Convert camera and update doc generation by naftalibeder · Pull Request #2057 · rnmapbox/maps · GitHub
Skip to content

Convert camera and update doc generation - #2057

Merged
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts
Aug 2, 2022
Merged

Convert camera and update doc generation#2057
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts

Conversation

@naftalibeder

@naftalibedernaftalibeder commented Jul 19, 2022

Copy link
Copy Markdown
Collaborator

Description

This converts the camera to functional component written in Typescript, and updates doc generation to correctly read props in a component like this.

I tried to keep the changes as minimal as possible, although this means that the Atmosphere documentation is overwritten with a less useful version. This is because of the larger issue with the generator, where imported types do not get expanded, but local types in the component file do.

Checklist

  • I have tested this on a device/simulator for each compatible OS
  • I updated the documentation with running yarn generate in the root folder
  • I mentioned this change in CHANGELOG.md
  • I updated the typings files (index.d.ts)
  • I added/ updated a sample (/example)

Comment threadexample/src/examples/V10/TerrainSkyAtmosphere.tsx Outdated
Comment threaddocs/Atmosphere.md
Comment threadscripts/autogenHelpers/DocJSONBuilder.js Outdated
Comment on lines +267 to +269
content = content.replace(/memo\(forwardRef\((.+?)\)\)/, '$1');
content = content.replace(/useCallback\(([^,]+), [^)]+\)/g, '$1');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think those can now be removed with 6.0.0-alpha.3 of react-docgen

Comment threadpackage.json Outdated
"prettier": "2.6.2",
"react": "17.0.2",
"react-docgen": "^5.0.0-beta.1",
"react-docgen": "rnmapbox/react-docgen#rnmapbox",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
"react-docgen": "rnmapbox/react-docgen#rnmapbox",
"react-docgen": "6.0.0-alpha.3",

I think it now contains the fixes we need See 592

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

So if I integrate this, imported types (e.g. AtmosphereLayerStyleProps in Atmosphere.tsx) still don't expand in the documentation, and methods on the ref don't appear in component.methods anymore. Any idea how you want to handle this?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I just realized this is still open: reactjs/react-docgen#591. Would you want to rebase and we point to your fork? Or I would be happy to set up a patch.

Would really like to just get this merged 😭 🤣

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've updated the PR and also pushed the merged version to: https://github.com/rnmapbox/react-docgen/tree/basic-hook-support. But last time I was checking it did not generate methods, because our structure is different to what's supported, but worth a try.

Comment threadscripts/autogenHelpers/DocJSONBuilder.js
@mfazekas

Copy link
Copy Markdown
Contributor

@naftalibeder test are failing, otherwise it's looks good to go for me

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Everything should be good. I tried pointing to the fork of docgen you pointed out, but I wasn't able to get it building properly, so I thought we could push that off to another PR if that's ok.

Feel free to merge / let me know if I can!

@mfazekas
mfazekas merged commit a8a589d into rnmapbox:mainAug 2, 2022
@mfazekas

Copy link
Copy Markdown
Contributor

Thanks much, for the hard work and patience!

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Haha thanks for sticking with this to the end!

@naftalibeder
naftalibeder deleted the chore/camera-ts branch December 22, 2023 16:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@naftalibeder@mfazekas
, '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('^' + ".*" + ' Convert camera and update doc generation by naftalibeder · Pull Request #2057 · rnmapbox/maps · GitHub
Skip to content

Convert camera and update doc generation - #2057

Merged
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts
Aug 2, 2022
Merged

Convert camera and update doc generation#2057
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts

Conversation

@naftalibeder

@naftalibedernaftalibeder commented Jul 19, 2022

Copy link
Copy Markdown
Collaborator

Description

This converts the camera to functional component written in Typescript, and updates doc generation to correctly read props in a component like this.

I tried to keep the changes as minimal as possible, although this means that the Atmosphere documentation is overwritten with a less useful version. This is because of the larger issue with the generator, where imported types do not get expanded, but local types in the component file do.

Checklist

  • I have tested this on a device/simulator for each compatible OS
  • I updated the documentation with running yarn generate in the root folder
  • I mentioned this change in CHANGELOG.md
  • I updated the typings files (index.d.ts)
  • I added/ updated a sample (/example)

Comment threadexample/src/examples/V10/TerrainSkyAtmosphere.tsx Outdated
Comment threaddocs/Atmosphere.md
Comment threadscripts/autogenHelpers/DocJSONBuilder.js Outdated
Comment on lines +267 to +269
content = content.replace(/memo\(forwardRef\((.+?)\)\)/, '$1');
content = content.replace(/useCallback\(([^,]+), [^)]+\)/g, '$1');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think those can now be removed with 6.0.0-alpha.3 of react-docgen

Comment threadpackage.json Outdated
"prettier": "2.6.2",
"react": "17.0.2",
"react-docgen": "^5.0.0-beta.1",
"react-docgen": "rnmapbox/react-docgen#rnmapbox",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
"react-docgen": "rnmapbox/react-docgen#rnmapbox",
"react-docgen": "6.0.0-alpha.3",

I think it now contains the fixes we need See 592

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

So if I integrate this, imported types (e.g. AtmosphereLayerStyleProps in Atmosphere.tsx) still don't expand in the documentation, and methods on the ref don't appear in component.methods anymore. Any idea how you want to handle this?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I just realized this is still open: reactjs/react-docgen#591. Would you want to rebase and we point to your fork? Or I would be happy to set up a patch.

Would really like to just get this merged 😭 🤣

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've updated the PR and also pushed the merged version to: https://github.com/rnmapbox/react-docgen/tree/basic-hook-support. But last time I was checking it did not generate methods, because our structure is different to what's supported, but worth a try.

Comment threadscripts/autogenHelpers/DocJSONBuilder.js
@mfazekas

Copy link
Copy Markdown
Contributor

@naftalibeder test are failing, otherwise it's looks good to go for me

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Everything should be good. I tried pointing to the fork of docgen you pointed out, but I wasn't able to get it building properly, so I thought we could push that off to another PR if that's ok.

Feel free to merge / let me know if I can!

@mfazekas
mfazekas merged commit a8a589d into rnmapbox:mainAug 2, 2022
@mfazekas

Copy link
Copy Markdown
Contributor

Thanks much, for the hard work and patience!

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Haha thanks for sticking with this to the end!

@naftalibeder
naftalibeder deleted the chore/camera-ts branch December 22, 2023 16:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@naftalibeder@mfazekas
, '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('^' + ".*" + ' Convert camera and update doc generation by naftalibeder · Pull Request #2057 · rnmapbox/maps · GitHub
Skip to content

Convert camera and update doc generation - #2057

Merged
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts
Aug 2, 2022
Merged

Convert camera and update doc generation#2057
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts

Conversation

@naftalibeder

@naftalibedernaftalibeder commented Jul 19, 2022

Copy link
Copy Markdown
Collaborator

Description

This converts the camera to functional component written in Typescript, and updates doc generation to correctly read props in a component like this.

I tried to keep the changes as minimal as possible, although this means that the Atmosphere documentation is overwritten with a less useful version. This is because of the larger issue with the generator, where imported types do not get expanded, but local types in the component file do.

Checklist

  • I have tested this on a device/simulator for each compatible OS
  • I updated the documentation with running yarn generate in the root folder
  • I mentioned this change in CHANGELOG.md
  • I updated the typings files (index.d.ts)
  • I added/ updated a sample (/example)

Comment threadexample/src/examples/V10/TerrainSkyAtmosphere.tsx Outdated
Comment threaddocs/Atmosphere.md
Comment threadscripts/autogenHelpers/DocJSONBuilder.js Outdated
Comment on lines +267 to +269
content = content.replace(/memo\(forwardRef\((.+?)\)\)/, '$1');
content = content.replace(/useCallback\(([^,]+), [^)]+\)/g, '$1');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think those can now be removed with 6.0.0-alpha.3 of react-docgen

Comment threadpackage.json Outdated
"prettier": "2.6.2",
"react": "17.0.2",
"react-docgen": "^5.0.0-beta.1",
"react-docgen": "rnmapbox/react-docgen#rnmapbox",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
"react-docgen": "rnmapbox/react-docgen#rnmapbox",
"react-docgen": "6.0.0-alpha.3",

I think it now contains the fixes we need See 592

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

So if I integrate this, imported types (e.g. AtmosphereLayerStyleProps in Atmosphere.tsx) still don't expand in the documentation, and methods on the ref don't appear in component.methods anymore. Any idea how you want to handle this?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I just realized this is still open: reactjs/react-docgen#591. Would you want to rebase and we point to your fork? Or I would be happy to set up a patch.

Would really like to just get this merged 😭 🤣

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've updated the PR and also pushed the merged version to: https://github.com/rnmapbox/react-docgen/tree/basic-hook-support. But last time I was checking it did not generate methods, because our structure is different to what's supported, but worth a try.

Comment threadscripts/autogenHelpers/DocJSONBuilder.js
@mfazekas

Copy link
Copy Markdown
Contributor

@naftalibeder test are failing, otherwise it's looks good to go for me

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Everything should be good. I tried pointing to the fork of docgen you pointed out, but I wasn't able to get it building properly, so I thought we could push that off to another PR if that's ok.

Feel free to merge / let me know if I can!

@mfazekas
mfazekas merged commit a8a589d into rnmapbox:mainAug 2, 2022
@mfazekas

Copy link
Copy Markdown
Contributor

Thanks much, for the hard work and patience!

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Haha thanks for sticking with this to the end!

@naftalibeder
naftalibeder deleted the chore/camera-ts branch December 22, 2023 16:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@naftalibeder@mfazekas
, '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" + ' Convert camera and update doc generation by naftalibeder · Pull Request #2057 · rnmapbox/maps · GitHub
Skip to content

Convert camera and update doc generation - #2057

Merged
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts
Aug 2, 2022
Merged

Convert camera and update doc generation#2057
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts

Conversation

@naftalibeder

@naftalibedernaftalibeder commented Jul 19, 2022

Copy link
Copy Markdown
Collaborator

Description

This converts the camera to functional component written in Typescript, and updates doc generation to correctly read props in a component like this.

I tried to keep the changes as minimal as possible, although this means that the Atmosphere documentation is overwritten with a less useful version. This is because of the larger issue with the generator, where imported types do not get expanded, but local types in the component file do.

Checklist

  • I have tested this on a device/simulator for each compatible OS
  • I updated the documentation with running yarn generate in the root folder
  • I mentioned this change in CHANGELOG.md
  • I updated the typings files (index.d.ts)
  • I added/ updated a sample (/example)

Comment threadexample/src/examples/V10/TerrainSkyAtmosphere.tsx Outdated
Comment threaddocs/Atmosphere.md
Comment threadscripts/autogenHelpers/DocJSONBuilder.js Outdated
Comment on lines +267 to +269
content = content.replace(/memo\(forwardRef\((.+?)\)\)/, '$1');
content = content.replace(/useCallback\(([^,]+), [^)]+\)/g, '$1');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think those can now be removed with 6.0.0-alpha.3 of react-docgen

Comment threadpackage.json Outdated
"prettier": "2.6.2",
"react": "17.0.2",
"react-docgen": "^5.0.0-beta.1",
"react-docgen": "rnmapbox/react-docgen#rnmapbox",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
"react-docgen": "rnmapbox/react-docgen#rnmapbox",
"react-docgen": "6.0.0-alpha.3",

I think it now contains the fixes we need See 592

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

So if I integrate this, imported types (e.g. AtmosphereLayerStyleProps in Atmosphere.tsx) still don't expand in the documentation, and methods on the ref don't appear in component.methods anymore. Any idea how you want to handle this?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I just realized this is still open: reactjs/react-docgen#591. Would you want to rebase and we point to your fork? Or I would be happy to set up a patch.

Would really like to just get this merged 😭 🤣

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've updated the PR and also pushed the merged version to: https://github.com/rnmapbox/react-docgen/tree/basic-hook-support. But last time I was checking it did not generate methods, because our structure is different to what's supported, but worth a try.

Comment threadscripts/autogenHelpers/DocJSONBuilder.js
@mfazekas

Copy link
Copy Markdown
Contributor

@naftalibeder test are failing, otherwise it's looks good to go for me

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Everything should be good. I tried pointing to the fork of docgen you pointed out, but I wasn't able to get it building properly, so I thought we could push that off to another PR if that's ok.

Feel free to merge / let me know if I can!

@mfazekas
mfazekas merged commit a8a589d into rnmapbox:mainAug 2, 2022
@mfazekas

Copy link
Copy Markdown
Contributor

Thanks much, for the hard work and patience!

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Haha thanks for sticking with this to the end!

@naftalibeder
naftalibeder deleted the chore/camera-ts branch December 22, 2023 16:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@naftalibeder@mfazekas
, '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('^' + ".*" + ' Convert camera and update doc generation by naftalibeder · Pull Request #2057 · rnmapbox/maps · GitHub
Skip to content

Convert camera and update doc generation - #2057

Merged
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts
Aug 2, 2022
Merged

Convert camera and update doc generation#2057
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts

Conversation

@naftalibeder

@naftalibedernaftalibeder commented Jul 19, 2022

Copy link
Copy Markdown
Collaborator

Description

This converts the camera to functional component written in Typescript, and updates doc generation to correctly read props in a component like this.

I tried to keep the changes as minimal as possible, although this means that the Atmosphere documentation is overwritten with a less useful version. This is because of the larger issue with the generator, where imported types do not get expanded, but local types in the component file do.

Checklist

  • I have tested this on a device/simulator for each compatible OS
  • I updated the documentation with running yarn generate in the root folder
  • I mentioned this change in CHANGELOG.md
  • I updated the typings files (index.d.ts)
  • I added/ updated a sample (/example)

Comment threadexample/src/examples/V10/TerrainSkyAtmosphere.tsx Outdated
Comment threaddocs/Atmosphere.md
Comment threadscripts/autogenHelpers/DocJSONBuilder.js Outdated
Comment on lines +267 to +269
content = content.replace(/memo\(forwardRef\((.+?)\)\)/, '$1');
content = content.replace(/useCallback\(([^,]+), [^)]+\)/g, '$1');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think those can now be removed with 6.0.0-alpha.3 of react-docgen

Comment threadpackage.json Outdated
"prettier": "2.6.2",
"react": "17.0.2",
"react-docgen": "^5.0.0-beta.1",
"react-docgen": "rnmapbox/react-docgen#rnmapbox",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
"react-docgen": "rnmapbox/react-docgen#rnmapbox",
"react-docgen": "6.0.0-alpha.3",

I think it now contains the fixes we need See 592

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

So if I integrate this, imported types (e.g. AtmosphereLayerStyleProps in Atmosphere.tsx) still don't expand in the documentation, and methods on the ref don't appear in component.methods anymore. Any idea how you want to handle this?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I just realized this is still open: reactjs/react-docgen#591. Would you want to rebase and we point to your fork? Or I would be happy to set up a patch.

Would really like to just get this merged 😭 🤣

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've updated the PR and also pushed the merged version to: https://github.com/rnmapbox/react-docgen/tree/basic-hook-support. But last time I was checking it did not generate methods, because our structure is different to what's supported, but worth a try.

Comment threadscripts/autogenHelpers/DocJSONBuilder.js
@mfazekas

Copy link
Copy Markdown
Contributor

@naftalibeder test are failing, otherwise it's looks good to go for me

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Everything should be good. I tried pointing to the fork of docgen you pointed out, but I wasn't able to get it building properly, so I thought we could push that off to another PR if that's ok.

Feel free to merge / let me know if I can!

@mfazekas
mfazekas merged commit a8a589d into rnmapbox:mainAug 2, 2022
@mfazekas

Copy link
Copy Markdown
Contributor

Thanks much, for the hard work and patience!

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Haha thanks for sticking with this to the end!

@naftalibeder
naftalibeder deleted the chore/camera-ts branch December 22, 2023 16:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@naftalibeder@mfazekas
, '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); } })(); })(); Convert camera and update doc generation by naftalibeder · Pull Request #2057 · rnmapbox/maps · GitHub
Skip to content

Convert camera and update doc generation - #2057

Merged
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts
Aug 2, 2022
Merged

Convert camera and update doc generation#2057
mfazekas merged 18 commits into
rnmapbox:mainfrom
TruckMap:chore/camera-ts

Conversation

@naftalibeder

@naftalibedernaftalibeder commented Jul 19, 2022

Copy link
Copy Markdown
Collaborator

Description

This converts the camera to functional component written in Typescript, and updates doc generation to correctly read props in a component like this.

I tried to keep the changes as minimal as possible, although this means that the Atmosphere documentation is overwritten with a less useful version. This is because of the larger issue with the generator, where imported types do not get expanded, but local types in the component file do.

Checklist

  • I have tested this on a device/simulator for each compatible OS
  • I updated the documentation with running yarn generate in the root folder
  • I mentioned this change in CHANGELOG.md
  • I updated the typings files (index.d.ts)
  • I added/ updated a sample (/example)

Comment threadexample/src/examples/V10/TerrainSkyAtmosphere.tsx Outdated
Comment threaddocs/Atmosphere.md
Comment threadscripts/autogenHelpers/DocJSONBuilder.js Outdated
Comment on lines +267 to +269
content = content.replace(/memo\(forwardRef\((.+?)\)\)/, '$1');
content = content.replace(/useCallback\(([^,]+), [^)]+\)/g, '$1');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think those can now be removed with 6.0.0-alpha.3 of react-docgen

Comment threadpackage.json Outdated
"prettier": "2.6.2",
"react": "17.0.2",
"react-docgen": "^5.0.0-beta.1",
"react-docgen": "rnmapbox/react-docgen#rnmapbox",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
"react-docgen": "rnmapbox/react-docgen#rnmapbox",
"react-docgen": "6.0.0-alpha.3",

I think it now contains the fixes we need See 592

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

So if I integrate this, imported types (e.g. AtmosphereLayerStyleProps in Atmosphere.tsx) still don't expand in the documentation, and methods on the ref don't appear in component.methods anymore. Any idea how you want to handle this?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I just realized this is still open: reactjs/react-docgen#591. Would you want to rebase and we point to your fork? Or I would be happy to set up a patch.

Would really like to just get this merged 😭 🤣

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've updated the PR and also pushed the merged version to: https://github.com/rnmapbox/react-docgen/tree/basic-hook-support. But last time I was checking it did not generate methods, because our structure is different to what's supported, but worth a try.

Comment threadscripts/autogenHelpers/DocJSONBuilder.js
@mfazekas

Copy link
Copy Markdown
Contributor

@naftalibeder test are failing, otherwise it's looks good to go for me

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Everything should be good. I tried pointing to the fork of docgen you pointed out, but I wasn't able to get it building properly, so I thought we could push that off to another PR if that's ok.

Feel free to merge / let me know if I can!

@mfazekas
mfazekas merged commit a8a589d into rnmapbox:mainAug 2, 2022
@mfazekas

Copy link
Copy Markdown
Contributor

Thanks much, for the hard work and patience!

@naftalibeder

Copy link
Copy Markdown
CollaboratorAuthor

Haha thanks for sticking with this to the end!

@naftalibeder
naftalibeder deleted the chore/camera-ts branch December 22, 2023 16:22
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@naftalibeder@mfazekas