Updated README.md (#1694)

Co-authored-by: repo-ranger[bot] <repo-ranger[bot]@users.noreply.github.com>

HISTORY.md

@@ -1,5 +1,21 @@
 # Changelog
 
+# [40.0.2](https://github.com/tj-actions/changed-files/compare/v40.0.1...v40.0.2) - (2023-10-31)
+
+## <!-- 1 -->🐛 Bug Fixes
+
+- Order of file patterns ([#1688](https://github.com/tj-actions/changed-files/issues/1688)) ([4052680](https://github.com/tj-actions/changed-files/commit/40526807ee1e208a1a8c1bbe6bd2d1b044ef6368))  - (Tonye Jack)
+
+## <!-- 7 -->⚙️ Miscellaneous Tasks
+
+- **deps:** Update dependency @types/node to v20.8.10 ([a59bf8f](https://github.com/tj-actions/changed-files/commit/a59bf8ffcfcfdd831463eff511b55a7123a04aca))  - (renovate[bot])
+
+## <!-- 9 -->⬆️ Upgrades
+
+- Upgraded to v40.0.1 ([#1686](https://github.com/tj-actions/changed-files/issues/1686))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([6821899](https://github.com/tj-actions/changed-files/commit/68218997649ac879f47639455e9669b94750b50f))  - (tj-actions[bot])
+
 # [40.0.1](https://github.com/tj-actions/changed-files/compare/v40.0.0...v40.0.1) - (2023-10-30)
 
 ## <!-- 1 -->🐛 Bug Fixes

README.md

@@ -397,6 +397,7 @@ Support this project with a :star:
 |                   <a name="input_files_yaml_from_source_file_separator"></a>[files\_yaml\_from\_source\_file\_separator](#input_files_yaml_from_source_file_separator)                   | string |  false   |          `"\n"`           |                                                                                                     Separator used to split the <br>`files_yaml_from_source_file` input                                                                                                      |
 |                         <a name="input_include_all_old_new_renamed_files"></a>[include\_all\_old\_new\_renamed\_files](#input_include_all_old_new_renamed_files)                         | string |  false   |         `"false"`         |                                                       Include `all_old_new_renamed_files` output. Note this <br>can generate a large output <br>See: [#501](https://github.com/tj-actions/changed-files/issues/501).                                                         |
 |                                                                    <a name="input_json"></a>[json](#input_json)                                                                     | string |  false   |         `"false"`         |                                  Output list of changed files <br>in a JSON formatted string <br>which can be used for <br>matrix jobs. [Example](https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-test.yml)                                   |
+|                                        <a name="input_negation_patterns_first"></a>[negation\_patterns\_first](#input_negation_patterns_first)                                        | string |  false   |         `"false"`         |                                                                                      Apply the negation patterns first. <br>**NOTE:** This affects how changed <br>files are matched.                                                                                        |
 |                                        <a name="input_old_new_files_separator"></a>[old\_new\_files\_separator](#input_old_new_files_separator)                                        | string |  false   |           `" "`           |                                                                                                         Split character for old and <br>new renamed filename pairs.                                                                                                          |
 |                                                 <a name="input_old_new_separator"></a>[old\_new\_separator](#input_old_new_separator)                                                 | string |  false   |           `","`           |                                                                                                             Split character for old and <br>new filename pairs.                                                                                                              |
 |                                                           <a name="input_output_dir"></a>[output\_dir](#input_output_dir)                                                            | string |  false   |    `".github/outputs"`    |                                                                                                                       Directory to store output files.                                                                                                                       |

action.yml

@@ -200,6 +200,10 @@ inputs:
     description: "Fail when the submodule diff fails."
     required: false
     default: "false"
+  negation_patterns_first:
+    description: "Apply the negation patterns first. **NOTE:** This affects how changed files are matched."
+    required: false
+    default: "false"
 
 outputs:
   added_files:

dist/index.js

@@ -1528,6 +1528,9 @@ const getInputs = () => {
     const dirNamesDeletedFilesIncludeOnlyDeletedDirs = core.getBooleanInput('dir_names_deleted_files_include_only_deleted_dirs', {
         required: false
     });
+    const negationPatternsFirst = core.getBooleanInput('negation_patterns_first', {
+        required: false
+    });
     const inputs = {
         files,
         filesSeparator,
@@ -1578,7 +1581,8 @@ const getInputs = () => {
         outputDir,
         outputRenamedFilesAsDeletedAndAdded,
         token,
-        apiUrl
+        apiUrl,
+        negationPatternsFirst
     };
     if (fetchDepth) {
         inputs.fetchDepth = Math.max(parseInt(fetchDepth, 10), 2);
@@ -2542,60 +2546,68 @@ const getDirNamesIncludeFilesPattern = ({ inputs }) => {
 };
 exports.getDirNamesIncludeFilesPattern = getDirNamesIncludeFilesPattern;
 const getFilePatterns = ({ inputs, workingDirectory }) => __awaiter(void 0, void 0, void 0, function* () {
-    let filePatterns = '';
+    let cleanedFilePatterns = [];
+    if (inputs.files) {
+        const filesPatterns = inputs.files
+            .split(inputs.filesSeparator)
+            .filter(Boolean);
+        cleanedFilePatterns.push(...filesPatterns);
+        core.debug(`files patterns: ${filesPatterns.join('\n')}`);
+    }
+    if (inputs.filesFromSourceFile !== '') {
+        const inputFilesFromSourceFile = inputs.filesFromSourceFile
+            .split(inputs.filesFromSourceFileSeparator)
+            .filter(Boolean)
+            .map(p => path.join(workingDirectory, p));
+        core.debug(`files from source file: ${inputFilesFromSourceFile}`);
+        const filesFromSourceFiles = yield getFilesFromSourceFile({
+            filePaths: inputFilesFromSourceFile
+        });
+        core.debug(`files from source files patterns: ${filesFromSourceFiles.join('\n')}`);
+        cleanedFilePatterns.push(...filesFromSourceFiles);
+    }
     if (inputs.filesIgnore) {
         const filesIgnorePatterns = inputs.filesIgnore
             .split(inputs.filesIgnoreSeparator)
-            .filter(p => p !== '')
+            .filter(Boolean)
             .map(p => {
             if (!p.startsWith('!')) {
                 p = `!${p}`;
             }
             return p;
-        })
-            .join('\n');
-        core.debug(`files ignore patterns: ${filesIgnorePatterns}`);
-        filePatterns = filePatterns.concat('\n', filesIgnorePatterns);
+        });
+        core.debug(`files ignore patterns: ${filesIgnorePatterns.join('\n')}`);
+        cleanedFilePatterns.push(...filesIgnorePatterns);
     }
     if (inputs.filesIgnoreFromSourceFile) {
         const inputFilesIgnoreFromSourceFile = inputs.filesIgnoreFromSourceFile
             .split(inputs.filesIgnoreFromSourceFileSeparator)
-            .filter(p => p !== '')
+            .filter(Boolean)
             .map(p => path.join(workingDirectory, p));
         core.debug(`files ignore from source file: ${inputFilesIgnoreFromSourceFile}`);
-        const filesIgnoreFromSourceFiles = (yield getFilesFromSourceFile({
+        const filesIgnoreFromSourceFiles = yield getFilesFromSourceFile({
             filePaths: inputFilesIgnoreFromSourceFile,
             excludedFiles: true
-        })).join('\n');
-        core.debug(`files ignore from source files patterns: ${filesIgnoreFromSourceFiles}`);
-        filePatterns = filePatterns.concat('\n', filesIgnoreFromSourceFiles);
+        });
+        core.debug(`files ignore from source files patterns: ${filesIgnoreFromSourceFiles.join('\n')}`);
+        cleanedFilePatterns.push(...filesIgnoreFromSourceFiles);
     }
-    if (inputs.files) {
-        filePatterns = filePatterns.concat('\n', inputs.files.split(inputs.filesSeparator).filter(Boolean).join('\n'));
+    if (inputs.negationPatternsFirst) {
+        cleanedFilePatterns.sort((a, b) => {
+            return a.startsWith('!') ? -1 : b.startsWith('!') ? 1 : 0;
+        });
     }
-    if (inputs.filesFromSourceFile !== '') {
-        const inputFilesFromSourceFile = inputs.filesFromSourceFile
-            .split(inputs.filesFromSourceFileSeparator)
-            .filter(p => p !== '')
-            .map(p => path.join(workingDirectory, p));
-        core.debug(`files from source file: ${inputFilesFromSourceFile}`);
-        const filesFromSourceFiles = (yield getFilesFromSourceFile({ filePaths: inputFilesFromSourceFile })).join('\n');
-        core.debug(`files from source files patterns: ${filesFromSourceFiles}`);
-        filePatterns = filePatterns.concat('\n', filesFromSourceFiles);
-    }
-    if ((0, exports.isWindows)()) {
-        filePatterns = filePatterns.replace(/\r\n/g, '\n');
-        filePatterns = filePatterns.replace(/\r/g, '\n');
-    }
-    const filePatternsArray = filePatterns.trim().split('\n').filter(Boolean);
-    // Reorder file patterns '**' should come before '!**/*.txt' and then the rest 'dir/**/*.txt'
-    if (filePatternsArray.includes('**')) {
-        filePatternsArray.sort((a, b) => {
+    // Reorder file patterns '**' should come first
+    if (cleanedFilePatterns.includes('**')) {
+        cleanedFilePatterns.sort((a, b) => {
             return a === '**' ? -1 : b === '**' ? 1 : 0;
         });
     }
-    core.debug(`Input file patterns: \n${filePatternsArray.join('\n')}`);
-    return filePatternsArray;
+    if ((0, exports.isWindows)()) {
+        cleanedFilePatterns = cleanedFilePatterns.map(pattern => pattern.replace(/\r\n/g, '\n').replace(/\r/g, '\n'));
+    }
+    core.debug(`Input file patterns: \n${cleanedFilePatterns.join('\n')}`);
+    return cleanedFilePatterns;
 });
 exports.getFilePatterns = getFilePatterns;
 const getYamlFilePatternsFromContents = ({ content = '', filePath = '', excludedFiles = false }) => __awaiter(void 0, void 0, void 0, function* () {
@@ -58317,7 +58329,7 @@ class Directives {
                 onError('Verbatim tags must end with a >');
             return verbatim;
         }
-        const [, handle, suffix] = source.match(/^(.*!)([^!]*)$/);
+        const [, handle, suffix] = source.match(/^(.*!)([^!]*)$/s);
         if (!suffix)
             onError(`The ${source} tag has no suffix`);
         const prefix = this.tags[handle];

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tj-actions/changed-files",
-  "version": "40.0.1",
+  "version": "40.0.2",
   "description": "Github action to retrieve all (added, copied, modified, deleted, renamed, type changed, unmerged, unknown) files and directories.",
   "main": "lib/main.js",
   "publishConfig": {

src/inputs.ts

@@ -51,6 +51,7 @@ export type Inputs = {
   skipInitialFetch: boolean
   failOnInitialDiffError: boolean
   failOnSubmoduleDiffError: boolean
+  negationPatternsFirst: boolean
 }
 
 export const getInputs = (): Inputs => {
@@ -218,6 +219,13 @@ export const getInputs = (): Inputs => {
     }
   )
 
+  const negationPatternsFirst = core.getBooleanInput(
+    'negation_patterns_first',
+    {
+      required: false
+    }
+  )
+
   const inputs: Inputs = {
     files,
     filesSeparator,
@@ -268,7 +276,8 @@ export const getInputs = (): Inputs => {
     outputDir,
     outputRenamedFilesAsDeletedAndAdded,
     token,
-    apiUrl
+    apiUrl,
+    negationPatternsFirst
   }
 
   if (fetchDepth) {

src/utils.ts

@@ -938,90 +938,99 @@ export const getFilePatterns = async ({
   inputs: Inputs
   workingDirectory: string
 }): Promise<string[]> => {
-  let filePatterns = ''
+  let cleanedFilePatterns: string[] = []
+
+  if (inputs.files) {
+    const filesPatterns = inputs.files
+      .split(inputs.filesSeparator)
+      .filter(Boolean)
+
+    cleanedFilePatterns.push(...filesPatterns)
+
+    core.debug(`files patterns: ${filesPatterns.join('\n')}`)
+  }
+
+  if (inputs.filesFromSourceFile !== '') {
+    const inputFilesFromSourceFile = inputs.filesFromSourceFile
+      .split(inputs.filesFromSourceFileSeparator)
+      .filter(Boolean)
+      .map(p => path.join(workingDirectory, p))
+
+    core.debug(`files from source file: ${inputFilesFromSourceFile}`)
+
+    const filesFromSourceFiles = await getFilesFromSourceFile({
+      filePaths: inputFilesFromSourceFile
+    })
+
+    core.debug(
+      `files from source files patterns: ${filesFromSourceFiles.join('\n')}`
+    )
+
+    cleanedFilePatterns.push(...filesFromSourceFiles)
+  }
 
   if (inputs.filesIgnore) {
     const filesIgnorePatterns = inputs.filesIgnore
       .split(inputs.filesIgnoreSeparator)
-      .filter(p => p !== '')
+      .filter(Boolean)
       .map(p => {
         if (!p.startsWith('!')) {
           p = `!${p}`
         }
         return p
       })
-      .join('\n')
 
-    core.debug(`files ignore patterns: ${filesIgnorePatterns}`)
+    core.debug(`files ignore patterns: ${filesIgnorePatterns.join('\n')}`)
 
-    filePatterns = filePatterns.concat('\n', filesIgnorePatterns)
+    cleanedFilePatterns.push(...filesIgnorePatterns)
   }
 
   if (inputs.filesIgnoreFromSourceFile) {
     const inputFilesIgnoreFromSourceFile = inputs.filesIgnoreFromSourceFile
       .split(inputs.filesIgnoreFromSourceFileSeparator)
-      .filter(p => p !== '')
+      .filter(Boolean)
       .map(p => path.join(workingDirectory, p))
 
     core.debug(
       `files ignore from source file: ${inputFilesIgnoreFromSourceFile}`
     )
 
-    const filesIgnoreFromSourceFiles = (
-      await getFilesFromSourceFile({
-        filePaths: inputFilesIgnoreFromSourceFile,
-        excludedFiles: true
-      })
-    ).join('\n')
+    const filesIgnoreFromSourceFiles = await getFilesFromSourceFile({
+      filePaths: inputFilesIgnoreFromSourceFile,
+      excludedFiles: true
+    })
 
     core.debug(
-      `files ignore from source files patterns: ${filesIgnoreFromSourceFiles}`
+      `files ignore from source files patterns: ${filesIgnoreFromSourceFiles.join(
+        '\n'
+      )}`
     )
 
-    filePatterns = filePatterns.concat('\n', filesIgnoreFromSourceFiles)
+    cleanedFilePatterns.push(...filesIgnoreFromSourceFiles)
   }
 
-  if (inputs.files) {
-    filePatterns = filePatterns.concat(
-      '\n',
-      inputs.files.split(inputs.filesSeparator).filter(Boolean).join('\n')
-    )
+  if (inputs.negationPatternsFirst) {
+    cleanedFilePatterns.sort((a, b) => {
+      return a.startsWith('!') ? -1 : b.startsWith('!') ? 1 : 0
+    })
   }
 
-  if (inputs.filesFromSourceFile !== '') {
-    const inputFilesFromSourceFile = inputs.filesFromSourceFile
-      .split(inputs.filesFromSourceFileSeparator)
-      .filter(p => p !== '')
-      .map(p => path.join(workingDirectory, p))
-
-    core.debug(`files from source file: ${inputFilesFromSourceFile}`)
-
-    const filesFromSourceFiles = (
-      await getFilesFromSourceFile({filePaths: inputFilesFromSourceFile})
-    ).join('\n')
-
-    core.debug(`files from source files patterns: ${filesFromSourceFiles}`)
-
-    filePatterns = filePatterns.concat('\n', filesFromSourceFiles)
-  }
-
-  if (isWindows()) {
-    filePatterns = filePatterns.replace(/\r\n/g, '\n')
-    filePatterns = filePatterns.replace(/\r/g, '\n')
-  }
-
-  const filePatternsArray = filePatterns.trim().split('\n').filter(Boolean)
-
-  // Reorder file patterns '**' should come before '!**/*.txt' and then the rest 'dir/**/*.txt'
-  if (filePatternsArray.includes('**')) {
-    filePatternsArray.sort((a, b) => {
+  // Reorder file patterns '**' should come first
+  if (cleanedFilePatterns.includes('**')) {
+    cleanedFilePatterns.sort((a, b) => {
       return a === '**' ? -1 : b === '**' ? 1 : 0
     })
   }
 
-  core.debug(`Input file patterns: \n${filePatternsArray.join('\n')}`)
+  if (isWindows()) {
+    cleanedFilePatterns = cleanedFilePatterns.map(pattern =>
+      pattern.replace(/\r\n/g, '\n').replace(/\r/g, '\n')
+    )
+  }
 
-  return filePatternsArray
+  core.debug(`Input file patterns: \n${cleanedFilePatterns.join('\n')}`)
+
+  return cleanedFilePatterns
 }
 
 // Example YAML input:

yarn.lock

@@ -4104,9 +4104,9 @@ yallist@^4.0.0:
   integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==
 
 yaml@^2.3.1:
-  version "2.3.3"
-  resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.3.3.tgz#01f6d18ef036446340007db8e016810e5d64aad9"
-  integrity sha512-zw0VAJxgeZ6+++/su5AFoqBbZbrEakwu+X0M5HmcwUiBL7AzcuPKjj5we4xfQLp78LkEMpD0cOnUhmgOVy3KdQ==
+  version "2.3.4"
+  resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.3.4.tgz#53fc1d514be80aabf386dc6001eb29bf3b7523b2"
+  integrity sha512-8aAvwVUSHpfEqTQ4w/KMlf3HcRdt50E5ODIQJBw1fQ5RL34xabzxtUlzTXVqc4rkZsPbvrXKWnABCD7kWSmocA==
 
 yargs-parser@^21.0.1, yargs-parser@^21.1.1:
   version "21.1.1"