Skip to content

Commit 8cf6b8f

Browse files
authored
refactor: rename google_news_template -> flutter_news_template (#555)
1 parent ee9fff5 commit 8cf6b8f

File tree

1,098 files changed

+91
-82
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,098 files changed

+91
-82
lines changed

.github/workflows/generate_google_news_template.yaml renamed to .github/workflows/generate_flutter_news_template.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: generate_google_news_template
1+
name: generate_flutter_news_template
22

33
on:
44
push:
@@ -35,8 +35,8 @@ jobs:
3535
with:
3636
base: main
3737
branch: chore/generate-google-news-template
38-
commit-message: "chore: generate google_news_template"
39-
title: "chore: generate google_news_template"
38+
commit-message: "chore: generate flutter_news_template"
39+
title: "chore: generate flutter_news_template"
4040
body: Please squash and merge me!
4141
labels: bot
4242
author: VGV Bot <[email protected]>

.github/workflows/verify_google_news_template.yaml renamed to .github/workflows/verify_flutter_news_template.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: verify_google_news_template
1+
name: verify_flutter_news_template
22

33
concurrency:
44
group: ${{ github.workflow }}-${{ github.ref }}
@@ -7,16 +7,16 @@ concurrency:
77
on:
88
pull_request:
99
paths:
10-
- "google_news_template/**"
11-
- ".github/workflows/verify_google_news_template.yaml"
10+
- "flutter_news_template/**"
11+
- ".github/workflows/verify_flutter_news_template.yaml"
1212
branches:
1313
- main
1414

1515
jobs:
1616
build:
1717
defaults:
1818
run:
19-
working-directory: google_news_template
19+
working-directory: flutter_news_template
2020

2121
runs-on: ubuntu-latest
2222

@@ -34,13 +34,13 @@ jobs:
3434
flutter pub global activate very_good_cli
3535
3636
- name: Install Brick
37-
run: mason add -g google_news_template --path .
37+
run: mason add -g flutter_news_template --path .
3838

3939
- name: Generate Project
40-
run: mason make google_news_template -c ./template.json -o tmp
40+
run: mason make flutter_news_template -c ./template.json -o tmp
4141

4242
- name: Install Dependencies
43-
run: very_good packages get -r tmp/google_news_template
43+
run: very_good packages get -r tmp/flutter_news_template
4444

4545
- name: Run Tests
46-
run: cd tmp/google_news_template && very_good test -x presubmit-only && cd -
46+
run: cd tmp/flutter_news_template && very_good test -x presubmit-only && cd -

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
.atom/
33
.idea/
44
.vscode/
5-
!google_news_**/.idea/
6-
!google_news_**/.vscode/
5+
!flutter_news_**/.idea/
6+
!flutter_news_**/.vscode/
77

88
# Files and directories created by pub
99
.dart_tool/

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To preview the [available features](#available-features) in this app, run the ex
1313

1414
## Flutter News Mason Template
1515

16-
[Flutter News Toolkit](https://github.com/flutter/news_template/blob/main/google_news_template/README.md) is a [mason](https://pub.dev/packages/mason) template generated from flutter_news_example.
16+
[Flutter News Toolkit](https://github.com/flutter/news_template/blob/main/flutter_news_template/README.md) is a [mason](https://pub.dev/packages/mason) template generated from flutter_news_example.
1717

1818
## Available Features
1919

@@ -48,7 +48,7 @@ Below is an example project roadmap that can be leveraged to implement this temp
4848
### Code Generation
4949

5050
- After completing your pre-project setup and configuration, [generate your codebase](#generating-your-codebase-with-mason) using [mason](https://pub.dev/packages/mason).
51-
- The [Flutter News Template](https://github.com/kaiceyd/news_template/blob/patch-1/google_news_template/README.md) supports the following decision points:
51+
- The [Flutter News Template](https://github.com/kaiceyd/news_template/blob/patch-1/flutter_news_template/README.md) supports the following decision points:
5252
- Application name (*e.g. News Template*)
5353
- Application package name (*e.g. news_template*)
5454
- Desired Flutter version
@@ -148,7 +148,7 @@ This project relies on [flutter_localizations](https://api.flutter.dev/flutter/f
148148
- If possible, add your full team as developers of the Twitter app.
149149
- After setting up your [Firebase project](#firebase), go to `Firebase -> Authentication -> Sign-in-method -> Add new provider -> Twitter` to set up Twitter authentication method. Fill in the app ID and secret from the created Twitter app and share these secrets with your developer team.
150150

151-
### [Firebase](https://github.com/flutter/news_template/blob/main/google_news_template/README.md#recommended-firebase-configuration):
151+
### [Firebase](https://github.com/flutter/news_template/blob/main/flutter_news_template/README.md#recommended-firebase-configuration):
152152

153153
- It is recommended to define at least two application environments: development and production. Each environment defines a different configuration of deep links, ads and authentication along with a different entry point to the application (e.g. `main_development.dart`).
154154

@@ -237,19 +237,19 @@ dart pub global activate mason_cli
237237
When using user/password authentication:
238238

239239
```sh
240-
mason add google_news_template -g --git-url https://github.com/flutter/news_template --git-path google_news_template
240+
mason add flutter_news_template -g --git-url https://github.com/flutter/news_template --git-path flutter_news_template
241241
```
242242

243243
When using ssh authentication:
244244

245245
```sh
246-
mason add google_news_template -g --git-url [email protected]:flutter/news_template.git --git-path google_news_template
246+
mason add flutter_news_template -g --git-url [email protected]:flutter/news_template.git --git-path flutter_news_template
247247
```
248248

249249
### Generate
250250

251251
```sh
252-
mason make google_news_template -c template.json
252+
mason make flutter_news_template -c template.json
253253
```
254254

255255
For additional usage information and information about how to create custom templates refer to the [mason documentation](https://github.com/felangel/mason).
@@ -291,7 +291,7 @@ This project relies on [flutter_localizations](https://api.flutter.dev/flutter/f
291291
3. Use the new string
292292

293293
```dart
294-
import 'package:google_news_template/l10n/l10n.dart';
294+
import 'package:flutter_news_template/l10n/l10n.dart';
295295
296296
@override
297297
Widget build(BuildContext context) {
@@ -1095,6 +1095,6 @@ statements.
10951095
Remove the `ads_consent_client` dependency from `flutter_news_example/pubspec.yaml`, as well as all `ads_consent_client` and all `ads` import statements:
10961096
```dart
10971097
import 'package:ads_consent_client/ads_consent_client.dart';
1098-
import 'package:google_news_template/ads/ads.dart';
1098+
import 'package:flutter_news_template/ads/ads.dart';
10991099
```
11001100

analysis_options.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
analyzer:
22
exclude:
3-
- google_news_template/*
3+
- flutter_news_template/*

codemagic.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ definitions:
88
tst_emails: &tst_emails
99
1010
# common_environment: &common_environment
11-
# FLUTTER_PROJECT_DIRECTORY: google_news_template
11+
# FLUTTER_PROJECT_DIRECTORY: flutter_news_example
1212
automatic_ios_signing: &automatic_ios_signing
1313
# Encrypt the **content** of the API key for AppStore Connect
1414
# - Log in to App Store Connect and navigate to Users and Access > Keys.
@@ -37,15 +37,15 @@ definitions:
3737
FCI_KEYSTORE: TODO
3838
FCI_KEYSTORE_PASSWORD: TODO
3939
FCI_KEY_PASSWORD: TODO
40-
FCI_KEY_ALIAS: google-news-template
40+
FCI_KEY_ALIAS: flutter-news-example
4141
# The Google Play service account key should be generated by the owner of Google Play account
4242
# See instruction https://docs.codemagic.io/knowledge-base/google-play-api/
4343
# Encrypt the **content** of the Service Account Key
4444
GPLAY_KEY: TODO
4545
workflows:
4646
development:
4747
name: development
48-
working_directory: google_news_template
48+
working_directory: flutter_news_example
4949
max_build_duration: 60
5050
environment:
5151
flutter: 3.3.4
@@ -83,15 +83,15 @@ workflows:
8383
name: Set up Android key.properties
8484
script: |
8585
echo $FCI_KEYSTORE | base64 --decode > $FCI_KEYSTORE_PATH
86-
cat >> "$FCI_BUILD_DIR/google_news_template/android/key.properties" <<EOF
86+
cat >> "$FCI_BUILD_DIR/flutter_news_example/android/key.properties" <<EOF
8787
storePassword=$FCI_KEYSTORE_PASSWORD
8888
keyPassword=$FCI_KEY_PASSWORD
8989
keyAlias=$FCI_KEY_ALIAS
9090
storeFile=$FCI_KEYSTORE_PATH
9191
EOF
9292
- &set_up_local_properties
9393
name: Set up Android local properties
94-
script: echo "flutter.sdk=$HOME/programs/flutter" > "$FCI_BUILD_DIR/google_news_template/android/local.properties"
94+
script: echo "flutter.sdk=$HOME/programs/flutter" > "$FCI_BUILD_DIR/flutter_news_example/android/local.properties"
9595
- &setup_keychain
9696
name: Setup keychain
9797
script: keychain initialize
@@ -141,7 +141,7 @@ workflows:
141141
track: internal
142142
production:
143143
name: production
144-
working_directory: google_news_template
144+
working_directory: flutter_news_example
145145
max_build_duration: 60
146146
environment:
147147
flutter: 3.3.4

flutter_news_example/.idea/runConfigurations/development.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

flutter_news_example/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Contributing to Flutter News Toolkit
1+
# Contributing to Flutter News Example
22

33
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
44

5-
The following is a set of guidelines for contributing to Flutter News Toolkit.
5+
The following is a set of guidelines for contributing to Flutter News Example.
66
These are mostly guidelines, not rules. Use your best judgment,
77
and feel free to propose changes to this document in a pull request.
88

flutter_news_example/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ $ flutter run --flavor production --target lib/main/main_production.dart
3030

3131
```
3232

33-
_\*Flutter News Toolkit works on iOS, Android._
33+
_\*Flutter News Example works on iOS, Android._
3434

3535
---
3636

@@ -219,7 +219,7 @@ Widget build(BuildContext context) {
219219

220220
---
221221

222-
## Flutter News Toolkit API
222+
## Flutter News Example API
223223

224224
This package uses `flutter_news_example_api` that was created for the purpose of this template application. To get more information on how to use and customize the API see the [API README.md file](https://github.com/flutter/news_template/tree/main/flutter_news_example/api)
225225

flutter_news_example/android/app/build.gradle

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@ android {
7575
development {
7676
dimension "default"
7777
applicationIdSuffix "dev"
78-
manifestPlaceholders = [appName: "Flutter News Toolkit [DEV]"]
78+
manifestPlaceholders = [appName: "Flutter News Example [DEV]"]
7979
}
8080
production {
8181
dimension "default"
8282
applicationIdSuffix ""
83-
manifestPlaceholders = [appName: "Flutter News Toolkit"]
83+
manifestPlaceholders = [appName: "Flutter News Example"]
8484
}
8585
}
8686

flutter_news_example/api/docs/api.apib

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
FORMAT: 1A
22
HOST: http://localhost:8080
33

4-
# Flutter News Toolkit API (v1.0.0)
4+
# Flutter News Example API (v1.0.0)
55

6-
Flutter News Toolkit API is an API which allows consumers to interact with sample news content.
6+
Flutter News Example API is an API which allows consumers to interact with sample news content.
77

88
# Root [/]
99

flutter_news_example/api/lib/api.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/// Flutter News Toolkit API Server-Side Library
1+
/// Flutter News Example API Server-Side Library
22
library api;
33

44
export 'src/data/in_memory_news_data_source.dart' show InMemoryNewsDataSource;

flutter_news_example/api/lib/client.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/// Flutter News Toolkit API Client-Side Library
1+
/// Flutter News Example API Client-Side Library
22
library client;
33

44
export 'package:news_blocks/news_blocks.dart'

flutter_news_example/api/lib/src/client/flutter_news_example_api_client.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class FlutterNewsExampleApiRequestFailure implements Exception {
3636
typedef TokenProvider = Future<String?> Function();
3737

3838
/// {@template flutter_news_example_api_client}
39-
/// A Dart API client for the Flutter News Toolkit API.
39+
/// A Dart API client for the Flutter News Example API.
4040
/// {@endtemplate}
4141
class FlutterNewsExampleApiClient {
4242
/// Create an instance of [FlutterNewsExampleApiClient] that integrates

flutter_news_example/api/packages/news_blocks/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
44
[![License: MIT][license_badge]][license_link]
55

6-
Reusable News Blocks for the Flutter News Toolkit Application
6+
Reusable News Blocks for the Flutter News Example Application
77

88
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
99
[license_link]: https://opensource.org/licenses/MIT

flutter_news_example/api/packages/news_blocks/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: news_blocks
2-
description: Reusable News Blocks for the Flutter News Toolkit Application
2+
description: Reusable News Blocks for the Flutter News Example Application
33
version: 1.0.0+1
44
publish_to: none
55

flutter_news_example/api/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: flutter_news_example_api
2-
description: A Flutter News Toolkit server app built with the dart_frog package.
2+
description: A Flutter News Example server app built with the dart_frog package.
33
version: 0.1.0+1
44
publish_to: none
55

flutter_news_example/ios/Runner.xcodeproj/project.pbxproj

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@
516516
FACEBOOK_APP_ID = "";
517517
FACEBOOK_CLIENT_TOKEN = "";
518518
FACEBOOK_DISPLAY_NAME = "";
519-
FLAVOR_APP_NAME = "Flutter News Toolkit";
519+
FLAVOR_APP_NAME = "Flutter News Example";
520520
FLAVOR_DEEP_LINK_DOMAIN = "";
521521
FRAMEWORK_SEARCH_PATHS = (
522522
"$(inherited)",
@@ -556,7 +556,7 @@
556556
FACEBOOK_APP_ID = "";
557557
FACEBOOK_CLIENT_TOKEN = "";
558558
FACEBOOK_DISPLAY_NAME = "";
559-
FLAVOR_APP_NAME = "Flutter News Toolkit";
559+
FLAVOR_APP_NAME = "Flutter News Example";
560560
FLAVOR_DEEP_LINK_DOMAIN = "";
561561
FRAMEWORK_SEARCH_PATHS = (
562562
"$(inherited)",
@@ -652,8 +652,8 @@
652652
"EXCLUDED_ARCHS[sdk=iphonesimulator*]" = "i386 arm64";
653653
FACEBOOK_APP_ID = 3068290313391198;
654654
FACEBOOK_CLIENT_TOKEN = 7a51baf0a329829a55e6ab8ced3da73a;
655-
FACEBOOK_DISPLAY_NAME = "Flutter News Toolkit";
656-
FLAVOR_APP_NAME = "Flutter News Toolkit [DEV]";
655+
FACEBOOK_DISPLAY_NAME = "Flutter News Example";
656+
FLAVOR_APP_NAME = "Flutter News Example [DEV]";
657657
FLAVOR_DEEP_LINK_DOMAIN = googlenewstemplatedev.page.link;
658658
FRAMEWORK_SEARCH_PATHS = (
659659
"$(inherited)",
@@ -692,8 +692,8 @@
692692
"EXCLUDED_ARCHS[sdk=iphonesimulator*]" = "i386 arm64";
693693
FACEBOOK_APP_ID = 3068290313391198;
694694
FACEBOOK_CLIENT_TOKEN = 7a51baf0a329829a55e6ab8ced3da73a;
695-
FACEBOOK_DISPLAY_NAME = "Flutter News Toolkit";
696-
FLAVOR_APP_NAME = "Flutter News Toolkit [DEV]";
695+
FACEBOOK_DISPLAY_NAME = "Flutter News Example";
696+
FLAVOR_APP_NAME = "Flutter News Example [DEV]";
697697
FLAVOR_DEEP_LINK_DOMAIN = googlenewstemplatedev.page.link;
698698
FRAMEWORK_SEARCH_PATHS = (
699699
"$(inherited)",

flutter_news_example/ios/Runner/Info.plist

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,6 @@
103103
<key>CADisableMinimumFrameDurationOnPhone</key>
104104
<true/>
105105
<key>PermissionGroupNotification</key>
106-
<string>Flutter News Toolkit requires access to notifications to send news notifications.</string>
106+
<string>Flutter News Example requires access to notifications to send news notifications.</string>
107107
</dict>
108108
</plist>

flutter_news_example/lib/l10n/arb/app_en.arb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"appName": "Flutter News Toolkit",
2+
"appName": "Flutter News Example",
33
"@appName": {
44
"description": "The name of this application",
55
"type": "text",
@@ -29,7 +29,7 @@
2929
"type": "text",
3030
"placeholders": {}
3131
},
32-
"loginWelcomeText": "Welcome to\nFlutter News Toolkit",
32+
"loginWelcomeText": "Welcome to\nFlutter News Example",
3333
"@loginWelcomeText": {
3434
"description": "Greeting shown on the login page.",
3535
"type": "text",

flutter_news_example/lib/main/main_development.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ void main() {
3838
);
3939

4040
final packageInfoClient = PackageInfoClient(
41-
appName: 'Flutter News Toolkit [DEV]',
41+
appName: 'Flutter News Example [DEV]',
4242
packageName: 'com.flutter.news.example.dev',
4343
packageVersion: packageVersion,
4444
);

flutter_news_example/lib/main/main_production.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ void main() {
3838
);
3939

4040
final packageInfoClient = PackageInfoClient(
41-
appName: 'Flutter News Toolkit',
41+
appName: 'Flutter News Example',
4242
packageName: 'com.flutter.news.example',
4343
packageVersion: packageVersion,
4444
);
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Flutter News Toolkit UI
1+
# Flutter News Example UI
22

33
A UI Toolkit for Flutter News

0 commit comments

Comments
 (0)