@grafana/create-plugin 4.2.4 → 4.2.5

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.2.5 (Mon Mar 18 2024)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Remove devOnly parameter and related test cases [#823](https://github.com/grafana/plugin-tools/pull/823) ([@oshirohugo](https://github.com/oshirohugo))
+
+#### Authors: 1
+
+- Hugo Kiyodi Oshiro ([@oshirohugo](https://github.com/oshirohugo))
+
+---
+
 # v4.2.4 (Fri Mar 15 2024)
 
 #### 🐛 Bug Fix

package/dist/commands/update.command.js

@@ -40,7 +40,6 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
         updatePackageJson({
             onlyOutdated: true,
             ignoreGrafanaDependencies: false,
-            devOnly: false,
         });
         printBlueBox({
             title: 'Update successful ✔',
@@ -51,7 +50,6 @@ ${chalk.bold.underline('Next steps:')}
 - 1. Run ${chalk.bold(`${packageManagerName} install`)} to install the package updates
 - 2. Check if you encounter any breaking changes
   (refer to our migration guide: https://grafana.com/developers/plugin-tools/migration-guides/update-from-grafana-versions/)
-  
 ${chalk.bold('Do you have questions?')}
 Please don't hesitate to reach out in one of the following ways:
 - Open an issue in https://github.com/grafana/plugin-tools

package/dist/utils/tests/utils.npm.test.js

@@ -194,34 +194,6 @@ describe('Utils / NPM', () => {
             const result = hasNpmDependenciesToUpdate();
             expect(result).toBe(true);
         });
-        test('It should return false when there are no dev dependencies to update in devOnly mode', () => {
-            const packageJson = {
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.0',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.0',
-                },
-                scripts: {},
-            };
-            const latestPackageJson = {
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.1',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.0',
-                },
-                scripts: {},
-            };
-            mocks.getPackageJson.mockReturnValue(packageJson);
-            mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
-            const result = hasNpmDependenciesToUpdate({ devOnly: true });
-            expect(result).toBe(false);
-        });
     });
     describe('getPackageJsonUpdatesAsText', () => {
         test("It should return an empty text when there's nothing to update", () => {
@@ -270,62 +242,6 @@ describe('Utils / NPM', () => {
             expect(result).toContain('sass');
             expect(result).toContain('react');
         });
-        test('It should not return the related text when devOnly and only dependencies to update', () => {
-            const packageJson = {
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.0',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.0',
-                },
-                scripts: {},
-            };
-            const latestPackageJson = {
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.1',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.0',
-                },
-                scripts: {},
-            };
-            mocks.getPackageJson.mockReturnValue(packageJson);
-            mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
-            const result = getPackageJsonUpdatesAsText({ devOnly: true });
-            expect(result).toBe('');
-        });
-        test('It should return the related text when devOnly and only dev dependencies to update', () => {
-            const packageJson = {
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.0',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.0',
-                },
-                scripts: {},
-            };
-            const latestPackageJson = {
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.0',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.1',
-                },
-                scripts: {},
-            };
-            mocks.getPackageJson.mockReturnValue(packageJson);
-            mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
-            const result = getPackageJsonUpdatesAsText({ devOnly: true });
-            expect(result).toContain('sass');
-        });
     });
     describe('updatePackageJson()', () => {
         test('It should not change the package.json if nothing was updated', () => {
@@ -393,81 +309,5 @@ describe('Utils / NPM', () => {
                 scripts: {},
             });
         });
-        test('It should not change the package.json when devOnly is true and only non dev dependencies changed', () => {
-            const packageJson = {
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.0',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.0',
-                },
-                scripts: {},
-            };
-            const latestPackageJson = {
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.1',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.0',
-                },
-                scripts: {},
-            };
-            mocks.getPackageJson.mockReturnValue(packageJson);
-            mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
-            updatePackageJson({ devOnly: true });
-            expect(mocks.writePackageJson).toHaveBeenCalledWith({
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.0',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.0',
-                },
-                scripts: {},
-            });
-        });
-        test('It should change the package.json when devOnly is true but only update dev dependencies', () => {
-            const packageJson = {
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.0',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.0',
-                },
-                scripts: {},
-            };
-            const latestPackageJson = {
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.1',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.1',
-                },
-                scripts: {},
-            };
-            mocks.getPackageJson.mockReturnValue(packageJson);
-            mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
-            updatePackageJson({ devOnly: true });
-            expect(mocks.writePackageJson).toHaveBeenCalledWith({
-                dependencies: {
-                    '@grafana/ui': '10.0.0',
-                    react: '18.2.0',
-                },
-                devDependencies: {
-                    '@testing-library/react': '12.0.0',
-                    sass: '1.0.1',
-                },
-                scripts: {},
-            });
-        });
     });
 });

package/dist/utils/utils.npm.js

@@ -63,7 +63,7 @@ export function getPackageJsonUpdates(options = {}) {
         devDependencyUpdates = ignoreGrafanaDependencies(devDependencyUpdates, prevGrafanaDependencies);
     }
     return {
-        dependencyUpdates: options.devOnly ? {} : dependencyUpdates,
+        dependencyUpdates,
         devDependencyUpdates,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.2.4",
+  "version": "4.2.5",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "b8e8992b5515564b3c6aabd98696d1b32f9d7baa"
+  "gitHead": "83b004bd75c21c6de1b04a8f7e4eb14e887aa116"
 }

