@justeattakeaway/eslint-plugin-snacks-pie-migration 0.1.0 → 0.1.2

package/README.md

@@ -154,7 +154,9 @@ This is particularly useful during migration to PIE components, as it allows you
 - Focus on preventing new deprecated component usage
 - Gradually refactor existing code at your own pace
 
-ℹ️ Changes will be compared against the `main` branch. In case `main` doesn't exist, the `master` branch will be used.
+> ℹ️ When running locally, the branch changes will be compared against the merge base ref. It assumes the `main` branch exists. Otherwise the `master` branch will be used. In any case, no extra configuration is needed.
+
+> ℹ️ When running on Github CI, the plugin will use the PR base branch SHA since the merge base can't be easily inferred. In this case, ensure to pass the `BASE_SHA` environment variable. Its value should be set to `github.event.pull_request.base.sha`.
 
 To use the processor, add the following line to your ESLint configuration:
 

package/lib/processors/added-components.js

@@ -1,5 +1,5 @@
 const { readFileSync } = require('fs');
-const { isFileNew, getFileStateFromBranch } = require('../util/git-utils');
+const { isFileNew, getFileStateFromRef } = require('../util/git-utils');
 const { addedComponentsPostprocessor } = require('../util/added-components-postprocessor');
 
 /**
@@ -9,6 +9,6 @@ const { addedComponentsPostprocessor } = require('../util/added-components-postp
  */
 module.exports = {
     postprocess (messages, filePath) {
-        return addedComponentsPostprocessor(messages, filePath, { readFileSync, isFileNew, getFileStateFromBranch });
+        return addedComponentsPostprocessor(messages, filePath, { readFileSync, isFileNew, getFileStateFromRef });
     },
 };

package/lib/util/added-components-postprocessor.js

@@ -1,3 +1,4 @@
+const path = require('path');
 const { getAddedComponents } = require('./get-added-components');
 const { getDefaultBranchName } = require('./git-utils');
 
@@ -9,17 +10,20 @@ const { getDefaultBranchName } = require('./git-utils');
  * @param filePath - the file path
  * @returns A filtered array of messages based on certain conditions
  */
-function addedComponentsPostprocessor (messages, filePath, { readFileSync, isFileNew, getFileStateFromBranch }) {
+function addedComponentsPostprocessor (messages, filePath, { readFileSync, isFileNew, getFileStateFromRef }) {
     // Get file relative path to the repo
-    const relativeFilePath = filePath.replace(process.cwd(), '').substr(1);
+    const relativeFilePath = path.relative(process.cwd(), filePath)
+        .replace(/\\/g, '/'); // Fix path handling on Windows
 
     // Check if file was added, but not committed yet
     // This is used in the pre-commit hook
     const isNewFile = isFileNew(relativeFilePath);
 
     // Get file content before and after
-    const mainBranchName = getDefaultBranchName();
-    const filePreviousState = isNewFile ? '' : getFileStateFromBranch(relativeFilePath, mainBranchName);
+    //   In CI is preferred to use the base SHA as it is easily available
+    //   In local environment it's easier to pull the info with git merge-base from the main branch
+    const ref = 'BASE_SHA' in process.env && process.env.BASE_SHA;
+    const filePreviousState = isNewFile ? '' : getFileStateFromRef(relativeFilePath, ref, getDefaultBranchName());
     const fileCurrentState = readFileSync(relativeFilePath, 'utf8');
 
     // Get list of added components

package/lib/util/git-utils.js

@@ -16,17 +16,18 @@ function isFileNew (relativeFilePath) {
 }
 
 /**
- * Get file content from a specific branch
+ * Get file content from a ref
  * @param {string} relativeFilePath - The relative path to the file from the repo root
- * @param {string} branch - The branch name to check the file content from
+ * @param {string} ref - SHA ref to check the file content from, give preference to this option when running on CI
+ * @param {string} branch - Alternatively, the branch name to check the file content from, give preference to this option when running on local environment
  * @returns
  */
-function getFileStateFromBranch (relativeFilePath, branch = 'main') {
+function getFileStateFromRef (relativeFilePath, ref, branch = 'main') {
     try {
-        // Get the merge base to find the actual parent branch
-        const mergeBase = execSync(`git merge-base HEAD ${branch}`, { encoding: 'utf8' }).trim();
-        return execSync(`git show ${mergeBase}:"${relativeFilePath}"`, { encoding: 'utf8', stdio: 'pipe' });
-    } catch (error) {
+        // If the base sha wasn't provided, try to guess with merge-base
+        const sha = ref || execSync(`git merge-base HEAD ${branch}`, { encoding: 'utf8' }).trim();
+        return execSync(`git show ${sha}:"${relativeFilePath}"`, { encoding: 'utf8', stdio: 'pipe' });
+    } catch {
         // If the file was added in this branch, this might fail, return empty string
         return '';
     }
@@ -47,6 +48,6 @@ function getDefaultBranchName () {
 
 module.exports = {
     isFileNew,
-    getFileStateFromBranch,
+    getFileStateFromRef,
     getDefaultBranchName,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justeattakeaway/eslint-plugin-snacks-pie-migration",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "This plugin helps developers to identify deprecated Snacks components and provides suggestions of replacement PIE components",
   "repository": {
     "type": "git",