feat: migrate from cap 7 to cap 8 #28
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| # Migrate Capacitor Plugin | ||
|
|
||
| Migrate a Capacitor 7 plugin to Capacitor 8. | ||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
| npx @capacitor/plugin-migration-v7-to-v8@latest | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,40 +14,40 @@ import { rimraf } from 'rimraf'; | |
| import { logger } from './log'; | ||
| import { runCommand } from './subprocess'; | ||
|
|
||
| const coreVersion = '8.0.0-beta.0'; | ||
| const gradleVersion = '8.14.3'; | ||
| const AGPVersion = '8.13.0'; | ||
| const gmsVersion = '4.4.4'; | ||
| const kotlinVersion = '2.2.20'; | ||
| const docgenVersion = '^0.3.0'; | ||
| const eslintVersion = '^8.57.1'; | ||
| const ionicEslintVersion = '^0.4.0'; | ||
| const ionicPrettierVersion = '^4.0.0'; | ||
| const ionicSwiftlintVersion = '^2.0.0'; | ||
| const prettierJavaVersion = '^2.7.7'; | ||
| const prettierVersion = '^3.6.2'; | ||
| const rimrafVersion = '^6.1.0'; | ||
| const rollupVersion = '^4.53.2'; | ||
| let updatePrettierJava = true; | ||
ItsChaceD marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| const variables = { | ||
| minSdkVersion: 24, | ||
| compileSdkVersion: 36, | ||
| targetSdkVersion: 36, | ||
| androidxActivityVersion: '1.11.0', | ||
| androidxAppCompatVersion: '1.7.1', | ||
| androidxCoordinatorLayoutVersion: '1.3.0', | ||
| androidxCoreVersion: '1.17.0', | ||
| androidxFragmentVersion: '1.8.9', | ||
| firebaseMessagingVersion: '25.0.1', | ||
| playServicesLocationVersion: '21.3.0', | ||
| androidxBrowserVersion: '1.9.0', | ||
| androidxMaterialVersion: '1.13.0', | ||
| androidxExifInterfaceVersion: '1.4.1', | ||
| coreSplashScreenVersion: '1.2.0', | ||
| androidxWebkitVersion: '1.14.0', | ||
| junitVersion: '4.13.2', | ||
| androidxJunitVersion: '1.3.0', | ||
| androidxEspressoCoreVersion: '3.7.0', | ||
| }; | ||
|
|
||
| process.on('unhandledRejection', (error) => { | ||
|
|
@@ -105,8 +105,8 @@ export const run = async (): Promise<void> => { | |
| pluginJSON.devDependencies['@capacitor/docgen'] = docgenVersion; | ||
| } | ||
|
|
||
| if (pluginJSON.version?.startsWith('7.')) { | ||
| pluginJSON.version = '8.0.0'; | ||
| } | ||
|
|
||
| await writeJSON(packageJson, pluginJSON, { spaces: 2 }); | ||
|
|
@@ -196,10 +196,10 @@ export const run = async (): Promise<void> => { | |
| join(iosDir, 'Plugin.xcodeproj', 'project.pbxproj'), | ||
| 'IPHONEOS_DEPLOYMENT_TARGET = ', | ||
| ';', | ||
| '15.0', | ||
| ); | ||
| await updateFile(join(iosDir, 'Podfile'), `platform :ios, '`, `'`, '15.0'); | ||
| await updateFile(join(dir, 'Package.swift'), '[.iOS(.v', ')],', '15'); | ||
| await updateFile( | ||
| join(dir, 'Package.swift'), | ||
| '.package(url: "https://github.com/ionic-team/capacitor-swift-pm.git",', | ||
|
|
@@ -210,7 +210,11 @@ export const run = async (): Promise<void> => { | |
| } | ||
| } | ||
|
|
||
| logger.info('Plugin migrated to Capacitor 8!'); | ||
|
|
||
| logger.info(''); | ||
| logger.info('⚠️ Note: Prettier has been updated from v2 to v3.'); | ||
ItsChaceD marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| logger.info('We recommend running your formatting and linting scripts to ensure your codebase is formatted correctly.'); | ||
| }; | ||
|
|
||
| function updatePodspec(dir: string, pluginJSON: any) { | ||
|
|
@@ -220,7 +224,7 @@ function updatePodspec(dir: string, pluginJSON: any) { | |
| return false; | ||
| } | ||
| txt = txt.replace('s.ios.deployment_target =', 's.ios.deployment_target ='); | ||
| txt = txt.replace(`s.ios.deployment_target = '14.0'`, `s.ios.deployment_target = '15.0'`); | ||
| writeFileSync(podspecFile, txt, { encoding: 'utf-8' }); | ||
| } | ||
|
|
||
|
|
@@ -280,12 +284,12 @@ async function updateBuildGradle( | |
| } | ||
| } | ||
| } | ||
|
|
||
| const kotlinRegex = /ext\.kotlin_version\s*=\s*(?:project\.hasProperty\("kotlin_version"\)\s*\?\s*rootProject\.ext\.kotlin_version\s*:\s*)?['"]([^'"]+)['"]/; | ||
| gradleFile = gradleFile.replace(kotlinRegex, () => { | ||
| logger.info(`Set kotlin_version = ${kotlinVersion}.`); | ||
| return `ext.kotlin_version = project.hasProperty("kotlin_version") ? rootProject.ext.kotlin_version : '${kotlinVersion}'`; | ||
| }); | ||
|
|
||
| gradleFile = setAllStringIn( | ||
| gradleFile, | ||
|
|
@@ -294,9 +298,101 @@ async function updateBuildGradle( | |
| `:$kotlin_version`, | ||
| ); | ||
|
|
||
| gradleFile = updateDeprecatedPropertySyntax(gradleFile); | ||
| gradleFile = updateKotlinOptions(gradleFile); | ||
|
|
||
| writeFileSync(filename, gradleFile, 'utf-8'); | ||
| } | ||
|
|
||
| function updateDeprecatedPropertySyntax(gradleFile: string): string { | ||
| const propertiesToUpdate = [ | ||
OS-ruimoreiramendes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 'namespace', | ||
| 'compileSdk', | ||
| 'testInstrumentationRunner', | ||
| 'versionName', | ||
| 'versionCode', | ||
| 'url', | ||
| 'abortOnError', | ||
| 'warningsAsErrors', | ||
| 'lintConfig', | ||
| 'minifyEnabled', | ||
| 'debugSymbolLevel', | ||
| 'path', | ||
| 'version', | ||
| 'baseline', | ||
| 'sourceCompatibility', | ||
| 'targetCompatibility', | ||
| ]; | ||
|
|
||
| let result = gradleFile; | ||
|
|
||
| for (const prop of propertiesToUpdate) { | ||
| const regex = new RegExp(`\\b(${prop})[ \\t]+([^=\\t{:])`, 'g'); | ||
| result = result.replace(regex, '$1 = $2'); | ||
| } | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| function updateKotlinOptions(gradleFile: string): string { | ||
| const kotlinOptionsRegex = /kotlinOptions\s*\{\s*jvmTarget\s*=\s*['"](\d+\.?\d*)['"][\s\S]*?\}/; | ||
| const match = kotlinOptionsRegex.exec(gradleFile); | ||
|
|
||
| if (!match) { | ||
| return gradleFile; | ||
| } | ||
|
|
||
| const jvmTargetValue = match[1]; | ||
| const enumValue = `JVM_${jvmTargetValue.replace('.', '_')}`; | ||
|
|
||
| let result = gradleFile; | ||
|
|
||
| if (!result.includes('import org.jetbrains.kotlin.gradle.dsl.JvmTarget')) { | ||
| const firstNonCommentLine = result.split('\n').findIndex((line) => { | ||
| if (!line) return false; | ||
| const trimmed = line.trim(); | ||
| return trimmed.length > 0 && !trimmed.startsWith('//') && !trimmed.startsWith('/*'); | ||
| }); | ||
| const lines = result.split('\n'); | ||
| if (firstNonCommentLine >= 0) { | ||
| lines.splice(firstNonCommentLine, 0, 'import org.jetbrains.kotlin.gradle.dsl.JvmTarget'); | ||
ItsChaceD marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| result = lines.join('\n'); | ||
| } | ||
| } | ||
|
|
||
| result = result.replace(kotlinOptionsRegex, ''); | ||
| result = result.replace(/\n\s*\n\s*\n/g, '\n\n'); | ||
|
|
||
| const kotlinBlockRegex = /\nkotlin\s*\{([^}]*(?:\{[^}]*\}[^}]*)*)\}/; | ||
| const kotlinBlockMatch = kotlinBlockRegex.exec(result); | ||
|
|
||
| const compilerOptionsBlock = ` compilerOptions {\n jvmTarget = JvmTarget.${enumValue}\n }`; | ||
|
|
||
| if (kotlinBlockMatch) { | ||
| // Kotlin block exists, add compilerOptions to it if not already present | ||
| if (!kotlinBlockMatch[0].includes('compilerOptions')) { | ||
| const kotlinBlockContent = kotlinBlockMatch[1]; | ||
| const existingContent = kotlinBlockContent.trimEnd(); | ||
| const newKotlinBlock = `\nkotlin {${existingContent}\n${compilerOptionsBlock}\n}`; | ||
| result = result.replace(kotlinBlockRegex, newKotlinBlock); | ||
| } | ||
| } else { | ||
| // No kotlin block exists, create one after the android block | ||
| const androidBlockRegex = /android\s*\{[\s\S]*?\n\}/; | ||
| const androidMatch = androidBlockRegex.exec(result); | ||
|
|
||
| if (androidMatch) { | ||
| const insertPosition = androidMatch.index + androidMatch[0].length; | ||
| const kotlinBlock = `\n\nkotlin {\n${compilerOptionsBlock}\n}`; | ||
| result = result.slice(0, insertPosition) + kotlinBlock + result.slice(insertPosition); | ||
| } | ||
| } | ||
|
|
||
| logger.info('Updated kotlinOptions to compilerOptions for Kotlin 2.2.0'); | ||
OS-ruimoreiramendes marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| return result; | ||
| } | ||
|
|
||
| function readFile(filename: string): string | undefined { | ||
| try { | ||
| if (!existsSync(filename)) { | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.