@grafana/create-plugin 0.5.2 → 0.5.3

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v0.5.3 (Thu Nov 17 2022)
+
+#### 🐛 Bug Fix
+
+- Create-Plugin: Transform known ES modules in jest config [#145](https://github.com/grafana/plugin-tools/pull/145) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # v0.5.2 (Thu Nov 17 2022)
 
 #### 🐛 Bug Fix

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -59,5 +59,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "33c2b874ddfd16530302004a8089162f04d12c4d"
+  "gitHead": "ffc20a3bfe4c15077f48f958808d212cfb463fb1"
 }

package/templates/common/.config/README.md

@@ -16,11 +16,12 @@ to issues around working with the project.
 Edit the `.eslintrc` file in the project root in order to extend the ESLint configuration.
 
 **Example:**
+
 ```json
 {
   "extends": "./.config/.eslintrc",
   "rules": {
-      "react/prop-types": "off"
+    "react/prop-types": "off"
   }
 }
 ```
@@ -32,10 +33,11 @@ Edit the `.eslintrc` file in the project root in order to extend the ESLint conf
 Edit the `.prettierrc.js` file in the project root in order to extend the Prettier configuration.
 
 **Example:**
+
 ```javascript
 module.exports = {
   // Prettier configuration provided by Grafana scaffolding
-  ...require("./.config/.prettierrc.js"),
+  ...require('./.config/.prettierrc.js'),
 
   semi: false,
 };
@@ -50,7 +52,23 @@ There are two configuration in the project root that belong to Jest: `jest-setup
 **`jest-setup.js`:** A file that is run before each test file in the suite is executed. We are using it to
 set up the Jest DOM for the testing library and to apply some polyfills. ([link to Jest docs](https://jestjs.io/docs/configuration#setupfilesafterenv-array))
 
-**`jest.config.js`:** The main Jest configuration file that is extending our basic Grafana-tailored setup. ([link to Jest docs](https://jestjs.io/docs/configuration))
+**`jest.config.js`:** The main Jest configuration file that extends the Grafana recommended setup. ([link to Jest docs](https://jestjs.io/docs/configuration))
+
+#### ESM errors with Jest
+
+A common issue found with the current jest config involves importing an npm package which only offers an ESM build. These packages cause jest to error with `SyntaxError: Cannot use import statement outside a module`. To work around this we provide a list of known packages to pass to the `[transformIgnorePatterns](https://jestjs.io/docs/configuration#transformignorepatterns-arraystring)` jest configuration property. If need be this can be extended in the following way:
+
+```javascript
+process.env.TZ = 'UTC';
+const { grafanaESModules, nodeModulesToTransform } = require('./jest/utils');
+
+module.exports = {
+  // Jest configuration provided by Grafana
+  ...require('./.config/jest.config'),
+  // Inform jest to only transform specific node_module packages.
+  transformIgnorePatterns: [nodeModulesToTransform([...grafanaESModules, 'packageName'])],
+};
+```
 
 ---
 
@@ -59,6 +77,7 @@ set up the Jest DOM for the testing library and to apply some polyfills. ([link
 Edit the `tsconfig.json` file in the project root in order to extend the TypeScript configuration.
 
 **Example:**
+
 ```json
 {
   "extends": "./.config/tsconfig.json",
@@ -80,6 +99,7 @@ Create a new config file that is going to extend the basic one provided by Grafa
 It can live in the project root, e.g. `webpack.config.ts`.
 
 #### 2. Merge the basic config provided by Grafana and your custom setup
+
 We are going to use [`webpack-merge`](https://github.com/survivejs/webpack-merge) for this.
 
 ```typescript
@@ -100,7 +120,6 @@ const config = async (env): Promise<Configuration> => {
 };
 
 export default config;
-
 ```
 
 #### 3. Update the `package.json` to use the new Webpack config
@@ -108,12 +127,14 @@ export default config;
 We need to update the `scripts` in the `package.json` to use the extended Webpack configuration.
 
 **Update for `build`:**
+
 ```diff
 -"build": "webpack -c ./.config/webpack/webpack.config.ts --env production",
 +"build": "webpack -c ./webpack.config.ts --env production",
 ```
 
 **Update for `dev`:**
+
 ```diff
 -"dev": "webpack -w -c ./.config/webpack/webpack.config.ts --env development",
 +"dev": "webpack -w -c ./webpack.config.ts --env development",

package/templates/common/.config/jest/utils.ts

@@ -0,0 +1,8 @@
+/*
+ * This utility function is useful in combination with jest `transformIgnorePatterns` config
+ * to transform specific packages (e.g.ES modules) in a projects node_modules folder.
+ */
+export const nodeModulesToTransform = (moduleNames: string[]) => `node_modules\/(?!(${moduleNames.join('|')})\/)`;
+
+// Array of known nested grafana package dependencies that only bundle an ESM version
+export const grafanaESModules = ['ol', 'react-colorful'];

package/templates/common/.config/jest.config.js

@@ -5,11 +5,12 @@
  */
 
 const path = require('path');
+const { grafanaESModules, nodeModulesToTransform } = require('./jest/utils');
 
 module.exports = {
   moduleNameMapper: {
-    "\\.(css|scss|sass)$": "identity-obj-proxy",
-    "react-inlinesvg": path.resolve(__dirname, "mocks", "react-inlinesvg.tsx"),
+    '\\.(css|scss|sass)$': 'identity-obj-proxy',
+    'react-inlinesvg': path.resolve(__dirname, 'jest', 'mocks', 'react-inlinesvg.tsx'),
   },
   modulePaths: ['<rootDir>/src'],
   setupFilesAfterEnv: ['<rootDir>/jest-setup.js'],
@@ -35,5 +36,7 @@ module.exports = {
       },
     ],
   },
-  transformIgnorePatterns: [],
+  // Jest will throw `Cannot use import statement outside module` if it tries to load an
+  // ES module without it being transformed first. ./config/README.md#esm-errors-with-jest
+  transformIgnorePatterns: [nodeModulesToTransform(grafanaESModules)],
 };