@elliemae/ds-codemods 3.26.0-next.8 → 3.26.0-next.9

package/bin/cli/utils/File Matching.md

@@ -76,8 +76,14 @@ I will use the native node implementation to ensure maximum compatibility and to
 
 ##### step 2 - further filtering - gitignore compliant
 
-I have found out https://github.com/micromatch/micromatch
+~~I have found out [micromatch](https://github.com/micromatch/micromatch)~~
 
-which seems to be used by `square`, `webpack`, `babel core`, `yarn`, `jest`, `taro`, `bulma`, `browser-sync`, `documentation.js`, `stylelint`, `nyc`, `ava`
+~~which seems to be used by `square`, `webpack`, `babel core`, `yarn`, `jest`, `taro`, `bulma`, `browser-sync`, `documentation.js`, `stylelint`, `nyc`, `ava`~~
 
-and seems to be matching our requirements.
+~~and seems to be matching our requirements.~~
+
+after live testing, micromatch is not following the gitignore specs,
+see [github issue](https://github.com/micromatch/micromatch/issues/244) for reference
+
+I will use [ignore](https://www.npmjs.com/package/ignore) instead, which
+[seems to be doing exactly what we want](https://stackblitz.com/edit/node-61bbcz?file=ignore.js)

package/bin/cli/utils/filepathsMatchers.mjs

@@ -3,8 +3,11 @@
 import path from 'path';
 import { readdirSync, readFileSync } from 'fs';
 import { logCurrMemoryUsage, logMemoryUsageDiff } from './debugHelpers.mjs';
-import micromatch from 'micromatch'; // used to filter out files that match the git ignore patterns
+import ignore from 'ignore'; // used to filter out files that match the git ignore patterns
 
+const ig = ignore({
+  allowRelativePaths: true,
+});
 /********************************************************************
  * ******* GENERIC STRING HELPERS COMMON TO PATHS & FILENAMES *******
  ********************************************************************/
@@ -121,9 +124,8 @@ export const fullFilesPaths = (startingPath, debug = false) => {
 //   while (dirsToProcess.length > 0) {
 //     const dir = dirsToProcess.pop();
 //     // we filter out the ignored files and directories here
-//     const fileList = readdirSync(dir, { withFileTypes: true }).filter(
-//       (file) => !micromatch.isMatch(generatePosixPath(`${dir}/${file.name}`), gitPatterns, { contains: true }),
-//     );
+//     ig.add(gitPatterns);
+//     const fileList = readdirSync(dir, { withFileTypes: true }).filter(ig.createFilter());
 //     fileList.forEach((file) => {
 //       const filePath = generatePosixPath(`${dir}/${file.name}`);
 //       if (file.isDirectory()) {
@@ -185,9 +187,8 @@ export const filePathsWithGitIgnore = (options) => {
 
   // Based on my testing, filtering at the end results in way better performance than filtering as we go...
   // console.log('--------------- ----------------- filtering at the end:');
-  const nonGitIgnoredFiles = fullFilesPaths(startingDirPath, debug).filter(
-    (file) => !micromatch.isMatch(file, gitPatterns),
-  );
+  ig.add(gitPatterns);
+  const nonGitIgnoredFiles = fullFilesPaths(startingDirPath, debug).filter(ig.createFilter());
   // we only want files matching the file extensions
   const files = nonGitIgnoredFiles.filter((filePath) => {
     const dotlessExtension = filePath.split('.').pop();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-codemods",
-  "version": "3.26.0-next.8",
+  "version": "3.26.0-next.9",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Code Mods",
   "files": [
@@ -35,9 +35,12 @@
     "fs": "~0.0.1-security",
     "fs-extra": "~11.1.1",
     "glob": "~10.2.5",
+    "hygen": "^6.2.11",
+    "ignore": "^5.3.0",
     "inquirer": "~9.2.4",
     "pacote": "~15.2.0",
-    "path": "~0.12.7"
+    "path": "~0.12.7",
+    "voca": "~1.4.0"
   },
   "publishConfig": {
     "access": "public",
@@ -50,6 +53,8 @@
     "try-check-deprecated-packages": "npx ./ check-deprecated-packages --cwd=\"test-ables/check-deprecated-packages/with-deprecated\"",
     "try-check-deprecated-packages-no-dimsum": "npx ./ check-deprecated-packages --cwd=\"test-ables/check-deprecated-packages/without-dimsum-packages\"",
     "try-help-migrate-to-v3": "npx ./ help-migrate-to-v3 --globPattern=\"test-ables/help-migrate-to-v3/**/*.js,./**/*.jsx,./**/*.ts,./**/*.tsx\" --globPatternIgnore=\"**/node_modules/**/*\"",
+    "create-package": "hygen package new",
+    "create-part": "hygen part new",
     "checkDeps": "exit 0 | echo"
   }
 }