@justeattakeaway/eslint-plugin-snacks-pie-migration 0.7.0 → 0.7.1

package/README.md

@@ -173,9 +173,21 @@ The components data used by the plugin is stored in two files: `snacks-component
 ### `snacks-components-data.json`
 It's an auto-generated file that contains the list of deprecated components and their replacement PIE components (if they exist).
 
-Please do not update the `snacks-components-data.json` file directly, as it is generated automatically by a script.
+Please do not update the `snacks-components-data.json` file directly, as it is generated automatically.
 
-To update the data, you need to update the `pieMetadata` key of the components in the PIE repository, and then run the `build` command of this package to regenerate the JSON file.
+To update the data, update the `pieMetadata` key of the components in the PIE repository. The CI automation will detect the change, regenerate the file, and open a pull request automatically.
+
+To regenerate the file manually, run the `build` command of this package.
+
+#### `extractComponentData`
+
+The data extraction logic is exported from this package and can be used by other tools:
+
+```js
+const { extractComponentData } = require('@justeattakeaway/eslint-plugin-snacks-pie-migration/extract-component-data');
+```
+
+It reads component `package.json` files from a given directory and returns a sorted map of Snacks component names to their PIE package and status. Only components with `beta` or `stable` status and at least one Snacks replacement are included.
 
 ### `snacks-components-solutions.js`
 This file can be manually updated with solutions that apply to multiple components, such as migration skills, or with specific solutions for individual components that don't have a direct mapping to a PIE component.

package/lib/extract-component-data.js

@@ -0,0 +1,63 @@
+const fs = require('fs');
+// eslint-disable-next-line import/no-extraneous-dependencies
+const { globSync } = require('glob');
+
+function listFiles (startPath, globSyncImpl) {
+    return globSyncImpl('**/package.json', {
+        ignore: 'node_modules/**',
+        cwd: startPath,
+        absolute: true,
+    });
+}
+
+/**
+ * Reads package files from a specified path, extracts component data based on certain criteria,
+ * and returns a sorted object of components with their package name and status.
+ * @param startPath - directory path from which you want to start searching for package files
+ * containing component data.
+ * @param [deps] - object that can contain optional dependencies for `fs` and `globSync` modules.
+ * These dependencies are used to provide flexibility in testing and mocking these modules when needed.
+ * If not provided, the function will default to using the actual `fs` and `globSync` modules.
+ * @returns Returns an object containing component data, where the keys are component names and the
+ * values are objects with `piePackage` and `status` properties. The components are sorted alphabetically
+ * by their names.
+ */
+function extractComponentData (startPath, deps = {}) {
+    const fsImpl = deps.fs || fs;
+    const globSyncImpl = deps.globSync || globSync;
+    const packageFiles = listFiles(startPath, globSyncImpl);
+    const components = {};
+
+    packageFiles.forEach((filePath) => {
+        const fileContent = fsImpl.readFileSync(filePath, 'utf8');
+        const parsedPackage = JSON.parse(fileContent);
+
+        if (!parsedPackage.pieMetadata) return;
+        const { pieMetadata } = parsedPackage;
+
+        const hasStatus = pieMetadata?.componentStatus === 'beta' || pieMetadata?.componentStatus === 'stable';
+        const isReplacement = pieMetadata?.replaces?.snacks?.length > 0;
+
+        if (hasStatus && isReplacement) {
+            pieMetadata.replaces.snacks.forEach((snacksComponentName) => {
+                components[snacksComponentName] = {
+                    piePackage: parsedPackage.name,
+                    status: pieMetadata.componentStatus,
+                };
+            });
+        }
+    });
+
+    if (Object.keys(components).length === 0) {
+        throw new Error('extractComponentData() failed. No components could be found.');
+    }
+
+    return Object.keys(components)
+        .sort()
+        .reduce((acc, key) => {
+            acc[key] = components[key];
+            return acc;
+        }, {});
+}
+
+module.exports = { extractComponentData };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justeattakeaway/eslint-plugin-snacks-pie-migration",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "This plugin helps developers to identify deprecated Snacks components and provides suggestions of replacement PIE components",
   "repository": {
     "type": "git",
@@ -24,7 +24,11 @@
     "PIE"
   ],
   "main": "./lib/index.js",
-  "exports": "./lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./extract-component-data": "./lib/extract-component-data.js",
+    "./snacks-components-data.json": "./snacks-components-data.json"
+  },
   "files": [
     "lib",
     "snacks-components-data.json",