Fix pubignore instructions and update extension example app (#6472)

flutter · Sep 26, 2023 · 0234cb6 · 0234cb6
1 parent c900e0d
commit 0234cb6
Show file tree

Hide file tree

Showing 20 changed files with 25,911 additions and 25,809 deletions.
diff --git a/packages/devtools_extensions/CHANGELOG.md b/packages/devtools_extensions/CHANGELOG.md
@@ -1,7 +1,8 @@
 ## 0.0.7
-* Add integration testing.
+* Update the `build_and_copy` command to stop copying unnecessary files.
 * Add `ExtensionManager.unregisterEventHandler` method.
 * Update README.md to include `.pubignore` recommendation.
+* Add integration testing.
 
 ## 0.0.6
 * Bump `package:devtools_app_shared` dependency to version ^0.0.4.

diff --git a/packages/devtools_extensions/README.md b/packages/devtools_extensions/README.md
@@ -217,11 +217,11 @@ Then publish your package.
 As a package author, the content that you check into your git repository is completely up to you.
 If you want the contents of `extension/devtools/build/` to be git ignored, then you'll just need
 to ensure that the extension web app is always built and included in `extension/devtools/build/`
-when you publish your package. To do so, add the following to a `.pubignore` file at the root
-of your pub package:
+when you publish your package. To do so, add the following to a `.pubignore` file in the
+`extension/devtools/` directory:
 
 ```
-!./extension/devtools/build
+!./build
 ```
 
 This will ensure that, even if the `extension/devtools/build` directory has been been git

diff --git a/packages/devtools_extensions/bin/_build_and_copy.dart b/packages/devtools_extensions/bin/_build_and_copy.dart
@@ -93,12 +93,6 @@ class BuildExtensionCommand extends Command {
     required String source,
     required String dest,
   }) async {
-    _log('Copying the extension config.yaml file into a temp directory...');
-    final tmp = Directory.current.createTempSync();
-    final tmpConfigPath = path.join(tmp.path, 'config.yaml');
-    final destinationConfigPath = path.join(dest, 'config.yaml');
-    File(destinationConfigPath)..copySync(tmpConfigPath);
-
     _log('Replacing the existing extension build with the new one...');
     final sourceBuildPath = path.join(source, 'build', 'web');
     final destinationBuildPath = path.join(dest, 'build');
@@ -109,13 +103,6 @@ class BuildExtensionCommand extends Command {
       destinationBuildPath,
     );
 
-    _log(
-      'Copying the extension config.yaml file back to the destination '
-      'directory...',
-    );
-    File(tmpConfigPath)..copySync(destinationConfigPath);
-    tmp.deleteSync(recursive: true);
-
     _log(
       'Successfully copied extension assets from '
       '"${Directory(source).resolveSymbolicLinksSync()}" to'

diff --git a/packages/devtools_extensions/example/README.md b/packages/devtools_extensions/example/README.md
@@ -15,14 +15,14 @@ This example will show you how to:
 1. Structure your package for optimal extension development and publishing
     ```
     foo/  # formerly the repository root of your pub package
-    packages/
-        foo/  # your pub package
-        extension/
-            devtools/
-            build/
-                ...  # pre-compiled output of foo_devtools_extension
-            config.yaml
-        foo_devtools_extension/  # source code for your extension
+        packages/
+            foo/  # your pub package
+            extension/
+                devtools/
+                build/
+                    ...  # pre-compiled output of foo_devtools_extension
+                config.yaml
+            foo_devtools_extension/  # source code for your extension
     ```
 2. Configure your extension using the `foo/extension/devtools/config.yaml` file
     ```yaml

diff --git a/packages/devtools_extensions/example/foo/packages/foo/.pubignore b/packages/devtools_extensions/example/foo/packages/foo/.pubignore
diff --git a/packages/devtools_extensions/example/foo/packages/foo/extension/devtools/.pubignore b/packages/devtools_extensions/example/foo/packages/foo/extension/devtools/.pubignore
@@ -0,0 +1 @@
+!./build
diff --git a/...ages/devtools_extensions/example/foo/packages/foo/extension/devtools/build/.last_build_id b/...ages/devtools_extensions/example/foo/packages/foo/extension/devtools/build/.last_build_id
@@ -1 +1 @@
-7b12972f573eae484947343ce555e94c
+8c60270877067c249075063f1ce2ad13
diff --git a/...xtensions/example/foo/packages/foo/extension/devtools/build/assets/AssetManifest.bin.json b/...xtensions/example/foo/packages/foo/extension/devtools/build/assets/AssetManifest.bin.json
@@ -0,0 +1 @@
+"DQsHOnBhY2thZ2VzL2RldnRvb2xzX2FwcF9zaGFyZWQvZm9udHMvUm9ib3RvL1JvYm90by1CbGFjay50dGYMAQ0BBwVhc3NldAc6cGFja2FnZXMvZGV2dG9vbHNfYXBwX3NoYXJlZC9mb250cy9Sb2JvdG8vUm9ib3RvLUJsYWNrLnR0Zgc5cGFja2FnZXMvZGV2dG9vbHNfYXBwX3NoYXJlZC9mb250cy9Sb2JvdG8vUm9ib3RvLUJvbGQudHRmDAENAQcFYXNzZXQHOXBhY2thZ2VzL2RldnRvb2xzX2FwcF9zaGFyZWQvZm9udHMvUm9ib3RvL1JvYm90by1Cb2xkLnR0Zgc6cGFja2FnZXMvZGV2dG9vbHNfYXBwX3NoYXJlZC9mb250cy9Sb2JvdG8vUm9ib3RvLUxpZ2h0LnR0ZgwBDQEHBWFzc2V0BzpwYWNrYWdlcy9kZXZ0b29sc19hcHBfc2hhcmVkL2ZvbnRzL1JvYm90by9Sb2JvdG8tTGlnaHQudHRmBztwYWNrYWdlcy9kZXZ0b29sc19hcHBfc2hhcmVkL2ZvbnRzL1JvYm90by9Sb2JvdG8tTWVkaXVtLnR0ZgwBDQEHBWFzc2V0BztwYWNrYWdlcy9kZXZ0b29sc19hcHBfc2hhcmVkL2ZvbnRzL1JvYm90by9Sb2JvdG8tTWVkaXVtLnR0Zgc8cGFja2FnZXMvZGV2dG9vbHNfYXBwX3NoYXJlZC9mb250cy9Sb2JvdG8vUm9ib3RvLVJlZ3VsYXIudHRmDAENAQcFYXNzZXQHPHBhY2thZ2VzL2RldnRvb2xzX2FwcF9zaGFyZWQvZm9udHMvUm9ib3RvL1JvYm90by1SZWd1bGFyLnR0Zgc5cGFja2FnZXMvZGV2dG9vbHNfYXBwX3NoYXJlZC9mb250cy9Sb2JvdG8vUm9ib3RvLVRoaW4udHRmDAENAQcFYXNzZXQHOXBhY2thZ2VzL2RldnRvb2xzX2FwcF9zaGFyZWQvZm9udHMvUm9ib3RvL1JvYm90by1UaGluLnR0ZgdCcGFja2FnZXMvZGV2dG9vbHNfYXBwX3NoYXJlZC9mb250cy9Sb2JvdG9fTW9uby9Sb2JvdG9Nb25vLUJvbGQudHRmDAENAQcFYXNzZXQHQnBhY2thZ2VzL2RldnRvb2xzX2FwcF9zaGFyZWQvZm9udHMvUm9ib3RvX01vbm8vUm9ib3RvTW9uby1Cb2xkLnR0ZgdDcGFja2FnZXMvZGV2dG9vbHNfYXBwX3NoYXJlZC9mb250cy9Sb2JvdG9fTW9uby9Sb2JvdG9Nb25vLUxpZ2h0LnR0ZgwBDQEHBWFzc2V0B0NwYWNrYWdlcy9kZXZ0b29sc19hcHBfc2hhcmVkL2ZvbnRzL1JvYm90b19Nb25vL1JvYm90b01vbm8tTGlnaHQudHRmB0RwYWNrYWdlcy9kZXZ0b29sc19hcHBfc2hhcmVkL2ZvbnRzL1JvYm90b19Nb25vL1JvYm90b01vbm8tTWVkaXVtLnR0ZgwBDQEHBWFzc2V0B0RwYWNrYWdlcy9kZXZ0b29sc19hcHBfc2hhcmVkL2ZvbnRzL1JvYm90b19Nb25vL1JvYm90b01vbm8tTWVkaXVtLnR0ZgdFcGFja2FnZXMvZGV2dG9vbHNfYXBwX3NoYXJlZC9mb250cy9Sb2JvdG9fTW9uby9Sb2JvdG9Nb25vLVJlZ3VsYXIudHRmDAENAQcFYXNzZXQHRXBhY2thZ2VzL2RldnRvb2xzX2FwcF9zaGFyZWQvZm9udHMvUm9ib3RvX01vbm8vUm9ib3RvTW9uby1SZWd1bGFyLnR0ZgdCcGFja2FnZXMvZGV2dG9vbHNfYXBwX3NoYXJlZC9mb250cy9Sb2JvdG9fTW9uby9Sb2JvdG9Nb25vLVRoaW4udHRmDAENAQcFYXNzZXQHQnBhY2thZ2VzL2RldnRvb2xzX2FwcF9zaGFyZWQvZm9udHMvUm9ib3RvX01vbm8vUm9ib3RvTW9uby1UaGluLnR0Zg=="
diff --git a/...ages/devtools_extensions/example/foo/packages/foo/extension/devtools/build/assets/NOTICES b/...ages/devtools_extensions/example/foo/packages/foo/extension/devtools/build/assets/NOTICES
@@ -30109,6 +30109,70 @@ libwebp
 
 Copyright 2018 Google Inc. All Rights Reserved.
 
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+  * Neither the name of Google nor the names of its contributors may
+    be used to endorse or promote products derived from this software
+    without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+--------------------------------------------------------------------------------
+libwebp
+
+Copyright 2021 Google Inc. All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+  * Neither the name of Google nor the names of its contributors may
+    be used to endorse or promote products derived from this software
+    without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+--------------------------------------------------------------------------------
+libwebp
+
+Copyright 2022 Google Inc. All Rights Reserved.
+
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
 met: