v6: Fix default case insensitive paths (#31)

qetza · Apr 23, 2024 · 77cdb57 · 77cdb57
1 parent b21cc8e
commit 77cdb57
Show file tree

Hide file tree

Showing 11 changed files with 102 additions and 40 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,8 @@
 # Changelog
+## 5.0.7
+Task 6.0.6
+- Fix default case sensitivity in sources and additional variables matching ([#29](https://github.com/qetza/replacetokens-task/issues/29)).
+
 ## 5.0.6
 Task 6.0.5
 - Fix normalized variable names not supported as token name ([#15](https://github.com/qetza/replacetokens-task/issues/15)) ([#20](https://github.com/qetza/replacetokens-task/issues/20)).

diff --git a/README.md b/README.md
@@ -102,6 +102,11 @@ The task was completely rewritten to use the npm package [@qetza/replacetokens](
     # Optional.
     additionalVariables: ''
 
+    # Enable case-insensitive file path matching in glob patterns for sources and additionalVariables.
+    #
+    # Optional. Default: true
+    caseInsensitivePaths: ''
+
     # The characters to escape when using 'custom' escape.
     #
     # Optional.
@@ -321,6 +326,7 @@ The following **anonymous** data is send:
 - the agent OS (`Windows`, `macOS` or `Linux`)
 - the inputs values for
   - _addBOM_
+  - _caseInsensitivePaths_
   - _charsToEscape_
   - _encoding_
   - _escape_

diff --git a/tasks/ReplaceTokensV6/CHANGELOG.md b/tasks/ReplaceTokensV6/CHANGELOG.md
@@ -1,4 +1,7 @@
 # Changelog
+## 6.0.6
+- Fix default case sensitivity in sources and additional variables matching ([#29](https://github.com/qetza/replacetokens-task/issues/29)).
+
 ## 6.0.5
 - Fix normalized variable names not supported as token name ([#15](https://github.com/qetza/replacetokens-task/issues/15)) ([#20](https://github.com/qetza/replacetokens-task/issues/20)).
 

diff --git a/tasks/ReplaceTokensV6/README.md b/tasks/ReplaceTokensV6/README.md
@@ -102,6 +102,11 @@ The task was completely rewritten to use the npm package [@qetza/replacetokens](
     # Optional.
     additionalVariables: ''
 
+    # Enable case-insensitive file path matching in glob patterns for sources and additionalVariables.
+    #
+    # Optional. Default: true
+    caseInsensitivePaths: ''
+
     # The characters to escape when using 'custom' escape.
     #
     # Optional.
@@ -321,6 +326,7 @@ The following **anonymous** data is send:
 - the agent OS (`Windows`, `macOS` or `Linux`)
 - the inputs values for
   - _addBOM_
+  - _caseInsensitivePaths_
   - _charsToEscape_
   - _encoding_
   - _escape_

diff --git a/tasks/ReplaceTokensV6/index.ts b/tasks/ReplaceTokensV6/index.ts
@@ -63,6 +63,9 @@ async function run() {
       },
       recursive: tl.getBoolInput('enableRecursion'),
       root: tl.getPathInput('rootDirectory', false, true),
+      sources: {
+        caseInsensitive: tl.getBoolInput('caseInsensitivePaths')
+      },
       token: {
         pattern:
           getChoiceInput('tokenPattern', [
@@ -112,12 +115,13 @@ async function run() {
 
     // load additional variables
     const separator = tl.getInput('variableSeparator') || rt.Defaults.Separator;
-    const additionalVariables = await getAdditionalVariables(options.root, separator);
+    const additionalVariables = await getAdditionalVariables(options.root, separator, options.sources.caseInsensitive);
 
     // set telemetry attributes
     telemetryEvent.setAttributes({
       sources: sources.length,
       'add-bom': options.addBOM,
+      'case-insenstive-paths': options.sources.caseInsensitive,
       'chars-to-escape': options.escape.chars,
       encoding: options.encoding,
       escape: options.escape.type,
@@ -217,7 +221,7 @@ var getChoiceInput = function (name: string, choices: string[], alias?: string):
 var variableFilesCount = 0;
 var variablesEnvCount = 0;
 var inlineVariablesCount = 0;
-var getAdditionalVariables = async function (root?: string, separator?: string): Promise<{ [key: string]: string }> {
+var getAdditionalVariables = async function (root?: string, separator?: string, caseInsensitive?: boolean): Promise<{ [key: string]: string }> {
   const input = tl.getInput('additionalVariables') || '';
   if (!input) return {};
 
@@ -236,7 +240,7 @@ var getAdditionalVariables = async function (root?: string, separator?: string):
           return getAdditionalVariablesFromYaml(input);
       }
     })(),
-    { normalizeWin32: true, root: root, separator: separator }
+    { caseInsensitive: caseInsensitive, normalizeWin32: true, root: root, separator: separator }
   );
 };
 

diff --git a/tasks/ReplaceTokensV6/package-lock.json b/tasks/ReplaceTokensV6/package-lock.json
diff --git a/tasks/ReplaceTokensV6/package.json b/tasks/ReplaceTokensV6/package.json
@@ -8,7 +8,7 @@
     "@opentelemetry/api": "^1.8.0",
     "@opentelemetry/sdk-trace-base": "^1.22.0",
     "@opentelemetry/semantic-conventions": "^1.22.0",
-    "@qetza/replacetokens": "^1.5.0",
+    "@qetza/replacetokens": "^1.6.0",
     "axios": "^1.6.7",
     "azure-pipelines-task-lib": "^4.1.0",
     "js-yaml": "^4.1.0",

diff --git a/tasks/ReplaceTokensV6/task.json b/tasks/ReplaceTokensV6/task.json
@@ -13,7 +13,7 @@
   "version": {
     "Major": 6,
     "Minor": 0,
-    "Patch": 5
+    "Patch": 6
   },
   "releaseNotes": "breaking changes, see [changelog](https://github.com/qetza/replacetokens-task/blob/master/tasks/ReplaceTokensV6/CHANGELOG.md)",
   "instanceNameFormat": "Replace tokens",
@@ -71,6 +71,14 @@
       "label": "Token suffix",
       "helpMarkDown": "The token suffix when using 'custom' token pattern."
     },
+    {
+      "name": "caseInsensitivePaths",
+      "type": "boolean",
+      "required": false,
+      "defaultValue": true,
+      "label": "Case insensitive paths",
+      "helpMarkDown": "Enable case-insensitive file path matching in glob patterns (sources and additionalVariables). Default: true"
+    },
     {
       "name": "encoding",
       "type": "pickList",