René's URL Explorer Experiment


Title: [Proposal] Plugin development workflow with NativeScript 4.0 · Issue #65 · NativeScript/nativescript-plugin-seed · GitHub

Open Graph Title: [Proposal] Plugin development workflow with NativeScript 4.0 · Issue #65 · NativeScript/nativescript-plugin-seed

X Title: [Proposal] Plugin development workflow with NativeScript 4.0 · Issue #65 · NativeScript/nativescript-plugin-seed

Description: [Proposal] Plugin development workflow with NativeScript 4.0 As most of you know, previously we considered having breaking changes for plugins with NativeScript 4.0. The good news now is that this won’t happen!* What it means? The CLI wi...

Open Graph Description: [Proposal] Plugin development workflow with NativeScript 4.0 As most of you know, previously we considered having breaking changes for plugins with NativeScript 4.0. The good news now is that this ...

X Description: [Proposal] Plugin development workflow with NativeScript 4.0 As most of you know, previously we considered having breaking changes for plugins with NativeScript 4.0. The good news now is that this ...

Opengraph URL: https://github.com/NativeScript/nativescript-plugin-seed/issues/65

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Proposal] Plugin development workflow with NativeScript 4.0","articleBody":"## [Proposal] Plugin development workflow with NativeScript 4.0\r\n\r\nAs most of you know, previously we considered having [breaking changes](https://github.com/NativeScript/android-runtime/issues/890) for plugins with NativeScript 4.0. The good news now is that this won’t happen!* What it means?\r\n\r\n1. The CLI will have logic to build the plugin `.aar` file. The `.aar` will be built and saved in plugin’s `platforms/android` folder with filename - the plugin name (the one specified in package.json with some restrictions applied regarding the `.aar` files name convention).\r\n\r\n2. The CLI will expose a command for building the `.aar` file in case you want to do this manually. This command will be used by the plugin authors to build the `.aar` file explicitly before publish. We highly recommend building your plugin `.aar` file and publish it with the package. Check FAQ for more information on the pros and cons of this approach.\r\n\r\n> NOTE: By using the plugin development workflow recommended in the plugin seed, there will be scripts and commands in place so that you shouldn’t care about the building of the `.aar` file. Also, by using `tns run android --syncAllFiles`, which is integrated in the seed workflow, any change you do to AndroidManifest.xml will result in rebuilding of the `.aar` file transparently for you.\r\n\r\n3. The files that can be added to `platforms/android` are restricted to:\r\nAndroidManifest.xml\r\nInclude.gradle\r\n*.aar\r\n*.jar\r\n*.md\r\nres folder\r\njniLibs\r\nassets\r\n\r\nPlugin's *.aar file will be built only when `AndroidManifext.xml`, `res` folder, `jniLibs` or `assets` are present in `platforms/android`. If the plugin's `platforms/android` folder contains only *.aar, *.jar - they will be consumed directly from the CLI. On the other hand `include.gradle` and `*.md` doesn't have anything to do with plugin's *aar so in this case also we won't create any *.aar file.\r\n\r\n>NOTE: In case any other native resources need to be used, the plugin author will need to create a native project and build the `.aar` file for the plugin explicitly. The CLI won’t handle any other files than the ones mentioned above. Practically this is something we also have today.\r\n\r\n>NOTE * For existing plugins containing resources in `platforms/android` folder that are not mentioned in the above list, there will be a breaking change. We are aware that this is about 1% of the existing plugins, so we will assist the plugin authors with the migration if needed.\r\n\r\n4. We recommend specifying package name in AndroidManifest.xml by following the conventions for the package name. At some point this will become a requirement.\r\n\r\n// Wrong\r\n\r\n\t\u003cmanifest xmlns:android=\"http://schemas.android.com/apk/res/android\">\r\n\r\n// Right\r\n\r\n\t\u003cmanifest xmlns:android=\"http://schemas.android.com/apk/res/android\" package=\"org.nativescript.nativescriptimagepicker\">\r\n\r\n5. The plugin’s `.aar` file should be part of the plugin package in npm. All other files in `platforms/android` except for `include.gradle`, `*.aar` and `*.jar` can be npm ignored.\r\n\r\n6.  For plugin authors who need to use a native Android project, we will create a detailed documentation article with the recommended approach for this. In short we will recommend to:\r\n  - Have a folder (i.e. `src-native`) in the root of the repo containing the native project\r\n  - Copy the `.aar` file produced by this project to `platforms/android` so that the CLI can use it.\r\n\r\n7. The development workflow provided in the NativeScript Plugin Seed will ensure that: \r\n   - The package published always include the `.aar` file.\r\n   - Using `npm run demo.android` from `src` folder watches for changes in `platforms\\android` and rebuilds the `.aar` file for you.\r\n\r\n## FAQ\r\n\r\n\r\n**Why should I bother building `.aar` file for my plugin when the CLI can handle this out of the box?**\r\nBelow you can find the Pros and Cons of both approaches:\r\nLeave the CLI to handle building of plugin’s `.aar` file. With this approach the cons are for the application developers.\r\n_Pros_\r\n* No need to deal with `.aar` files\r\n* No need to change my plugin development workflow\r\n\r\n_Cons (mainly for the app developers)_\r\n* If for some reason there is an error in the building of the `.aar` this will become visible in the customer’s app\r\n* Building an `.aar` file for a plugin takes about 4 sec on SSD when an app is built for the first time (and each the `platforms` folder is deleted) so it affects the development workflow of the app developers. This means that having 10 plugins will add >=40sec to the app initial build time.\r\n\r\nBuild my plugin `.aar` file explicitly and publish it in npm. With this approach the pros are for the application developers.\r\n_Pros_\r\n* Any errors that might occur during this build will be visible to the plugin author prior to publishing the plugin\r\n* No added time to application build time for applications using the plugin\r\n_Cons_\r\n* Plugin development workflow is insignificantly changed.\r\n\r\nSince building plugins aims for making the job of application developers easier, thus we recommend to plugin authors to build and publish their plugins’ `.aar` files.\r\n\r\n**I have an existing plugin, will I have to migrate it?**\r\nAll existing plugins will continue working as is, except for the aforementioned 1% of plugins, which we will handle with plugin authors directly. In spite of this, we highly recommend to:\r\n- Check if you’re using files different than the ones specified in point 3. If this is the case, probably you need to consider using a native project since the CLI won’t be able to handle the extra files there\r\n> NOTE: According to our research, 99% of the existing plugins use only the files listed in point 3 and using a native project won’t be required.\r\n- Add package name to AndroidManifest.xml as explained in point 4\r\n- Build the `.aar` file of your plugin using the provided CLI command as explained in point 2. This will be possible in 2 ways:\r\n  - Run the demo of your plugin to make the CLI build the `.aar` file in plugin’s `platforms/android` folder\r\n  - Call the CLI command for building the `.aar` file\r\n  - Publish a version of the plugin. Make sure that `include.gradle`, `*aar`, `*.jar` are NOT npm ignored and exist in the plugin package. All other contents of `platforms/android` can be ignored.\r\n\r\n**I have an existing plugin. I want to build the `.aar` file for it and publish a package containing the `.aar` file as recommended. How can I do it?**\r\n\r\nIt’s as easy as pie! See the previous question for the necessary steps.\r\n\r\n**I only have `AndroidManifest.xml`, what do I do?**\r\nAll existing plugins having only AndroidManifest.xml will continue working out of the box. In spite of this, we highly recommend:\r\n- Add package name to AndroidManifest.xml as explained in point 4\r\n- Build the `.aar` file of your plugin using the provided CLI command as explained in point 2.\r\n- Publish a version of the plugin containing the `.aar` file. Make sure that `include.gradle`, `*aar`, `*.jar` are NOT npm ignored and exist in the plugin package. All other contents of `platforms/android` can be ignored.\r\n\r\n**What files from `platforms/android` need to be part of the published package?**\r\n`include.gradle`, `*aar`, `*.jar` need to exist in the published package. All other files in `platforms/android` should be npm ignored.\r\n\r\n**Will I need to have Android Studio installed?**\r\nNo, the CLI will take care to build the `.aar` file of your plugin.\r\n\r\n**What about the iOS project?**\r\nNo changes there.\t","author":{"url":"https://github.com/radeva","@type":"Person","name":"radeva"},"datePublished":"2018-03-01T11:37:05Z","url":"https://github.com/NativeScript/nativescript-plugin-seed/issues/65"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:3e76f83e-2b30-89a4-fa01-10c92d151069
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idAD7C:E9D16:D19D35:1099D3F:6B013A12
html-safe-nonce5653fca93c6153fb976f56323aacfbdc0ffe0b1174ca657179518186f755c46b
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBRDdDOkU5RDE2OkQxOUQzNToxMDk5RDNGOjZCMDEzQTEyIiwidmlzaXRvcl9pZCI6IjE1ODgxMDQzMDQ1NTA1NTgyMjYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac21b52abdf4e51ee38fdf6feaa3ba228ce75a72640379d79baf1d0f057955c110
hovercard-subject-tagissue:301372880
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/NativeScript/nativescript-plugin-seed/65/issue_layout
twitter:imagehttps://opengraph.githubassets.com/c14d6ebdc2f88f1597ddf97a3db43030752fa280f9a38dca92eca1b5eff91660/NativeScript/nativescript-plugin-seed/issues/65
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/c14d6ebdc2f88f1597ddf97a3db43030752fa280f9a38dca92eca1b5eff91660/NativeScript/nativescript-plugin-seed/issues/65
og:image:alt[Proposal] Plugin development workflow with NativeScript 4.0 As most of you know, previously we considered having breaking changes for plugins with NativeScript 4.0. The good news now is that this ...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameradeva
hostnamegithub.com
expected-hostnamegithub.com
Nonecc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c
turbo-cache-controlno-preview
go-importgithub.com/NativeScript/nativescript-plugin-seed git https://github.com/NativeScript/nativescript-plugin-seed.git
octolytics-dimension-user_id7392261
octolytics-dimension-user_loginNativeScript
octolytics-dimension-repository_id93747831
octolytics-dimension-repository_nwoNativeScript/nativescript-plugin-seed
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forktrue
octolytics-dimension-repository_parent_id53071991
octolytics-dimension-repository_parent_nwoNathanWalker/nativescript-plugin-seed
octolytics-dimension-repository_network_root_id53071991
octolytics-dimension-repository_network_root_nwoNathanWalker/nativescript-plugin-seed
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release8c77c9e8439031ad54c75a250694842892f693e1
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/NativeScript/nativescript-plugin-seed/issues/65#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FNativeScript%2Fnativescript-plugin-seed%2Fissues%2F65
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FNativeScript%2Fnativescript-plugin-seed%2Fissues%2F65
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=NativeScript%2Fnativescript-plugin-seed
Reloadhttps://github.com/NativeScript/nativescript-plugin-seed/issues/65
Reloadhttps://github.com/NativeScript/nativescript-plugin-seed/issues/65
Reloadhttps://github.com/NativeScript/nativescript-plugin-seed/issues/65
NativeScripthttps://github.com/NativeScript
nativescript-plugin-seedhttps://github.com/NativeScript/nativescript-plugin-seed
Codehttps://github.com/NativeScript/nativescript-plugin-seed
Issues20 (20)https://github.com/NativeScript/nativescript-plugin-seed/issues
Pull requests2 (2)https://github.com/NativeScript/nativescript-plugin-seed/pulls
Actionshttps://github.com/NativeScript/nativescript-plugin-seed/actions
Projectshttps://github.com/NativeScript/nativescript-plugin-seed/projects
Security and qualityhttps://github.com/NativeScript/nativescript-plugin-seed/security
Insightshttps://github.com/NativeScript/nativescript-plugin-seed/insights
https://github.com/NativeScript/nativescript-plugin-seed
New issuehttps://github.com/login?return_to=https://github.com/NativeScript/nativescript-plugin-seed/issues/65
New issuehttps://github.com/login?return_to=https://github.com/NativeScript/nativescript-plugin-seed/issues/65
[Proposal] Plugin development workflow with NativeScript 4.0https://github.com/NativeScript/nativescript-plugin-seed/issues/65#top
proposalhttps://github.com/NativeScript/nativescript-plugin-seed/issues?q=state%3Aopen%20label%3A%22proposal%22
https://github.com/radeva
radevahttps://github.com/radeva
on Mar 1, 2018https://github.com/NativeScript/nativescript-plugin-seed/issues/65#issue-301372880
breaking changeshttps://github.com/NativeScript/android-runtime/issues/890
radevahttps://github.com/radeva
proposalhttps://github.com/NativeScript/nativescript-plugin-seed/issues?q=state%3Aopen%20label%3A%22proposal%22
on Mar 1, 2018https://github.com/NativeScript/nativescript-plugin-seed/issues/65#event-1498819316
https://github.com/nsplugins
nspluginshttps://github.com/nsplugins
on May 18, 2018https://github.com/NativeScript/nativescript-plugin-seed/issues/65#issuecomment-390193802
nspluginshttps://github.com/nsplugins
completedhttps://github.com/NativeScript/nativescript-plugin-seed/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on May 18, 2018https://github.com/NativeScript/nativescript-plugin-seed/issues/65#event-1634169620
Sign up for freehttps://github.com/signup?return_to=https://github.com/NativeScript/nativescript-plugin-seed/issues/65
Sign in to commenthttps://github.com/login?return_to=https://github.com/NativeScript/nativescript-plugin-seed/issues/65
proposalhttps://github.com/NativeScript/nativescript-plugin-seed/issues?q=state%3Aopen%20label%3A%22proposal%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.