Skip to content

Commit 310194c

Browse files
author
Chris Brody
authored
refactor: add comments to generated Android code (#137)
1 parent 48e52e0 commit 310194c

File tree

26 files changed

+192
-32
lines changed

26 files changed

+192
-32
lines changed

‎templates/android.js

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,9 @@ afterEvaluate { project ->
151151
`,
152152
}, {
153153
name: () => `${platform}/src/main/AndroidManifest.xml`,
154-
content: ({ packageIdentifier }) => `<manifest xmlns:android="http://schemas.android.com/apk/res/android"
154+
content: ({ packageIdentifier }) => `<!-- AndroidManifest.xml -->
155+
156+
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
155157
package="${packageIdentifier}">
156158
157159
</manifest>
@@ -163,7 +165,9 @@ afterEvaluate { project ->
163165
`${platform}/src/main/java/${packageIdentifier.split('.').join('/')}/${objectClassName}Module.java`,
164166
content: ({ objectClassName, packageIdentifier, view }) =>
165167
!view &&
166-
`package ${packageIdentifier};
168+
`// ${objectClassName}Module.java
169+
170+
package ${packageIdentifier};
167171
168172
import com.facebook.react.bridge.ReactApplicationContext;
169173
import com.facebook.react.bridge.ReactContextBaseJavaModule;
@@ -198,7 +202,9 @@ public class ${objectClassName}Module extends ReactContextBaseJavaModule {
198202
`${platform}/src/main/java/${packageIdentifier.split('.').join('/')}/${objectClassName}Manager.java`,
199203
content: ({ objectClassName, packageIdentifier, view }) =>
200204
view &&
201-
`package ${packageIdentifier};
205+
`// ${objectClassName}Manager.java
206+
207+
package ${packageIdentifier};
202208
203209
import android.view.View;
204210
@@ -232,7 +238,9 @@ public class ${objectClassName}Manager extends SimpleViewManager<View> {
232238
`${platform}/src/main/java/${packageIdentifier.split('.').join('/')}/${objectClassName}Package.java`,
233239
content: ({ objectClassName, packageIdentifier, view }) =>
234240
!view &&
235-
`package ${packageIdentifier};
241+
`// ${objectClassName}Package.java
242+
243+
package ${packageIdentifier};
236244
237245
import java.util.Arrays;
238246
import java.util.Collections;
@@ -262,7 +270,9 @@ public class ${objectClassName}Package implements ReactPackage {
262270
`${platform}/src/main/java/${packageIdentifier.split('.').join('/')}/${objectClassName}Package.java`,
263271
content: ({ objectClassName, packageIdentifier, view }) =>
264272
view &&
265-
`package ${packageIdentifier};
273+
`// ${objectClassName}Package.java
274+
275+
package ${packageIdentifier};
266276
267277
import java.util.Arrays;
268278
import java.util.Collections;

‎tests/integration/cli/create/view/__snapshots__/cli-create-with-view.test.js.snap

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -241,15 +241,19 @@ afterEvaluate { project ->
241241
},
242242
Object {
243243
"name": "react-native-integration-view-test-package/android/src/main/AndroidManifest.xml",
244-
"theContent": "<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
244+
"theContent": "<!-- AndroidManifest.xml -->
245+
246+
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
245247
package=\\"com.reactlibrary\\">
246248
247249
</manifest>
248250
",
249251
},
250252
Object {
251253
"name": "react-native-integration-view-test-package/android/src/main/java/com/reactlibrary/IntegrationViewTestPackageManager.java",
252-
"theContent": "package com.reactlibrary;
254+
"theContent": "// IntegrationViewTestPackageManager.java
255+
256+
package com.reactlibrary;
253257
254258
import android.view.View;
255259
@@ -279,7 +283,9 @@ public class IntegrationViewTestPackageManager extends SimpleViewManager<View> {
279283
},
280284
Object {
281285
"name": "react-native-integration-view-test-package/android/src/main/java/com/reactlibrary/IntegrationViewTestPackagePackage.java",
282-
"theContent": "package com.reactlibrary;
286+
"theContent": "// IntegrationViewTestPackagePackage.java
287+
288+
package com.reactlibrary;
283289
284290
import java.util.Arrays;
285291
import java.util.Collections;

‎tests/integration/cli/create/with-defaults/__snapshots__/cli-create-with-defaults.test.js.snap

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -241,15 +241,19 @@ afterEvaluate { project ->
241241
},
242242
Object {
243243
"name": "react-native-integration-test-package/android/src/main/AndroidManifest.xml",
244-
"theContent": "<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
244+
"theContent": "<!-- AndroidManifest.xml -->
245+
246+
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
245247
package=\\"com.reactlibrary\\">
246248
247249
</manifest>
248250
",
249251
},
250252
Object {
251253
"name": "react-native-integration-test-package/android/src/main/java/com/reactlibrary/IntegrationTestPackageModule.java",
252-
"theContent": "package com.reactlibrary;
254+
"theContent": "// IntegrationTestPackageModule.java
255+
256+
package com.reactlibrary;
253257
254258
import com.facebook.react.bridge.ReactApplicationContext;
255259
import com.facebook.react.bridge.ReactContextBaseJavaModule;
@@ -280,7 +284,9 @@ public class IntegrationTestPackageModule extends ReactContextBaseJavaModule {
280284
},
281285
Object {
282286
"name": "react-native-integration-test-package/android/src/main/java/com/reactlibrary/IntegrationTestPackagePackage.java",
283-
"theContent": "package com.reactlibrary;
287+
"theContent": "// IntegrationTestPackagePackage.java
288+
289+
package com.reactlibrary;
284290
285291
import java.util.Arrays;
286292
import java.util.Collections;

‎tests/with-injection/create/view/with-defaults/__snapshots__/create-view-with-defaults.test.js.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,8 @@ afterEvaluate { project ->
319319
"* outputFile name: react-native-alice-bobbi/android/src/main/AndroidManifest.xml
320320
content:
321321
--------
322+
<!-- AndroidManifest.xml -->
323+
322324
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
323325
package=\\"com.reactlibrary\\">
324326
@@ -329,6 +331,8 @@ content:
329331
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiManager.java
330332
content:
331333
--------
334+
// AliceBobbiManager.java
335+
332336
package com.reactlibrary;
333337
334338
import android.view.View;
@@ -361,6 +365,8 @@ public class AliceBobbiManager extends SimpleViewManager<View> {
361365
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiPackage.java
362366
content:
363367
--------
368+
// AliceBobbiPackage.java
369+
364370
package com.reactlibrary;
365371
366372
import java.util.Arrays;

‎tests/with-injection/create/view/with-example/with-defaults/__snapshots__/create-view-with-example-with-defaults.test.js.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,8 @@ afterEvaluate { project ->
323323
"* outputFile name: react-native-alice-bobbi/android/src/main/AndroidManifest.xml
324324
content:
325325
--------
326+
<!-- AndroidManifest.xml -->
327+
326328
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
327329
package=\\"com.reactlibrary\\">
328330
@@ -333,6 +335,8 @@ content:
333335
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiManager.java
334336
content:
335337
--------
338+
// AliceBobbiManager.java
339+
336340
package com.reactlibrary;
337341
338342
import android.view.View;
@@ -365,6 +369,8 @@ public class AliceBobbiManager extends SimpleViewManager<View> {
365369
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiPackage.java
366370
content:
367371
--------
372+
// AliceBobbiPackage.java
373+
368374
package com.reactlibrary;
369375
370376
import java.util.Arrays;

‎tests/with-injection/create/view/with-example/with-options/__snapshots__/create-view-with-example-with-options.test.js.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,8 @@ afterEvaluate { project ->
323323
"* outputFile name: react-native-alice-bobbi/android/src/main/AndroidManifest.xml
324324
content:
325325
--------
326+
<!-- AndroidManifest.xml -->
327+
326328
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
327329
package=\\"com.reactlibrary\\">
328330
@@ -333,6 +335,8 @@ content:
333335
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiManager.java
334336
content:
335337
--------
338+
// AliceBobbiManager.java
339+
336340
package com.reactlibrary;
337341
338342
import android.view.View;
@@ -365,6 +369,8 @@ public class AliceBobbiManager extends SimpleViewManager<View> {
365369
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiPackage.java
366370
content:
367371
--------
372+
// AliceBobbiPackage.java
373+
368374
package com.reactlibrary;
369375
370376
import java.util.Arrays;

‎tests/with-injection/create/view/with-options/for-android/__snapshots__/lib-view-android-config-options.test.js.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,8 @@ afterEvaluate { project ->
287287
"* outputFile name: react-native-alice-bobbi/android/src/main/AndroidManifest.xml
288288
content:
289289
--------
290+
<!-- AndroidManifest.xml -->
291+
290292
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
291293
package=\\"com.reactlibrary\\">
292294
@@ -297,6 +299,8 @@ content:
297299
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiManager.java
298300
content:
299301
--------
302+
// AliceBobbiManager.java
303+
300304
package com.reactlibrary;
301305
302306
import android.view.View;
@@ -329,6 +333,8 @@ public class AliceBobbiManager extends SimpleViewManager<View> {
329333
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiPackage.java
330334
content:
331335
--------
336+
// AliceBobbiPackage.java
337+
332338
package com.reactlibrary;
333339
334340
import java.util.Arrays;

‎tests/with-injection/create/with-defaults/__snapshots__/create-with-defaults.test.js.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,8 @@ afterEvaluate { project ->
319319
"* outputFile name: react-native-alice-bobbi/android/src/main/AndroidManifest.xml
320320
content:
321321
--------
322+
<!-- AndroidManifest.xml -->
323+
322324
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
323325
package=\\"com.reactlibrary\\">
324326
@@ -329,6 +331,8 @@ content:
329331
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiModule.java
330332
content:
331333
--------
334+
// AliceBobbiModule.java
335+
332336
package com.reactlibrary;
333337
334338
import com.facebook.react.bridge.ReactApplicationContext;
@@ -362,6 +366,8 @@ public class AliceBobbiModule extends ReactContextBaseJavaModule {
362366
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiPackage.java
363367
content:
364368
--------
369+
// AliceBobbiPackage.java
370+
365371
package com.reactlibrary;
366372
367373
import java.util.Arrays;

‎tests/with-injection/create/with-example/for-android-only/__snapshots__/create-with-example-for-android-only.test.js.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,8 @@ afterEvaluate { project ->
291291
"* outputFile name: react-native-alice-bobbi/android/src/main/AndroidManifest.xml
292292
content:
293293
--------
294+
<!-- AndroidManifest.xml -->
295+
294296
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
295297
package=\\"com.reactlibrary\\">
296298
@@ -301,6 +303,8 @@ content:
301303
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiModule.java
302304
content:
303305
--------
306+
// AliceBobbiModule.java
307+
304308
package com.reactlibrary;
305309
306310
import com.facebook.react.bridge.ReactApplicationContext;
@@ -334,6 +338,8 @@ public class AliceBobbiModule extends ReactContextBaseJavaModule {
334338
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiPackage.java
335339
content:
336340
--------
341+
// AliceBobbiPackage.java
342+
337343
package com.reactlibrary;
338344
339345
import java.util.Arrays;

‎tests/with-injection/create/with-example/with-defaults/__snapshots__/create-with-example-with-defaults.test.js.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,8 @@ afterEvaluate { project ->
323323
"* outputFile name: react-native-alice-bobbi/android/src/main/AndroidManifest.xml
324324
content:
325325
--------
326+
<!-- AndroidManifest.xml -->
327+
326328
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
327329
package=\\"com.reactlibrary\\">
328330
@@ -333,6 +335,8 @@ content:
333335
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiModule.java
334336
content:
335337
--------
338+
// AliceBobbiModule.java
339+
336340
package com.reactlibrary;
337341
338342
import com.facebook.react.bridge.ReactApplicationContext;
@@ -366,6 +370,8 @@ public class AliceBobbiModule extends ReactContextBaseJavaModule {
366370
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiPackage.java
367371
content:
368372
--------
373+
// AliceBobbiPackage.java
374+
369375
package com.reactlibrary;
370376
371377
import java.util.Arrays;

‎tests/with-injection/create/with-example/with-missing-package-scripts/__snapshots__/recover-from-missing-package-scripts.test.js.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,8 @@ afterEvaluate { project ->
323323
"* outputFile name: react-native-alice-bobbi/android/src/main/AndroidManifest.xml
324324
content:
325325
--------
326+
<!-- AndroidManifest.xml -->
327+
326328
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
327329
package=\\"com.reactlibrary\\">
328330
@@ -333,6 +335,8 @@ content:
333335
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiModule.java
334336
content:
335337
--------
338+
// AliceBobbiModule.java
339+
336340
package com.reactlibrary;
337341
338342
import com.facebook.react.bridge.ReactApplicationContext;
@@ -366,6 +370,8 @@ public class AliceBobbiModule extends ReactContextBaseJavaModule {
366370
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiPackage.java
367371
content:
368372
--------
373+
// AliceBobbiPackage.java
374+
369375
package com.reactlibrary;
370376
371377
import java.util.Arrays;

‎tests/with-injection/create/with-example/with-null-options/with-null-prefix/__snapshots__/create-with-example-with-null-prefix.test.js.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,8 @@ afterEvaluate { project ->
323323
"* outputFile name: react-native-alice-bobbi/android/src/main/AndroidManifest.xml
324324
content:
325325
--------
326+
<!-- AndroidManifest.xml -->
327+
326328
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
327329
package=\\"com.reactlibrary\\">
328330
@@ -333,6 +335,8 @@ content:
333335
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiModule.java
334336
content:
335337
--------
338+
// AliceBobbiModule.java
339+
336340
package com.reactlibrary;
337341
338342
import com.facebook.react.bridge.ReactApplicationContext;
@@ -366,6 +370,8 @@ public class AliceBobbiModule extends ReactContextBaseJavaModule {
366370
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/AliceBobbiPackage.java
367371
content:
368372
--------
373+
// AliceBobbiPackage.java
374+
369375
package com.reactlibrary;
370376
371377
import java.util.Arrays;

‎tests/with-injection/create/with-example/with-options/__snapshots__/create-with-example-with-options.test.js.snap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,8 @@ afterEvaluate { project ->
323323
"* outputFile name: react-native-alice-bobbi/android/src/main/AndroidManifest.xml
324324
content:
325325
--------
326+
<!-- AndroidManifest.xml -->
327+
326328
<manifest xmlns:android=\\"http://schemas.android.com/apk/res/android\\"
327329
package=\\"com.reactlibrary\\">
328330
@@ -333,6 +335,8 @@ content:
333335
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/SuperAwesomeModuleModule.java
334336
content:
335337
--------
338+
// SuperAwesomeModuleModule.java
339+
336340
package com.reactlibrary;
337341
338342
import com.facebook.react.bridge.ReactApplicationContext;
@@ -366,6 +370,8 @@ public class SuperAwesomeModuleModule extends ReactContextBaseJavaModule {
366370
"* outputFile name: react-native-alice-bobbi/android/src/main/java/com/reactlibrary/SuperAwesomeModulePackage.java
367371
content:
368372
--------
373+
// SuperAwesomeModulePackage.java
374+
369375
package com.reactlibrary;
370376
371377
import java.util.Arrays;

0 commit comments

Comments
 (0)