From 46a6cdbef8ce549cbd118d14f8dd016e01833d77 Mon Sep 17 00:00:00 2001 From: Andre Bandarra Date: Wed, 11 Mar 2020 13:54:28 +0000 Subject: [PATCH 1/3] Renames llama-pack => BubbleWrap --- README.md | 20 ++++-------- package.json | 2 +- packages/cli/README.md | 32 +++++++------------ .../cli/bin/{llama-pack.js => bubblewrap.js} | 0 packages/cli/package-lock.json | 2 +- packages/cli/package.json | 4 +-- packages/cli/src/lib/cmds/build.ts | 8 ++--- packages/cli/src/lib/cmds/help.ts | 10 +++--- packages/cli/src/lib/constants.ts | 2 +- packages/core/README.md | 20 ++++-------- packages/core/package-lock.json | 2 +- packages/core/package.json | 2 +- packages/core/src/lib/TwaGenerator.ts | 2 +- .../src/lib/androidSdk/AndroidSdkTools.ts | 2 +- packages/core/src/lib/jdk/JdkHelper.ts | 2 +- 15 files changed, 43 insertions(+), 67 deletions(-) rename packages/cli/bin/{llama-pack.js => bubblewrap.js} (100%) diff --git a/README.md b/README.md index 0e62f682..3876d2e6 100644 --- a/README.md +++ b/README.md @@ -14,24 +14,20 @@ See the License for the specific language governing permissions and limitations under the License. --> -# 🦙Llama Pack -![Node CI Status](https://github.com/GoogleChromeLabs/llama-pack/workflows/Node%20CI/badge.svg) +# Bubblewrap +![Node CI Status](https://github.com/GoogleChromeLabs/bubblewrap/workflows/Node%20CI/badge.svg) -Llama Pack is a set of tools and libraries designed to help developers to create, build and update +Bubblewrap is a set of tools and libraries designed to help developers to create, build and update projects for Android Applications that launch Progressive Web App (PWA) using [Trusted Web Activity (TWA)](https://developers.google.com/web/updates/2019/02/using-twa). -**Important:** llama-pack is still under active development. The tool hasn't been tested on a wide -range of Web APKs, and bootstraping a new project may fail in those cases. Please, file issues, -feature requests, and contribute with pull requests, if possible. - ## Requirements - [Node.js](https://nodejs.org/en/) 10.0 or above -## llama-pack Components +## Bubblewrap Components -- **[llama-pack-core](./packages/core):** a javascript library for generating, building and updating TWA projects. -- **[llama-pack-cli](./packages/cli):** a command-line version for llama-pack. +- **[bubblewrap/core](./packages/core):** a javascript library for generating, building and updating TWA projects. +- **[bubblewrap/cli](./packages/cli):** a command-line version of Bubblewrap. ## Contributing @@ -40,7 +36,3 @@ See [CONTRIBUTING](./CONTRIBUTING.md) for more. ## License See [LICENSE](./LICENSE) for more. - -## Disclaimer - -This is not a Google product. diff --git a/package.json b/package.json index 9becad4c..de6537b5 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ ], "repository": { "type": "git", - "url": "git+https://github.com/GoogleChromeLabs/llama-pack.git" + "url": "git+https://github.com/GoogleChromeLabs/bubblewrap.git" }, "author": "", "license": "Apache-2.0", diff --git a/packages/cli/README.md b/packages/cli/README.md index b92a03b6..585049c3 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -14,17 +14,13 @@ See the License for the specific language governing permissions and limitations under the License. --> -# 🦙Llama Pack CLI -![Node CI Status](https://github.com/GoogleChromeLabs/llama-pack/workflows/Node%20CI/badge.svg) +# Bubblewrap CLI +![Node CI Status](https://github.com/GoogleChromeLabs/bubblewrap/workflows/Node%20CI/badge.svg) -Llama Pack is a Command Line Interface (CLI) that helps developers to create +Bubblewrap is a Command Line Interface (CLI) that helps developers to create a Project for an Android application that launches an existing Progressive Web App (PWA) using a [Trusted Web Activity (TWA)](https://developers.google.com/web/updates/2019/02/using-twa). -**Important:** llama-pack is still under active development. The tool hasn't been tested on a wide -range of Web APKs, and bootstraping a new project may fail in those cases. Please, file issues, -feature requests, and contribute with pull requests, if possible. - ## Requirements - [Node.js](https://nodejs.org/en/) 10.0 or above @@ -32,7 +28,7 @@ feature requests, and contribute with pull requests, if possible. ### Get the Java Development Kit (JDK) 8. The Android Command line tools requires the correct version of the JDK to run. To prevent version -conflicts with a JDK version that is already installed, llama-pack uses a JDK that can unzipped in +conflicts with a JDK version that is already installed, Bubblewrap uses a JDK that can unzipped in a separate folder. Download a version of JDK 8 that is compatible with your OS from @@ -47,27 +43,27 @@ Download a version of Android command line tools that is compatible with your OS [https://developer.android.com/studio#command-tools](https://developer.android.com/studio#command-tools). Create a folder and extract the downloaded file into it. -### Tell llama-pack where the JDK and Android command line tools are -When running `llama-pack` for the first time, it will ask where it can find the JDK and Android command +### Tell Bubblewrap where the JDK and Android command line tools are +When running `bubblewrap` for the first time, it will ask where it can find the JDK and Android command line tools. So, take note of the location where both were decompressed. -## Using llama-pack +## Using Bubblewrap -### Installing llama-pack +### Installing Bubblewrap ```shell -npm i -g @llama-pack/cli +npm i -g @bubblewrap/cli ``` ### Initializing an Android Project Generate an Android project from an existing Web Manifest: ```shell -llama-pack init --manifest https://my-twa.com/manifest.json +bubblewrap init --manifest https://my-twa.com/manifest.json ``` -When initalizing a project, llama-pack will download the Web Manifest and ask you to confirm +When initalizing a project, Bubblewrap will download the Web Manifest and ask you to confirm the values that should be used when building the Android project. It will also ask you for the details needed to generate a signing key, used to sign the @@ -75,7 +71,7 @@ app before uploading to the Play Store. ### Building the Android Project ```shell -llama-pack build +bubblewrap build ``` When building the project for the first time, the Android Build Tools will need to be installed. @@ -95,7 +91,3 @@ See [CONTRIBUTING](../../CONTRIBUTING.md) for more. ## License See [LICENSE](../../LICENSE) for more. - -## Disclaimer - -This is not a Google product. diff --git a/packages/cli/bin/llama-pack.js b/packages/cli/bin/bubblewrap.js similarity index 100% rename from packages/cli/bin/llama-pack.js rename to packages/cli/bin/bubblewrap.js diff --git a/packages/cli/package-lock.json b/packages/cli/package-lock.json index 960673c8..6c4c1314 100644 --- a/packages/cli/package-lock.json +++ b/packages/cli/package-lock.json @@ -1,5 +1,5 @@ { - "name": "@llama-pack/cli", + "name": "@bubblewrap/cli", "version": "0.5.1", "lockfileVersion": 1, "requires": true, diff --git a/packages/cli/package.json b/packages/cli/package.json index 2f7bec12..dde0abb8 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -3,7 +3,7 @@ "version": "0.5.1", "description": "CLI tool to Generate TWA projects from a Web Manifest", "bin": { - "llama-pack": "bin/llama-pack.js" + "bubblewrap": "bin/bubblewrap.js" }, "scripts": { "build": "tsc", @@ -17,7 +17,7 @@ "keywords": [], "repository": { "type": "git", - "url": "git+https://github.com/GoogleChromeLabs/llama-pack.git" + "url": "git+https://github.com/GoogleChromeLabs/bubblewrap.git" }, "author": "", "license": "Apache-2.0", diff --git a/packages/cli/src/lib/cmds/build.ts b/packages/cli/src/lib/cmds/build.ts index 68490d1e..8bf21779 100644 --- a/packages/cli/src/lib/cmds/build.ts +++ b/packages/cli/src/lib/cmds/build.ts @@ -33,12 +33,12 @@ interface SigningKeyPasswords { */ async function getPasswords(log: Log): Promise { // Check if passwords are set as environment variables. - const envKeystorePass = process.env['LLAMA_PACK_KEYSTORE_PASSWORD']; - const envKeyPass = process.env['LLAMA_PACK_KEY_PASSWORD']; + const envKeystorePass = process.env['BUBBLEWRAP_KEYSTORE_PASSWORD']; + const envKeyPass = process.env['BUBBLEWRAP_KEY_PASSWORD']; if (envKeyPass !== undefined && envKeystorePass !== undefined) { - log.info('Using passwords set in the LLAMA_PACK_KEYSTORE_PASSWORD and ' + - 'LLAMA_PACK_KEY_PASSWORD environmental variables.'); + log.info('Using passwords set in the BUBBLEWRAP_KEYSTORE_PASSWORD and ' + + 'BUBBLEWRAP_KEY_PASSWORD environmental variables.'); return { keystorePassword: envKeystorePass, keyPassword: envKeyPass, diff --git a/packages/cli/src/lib/cmds/help.ts b/packages/cli/src/lib/cmds/help.ts index 30394369..b8b86eaf 100644 --- a/packages/cli/src/lib/cmds/help.ts +++ b/packages/cli/src/lib/cmds/help.ts @@ -20,19 +20,19 @@ import {ParsedArgs} from 'minimist'; const HELP_MESSAGES = new Map( [ ['main', [ - 'llama-pack [command] ', + 'bubblewrap [command] ', '', '', 'build ............... generates an Android APK from a TWA Project', 'help ................ shows this menu', 'init ................ initializes a new TWA Project', - 'update .............. updates an existing TWA Project with the latest llama-pack template', + 'update .............. updates an existing TWA Project with the latest bubblewrap template', ].join('\n')], ['init', [ 'Usage:', '', '', - 'lama-pack init --manifest=[web-manifest-url]', + 'bubblewrap init --manifest=[web-manifest-url]', '', '', 'Options:', @@ -43,13 +43,13 @@ const HELP_MESSAGES = new Map( 'Usage:', '', '', - 'llama-pack build', + 'bubblewrap build', ].join('\n')], ['update', [ 'Usage:', '', '', - 'llama-pack update', + 'bubblewrap update', '', '', 'Options:', diff --git a/packages/cli/src/lib/constants.ts b/packages/cli/src/lib/constants.ts index fc37d83e..64bdbd51 100644 --- a/packages/cli/src/lib/constants.ts +++ b/packages/cli/src/lib/constants.ts @@ -14,4 +14,4 @@ * limitations under the License. */ -export const APP_NAME = 'llama-pack-cli'; +export const APP_NAME = 'bubblewrap-cli'; diff --git a/packages/core/README.md b/packages/core/README.md index e820434f..9ad2255d 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -14,17 +14,13 @@ See the License for the specific language governing permissions and limitations under the License. --> -# 🦙Llama Pack Core -![Node CI Status](https://github.com/GoogleChromeLabs/llama-pack/workflows/Node%20CI/badge.svg) +# Bubblewrap Core +![Node CI Status](https://github.com/GoogleChromeLabs/bubblewrap/workflows/Node%20CI/badge.svg) -Llama Pack Core is a NodeJS library that helps developers to create a Project for an Android +Bubblewrap Core is a NodeJS library that helps developers to create a Project for an Android application that launches an existing Progressive Web App (PWA) using a [Trusted Web Activity (TWA)](https://developers.google.com/web/updates/2019/02/using-twa). -**Important:** llama-pack is still under active development. The tool hasn't been tested on a wide -range of Web APKs, and bootstraping a new project may fail in those cases. Please, file issues, -feature requests, and contribute with pull requests, if possible. - ## Requirements - [Node.js](https://nodejs.org/en/) 10.0 or above @@ -32,7 +28,7 @@ feature requests, and contribute with pull requests, if possible. ### Get the Java Development Kit (JDK) 8. The Android Command line tools requires the correct version of the JDK to run. To prevent version -conflicts with a JDK version that is already installed, llama-pack uses a JDK that can unzipped in +conflicts with a JDK version that is already installed, Bubblewrap uses a JDK that can unzipped in a separate folder. Download a version of JDK 8 that is compatible with your OS from @@ -47,10 +43,10 @@ Download a version of Android command line tools that is compatible with your OS [https://developer.android.com/studio#command-tools](https://developer.android.com/studio#command-tools). Create a folder and extract the downloaded file into it. -## Using llama-pack-core in a NodeJs project +## Using @bubblewrap/core in a NodeJs project ```shell -npm i -g @llama-pack/core +npm i -g @bubblewrap/core ``` ## Contributing @@ -60,7 +56,3 @@ See [CONTRIBUTING](../../CONTRIBUTING.md) for more. ## License See [LICENSE](../../LICENSE) for more. - -## Disclaimer - -This is not a Google product. diff --git a/packages/core/package-lock.json b/packages/core/package-lock.json index 792e2322..ab347624 100644 --- a/packages/core/package-lock.json +++ b/packages/core/package-lock.json @@ -1,5 +1,5 @@ { - "name": "@llama-pack/core", + "name": "@bubblewrap/core", "version": "0.5.1", "lockfileVersion": 1, "requires": true, diff --git a/packages/core/package.json b/packages/core/package.json index 4d07c756..a9ed9d8e 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -24,7 +24,7 @@ ], "repository": { "type": "git", - "url": "git+https://github.com/GoogleChromeLabs/llama-pack.git" + "url": "git+https://github.com/GoogleChromeLabs/bubblewrap.git" }, "author": "", "license": "Apache-2.0", diff --git a/packages/core/src/lib/TwaGenerator.ts b/packages/core/src/lib/TwaGenerator.ts index 9a6ff93d..ad012dc0 100644 --- a/packages/core/src/lib/TwaGenerator.ts +++ b/packages/core/src/lib/TwaGenerator.ts @@ -202,7 +202,7 @@ export class TwaGenerator { } // TODO(andreban): Support for image/svg being tracked in - // https://github.com/GoogleChromeLabs/llama-pack/issues/103 + // https://github.com/GoogleChromeLabs/bubblewrap/issues/103 if (contentType.startsWith('image/svg')) { throw new Error(`Received icon "${iconUrl}" with Content-Type "${contentType}",` + ' which is not currently supported'); diff --git a/packages/core/src/lib/androidSdk/AndroidSdkTools.ts b/packages/core/src/lib/androidSdk/AndroidSdkTools.ts index 533970b6..42b0e1f2 100644 --- a/packages/core/src/lib/androidSdk/AndroidSdkTools.ts +++ b/packages/core/src/lib/androidSdk/AndroidSdkTools.ts @@ -40,7 +40,7 @@ export class AndroidSdkTools { * Constructs a new instance of AndroidSdkTools. * * @param {NodeJS.Process} process information from the OS process - * @param {Config} config the llama-pack general configuration + * @param {Config} config the bubblewrap general configuration * @param {jdkHelper} jdkHelper the JDK information to be used by the Android SDK */ constructor(process: NodeJS.Process, config: Config, jdkHelper: JdkHelper) { diff --git a/packages/core/src/lib/jdk/JdkHelper.ts b/packages/core/src/lib/jdk/JdkHelper.ts index 3daf1c98..e999aae9 100644 --- a/packages/core/src/lib/jdk/JdkHelper.ts +++ b/packages/core/src/lib/jdk/JdkHelper.ts @@ -34,7 +34,7 @@ export class JdkHelper { * Constructs a new instance of JdkHelper. * * @param {NodeJS.Process} process information from the OS process - * @param {Config} config the llama-pack general configuration + * @param {Config} config the bubblewrap general configuration */ constructor(process: NodeJS.Process, config: Config) { this.process = process; From 982e4a59b500637d033c31aa06a2f29ececdd586 Mon Sep 17 00:00:00 2001 From: Andre Bandarra Date: Wed, 11 Mar 2020 14:00:51 +0000 Subject: [PATCH 2/3] Re-adds the Disclaimer --- README.md | 4 ++++ packages/cli/README.md | 4 ++++ packages/core/README.md | 5 +++++ 3 files changed, 13 insertions(+) diff --git a/README.md b/README.md index 3876d2e6..4b0a8c77 100644 --- a/README.md +++ b/README.md @@ -36,3 +36,7 @@ See [CONTRIBUTING](./CONTRIBUTING.md) for more. ## License See [LICENSE](./LICENSE) for more. + +## Disclaimer + +This is not a Google product. diff --git a/packages/cli/README.md b/packages/cli/README.md index 585049c3..6225a877 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -91,3 +91,7 @@ See [CONTRIBUTING](../../CONTRIBUTING.md) for more. ## License See [LICENSE](../../LICENSE) for more. + +## Disclaimer + +This is not a Google product. diff --git a/packages/core/README.md b/packages/core/README.md index 9ad2255d..00f3c297 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -56,3 +56,8 @@ See [CONTRIBUTING](../../CONTRIBUTING.md) for more. ## License See [LICENSE](../../LICENSE) for more. + +## Disclaimer + +This is not a Google product. + From da9ab58c7f4256e4adf5e2a9690ef83a42f4aab0 Mon Sep 17 00:00:00 2001 From: Andre Bandarra Date: Wed, 11 Mar 2020 14:16:56 +0000 Subject: [PATCH 3/3] Remove trailing spaces --- README.md | 2 +- packages/cli/README.md | 2 +- packages/core/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4b0a8c77..3a2a2502 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,6 @@ See [CONTRIBUTING](./CONTRIBUTING.md) for more. See [LICENSE](./LICENSE) for more. -## Disclaimer +## Disclaimer This is not a Google product. diff --git a/packages/cli/README.md b/packages/cli/README.md index 6225a877..80c149cd 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -92,6 +92,6 @@ See [CONTRIBUTING](../../CONTRIBUTING.md) for more. See [LICENSE](../../LICENSE) for more. -## Disclaimer +## Disclaimer This is not a Google product. diff --git a/packages/core/README.md b/packages/core/README.md index 00f3c297..2522cba7 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -57,7 +57,7 @@ See [CONTRIBUTING](../../CONTRIBUTING.md) for more. See [LICENSE](../../LICENSE) for more. -## Disclaimer +## Disclaimer This is not a Google product.