package/src/commands/update.command.ts

@@ -53,7 +53,6 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
     updatePackageJson({
       onlyOutdated: true,
       ignoreGrafanaDependencies: false,
-      devOnly: false,
     });
 
     printBlueBox({
@@ -65,7 +64,6 @@ ${chalk.bold.underline('Next steps:')}
 - 1. Run ${chalk.bold(`${packageManagerName} install`)} to install the package updates
 - 2. Check if you encounter any breaking changes
   (refer to our migration guide: https://grafana.com/developers/plugin-tools/migration-guides/update-from-grafana-versions/)
-  
 ${chalk.bold('Do you have questions?')}
 Please don't hesitate to reach out in one of the following ways:
 - Open an issue in https://github.com/grafana/plugin-tools

package/src/utils/tests/utils.npm.test.ts

@@ -267,39 +267,6 @@ describe('Utils / NPM', () => {
       const result = hasNpmDependenciesToUpdate();
       expect(result).toBe(true);
     });
-
-    test('It should return false when there are no dev dependencies to update in devOnly mode', () => {
-      const packageJson = {
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.0',
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.0',
-        },
-        scripts: {},
-      };
-
-      const latestPackageJson = {
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.1', // changed
-        },
-        // remains the same
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.0',
-        },
-        scripts: {},
-      };
-
-      mocks.getPackageJson.mockReturnValue(packageJson);
-      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
-
-      const result = hasNpmDependenciesToUpdate({ devOnly: true });
-      expect(result).toBe(false);
-    });
   });
 
   describe('getPackageJsonUpdatesAsText', () => {
@@ -355,70 +322,6 @@ describe('Utils / NPM', () => {
       expect(result).toContain('sass');
       expect(result).toContain('react');
     });
-
-    test('It should not return the related text when devOnly and only dependencies to update', () => {
-      const packageJson = {
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.0',
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.0',
-        },
-        scripts: {},
-      };
-
-      const latestPackageJson = {
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.1', // changed
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.0',
-        },
-        scripts: {},
-      };
-
-      mocks.getPackageJson.mockReturnValue(packageJson);
-      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
-
-      const result = getPackageJsonUpdatesAsText({ devOnly: true });
-      expect(result).toBe('');
-    });
-
-    test('It should return the related text when devOnly and only dev dependencies to update', () => {
-      const packageJson = {
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.0',
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.0',
-        },
-        scripts: {},
-      };
-
-      const latestPackageJson = {
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.0',
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.1', //changed
-        },
-        scripts: {},
-      };
-
-      mocks.getPackageJson.mockReturnValue(packageJson);
-      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
-
-      const result = getPackageJsonUpdatesAsText({ devOnly: true });
-      expect(result).toContain('sass');
-    });
   });
 
   describe('updatePackageJson()', () => {
@@ -495,91 +398,5 @@ describe('Utils / NPM', () => {
         scripts: {},
       });
     });
-
-    test('It should not change the package.json when devOnly is true and only non dev dependencies changed', () => {
-      const packageJson = {
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.0',
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.0',
-        },
-        scripts: {},
-      };
-
-      const latestPackageJson = {
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.1', //changed
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.0',
-        },
-        scripts: {},
-      };
-
-      mocks.getPackageJson.mockReturnValue(packageJson);
-      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
-
-      updatePackageJson({ devOnly: true });
-      //should have the combined content
-      expect(mocks.writePackageJson).toHaveBeenCalledWith({
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.0',
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.0',
-        },
-        scripts: {},
-      });
-    });
-
-    test('It should change the package.json when devOnly is true but only update dev dependencies', () => {
-      const packageJson = {
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.0',
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.0',
-        },
-        scripts: {},
-      };
-
-      const latestPackageJson = {
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.1', //changed
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.1', //changed
-        },
-        scripts: {},
-      };
-
-      mocks.getPackageJson.mockReturnValue(packageJson);
-      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
-
-      updatePackageJson({ devOnly: true });
-      //should have the combined content
-      expect(mocks.writePackageJson).toHaveBeenCalledWith({
-        dependencies: {
-          '@grafana/ui': '10.0.0',
-          react: '18.2.0', //changed but devOnly so should not be changed in the file
-        },
-        devDependencies: {
-          '@testing-library/react': '12.0.0',
-          sass: '1.0.1',
-        },
-        scripts: {},
-      });
-    });
   });
 });

package/src/utils/utils.npm.ts

@@ -8,7 +8,6 @@ type UpdateSummary = Record<string, { prev: string | null; next: string | null }
 type UpdateOptions = {
   onlyOutdated?: Boolean;
   ignoreGrafanaDependencies?: boolean;
-  devOnly?: boolean;
 };
 
 export function getNpmDependencyUpdatesAsText(dependencyUpdates: UpdateSummary) {
@@ -94,7 +93,7 @@ export function getPackageJsonUpdates(options: UpdateOptions = {}) {
   }
 
   return {
-    dependencyUpdates: options.devOnly ? {} : dependencyUpdates,
+    dependencyUpdates,
     devDependencyUpdates,
   };
 }