Add case-insensitive paths support (#14)

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v1.6.0
+- Add support for case-insensitive glob pattern matching ([#13](https://github.com/qetza/replacetokens/issues/13)).
+- Remove `readTextFile` function.
+
 ## v1.5.0
 - Externalize variable retrieval through callback to support more usage scenarios like external name normalization.
 - Rename `parseVariables` to `loadVariables` and add logs.

README.md

@@ -17,6 +17,7 @@ npm install -g replacetokens
 replacetokens --sources
               --variables
               [--add-bom]
+              [--case-insensitive-paths]
               [--chars-to-escape]
               [--encoding]
               [--escape {auto, off, json, xml, custom}]
@@ -73,6 +74,10 @@ Example: `'@**/*.(json|yaml);!vars.local.json' '$VARS' '{ "var1": "inline", "var
 
 Add BOM when writing files.
 
+`--case-insensitive-paths`
+
+Enable case-insensitive file path matching in glob patterns (sources and variables).
+
 `--chars-to-escape <string>`
 
 The characters to escape when using `custom` escape.
@@ -270,8 +275,9 @@ Load variables from the given list of strings; keys are flatten, merged are retu
 See CLI documentation for the parsing pattern and constraints.
 
 options:
-- `dot`: allow patterns to match entries starting with a dot (`.`)
-- `normalizeWin32`: replace back-slashes (`\`) with forward-slashes (`/`) in file paths
+- `caseInsensitive` _(default: false)_: enable case-insensitive matching in file paths
+- `dot` _(default: false)_: allow patterns to match entries starting with a dot (`.`)
+- `normalizeWin32` _(default: false)_: replace back-slashes (`\`) with forward-slashes (`/`) in file paths
 - `root`: _(default: current working directory)_: root path used when reading files with relative paths
 - `separator` _(default: .)_: the separator used when flattening the keys
 
@@ -307,6 +313,8 @@ options:
   - `log` _(default: warn)_: the key not found message log level
 - `recursive` _(default: false)_: specifies if recursive replacement is enabled
 - `root` _(default: current working directory)_: root path used when reading files with relative paths
+- `sources`: specifies glob pattern options
+  - `caseInsensitive` _(default: false)_: enable case-insensitive matching in file paths
 - `token`: specifies the token pattern
   - `pattern` _(default: default)_: the token pattern
   - `prefix` _(default: null)_: the token prefix if `pattern` is `custom`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qetza/replacetokens",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "replace tokens in files",
   "author": "Guillaume ROUCHON",
   "license": "MIT",

src/bin/run.ts

@@ -13,7 +13,7 @@ export async function run() {
   // parse arguments
   var argv = await yargs(process.argv.slice(2))
     .scriptName('replacetokens')
-    .version('1.5.0')
+    .version('1.6.0')
     .usage('$0 [args]')
     .help()
     .options({
@@ -30,6 +30,10 @@ export async function run() {
         description: 'variables values as JSON'
       },
       'add-bom': { type: 'boolean', description: 'add BOM when writing files' },
+      'case-insensitive-paths': {
+        type: 'boolean',
+        description: 'enable case-insensitive file path matching in glob patterns (sources and variables)'
+      },
       'chars-to-escape': { type: 'string', description: 'custom characters to escape' },
       encoding: {
         default: rt.Encodings.Auto,
@@ -191,7 +195,8 @@ export async function run() {
     const variables = await rt.loadVariables(argv.variables, {
       separator: argv.separator,
       normalizeWin32: false,
-      root: argv.root
+      root: argv.root,
+      caseInsensitive: argv['case-insensitive-paths']
     });
     const result = await rt.replaceTokens(argv.sources, (name: string) => variables[name], {
       root: argv.root,
@@ -220,6 +225,9 @@ export async function run() {
         enabled: argv.transforms,
         prefix: argv['transforms-prefix'],
         suffix: argv['transforms-suffix']
+      },
+      sources: {
+        caseInsensitive: argv['case-insensitive-paths']
       }
     });
 

src/index.ts

@@ -57,6 +57,7 @@ export interface Options {
   readonly addBOM?: boolean;
   readonly escape?: { readonly type?: string; readonly chars?: string; readonly escapeChar?: string };
   readonly transforms?: { readonly enabled?: boolean; readonly prefix?: string; readonly suffix?: string };
+  readonly sources?: { readonly caseInsensitive?: boolean };
 }
 
 export class Counter {
@@ -72,6 +73,7 @@ export interface LoadVariablesOptions {
   normalizeWin32?: boolean;
   root?: string;
   dot?: boolean;
+  caseInsensitive?: boolean;
 }
 
 export async function loadVariables(
@@ -129,6 +131,7 @@ async function loadVariablesFromFile(name: string, options?: LoadVariablesOption
     name.split(';').map(v => v.trim()),
     {
       absolute: true,
+      caseSensitiveMatch: !(options?.caseInsensitive ?? false),
       cwd: options?.root,
       dot: options?.dot,
       onlyFiles: true,
@@ -181,8 +184,7 @@ function flatten(
 
   return result;
 }
-
-export async function readTextFile(
+async function readTextFile(
   path: string,
   encoding: string = Encodings.Auto
 ): Promise<{ encoding: string; content: string }> {
@@ -234,6 +236,9 @@ export async function replaceTokens(
       log: options?.missing?.log ?? MissingVariables.Log.Warn
     },
     recursive: options?.recursive ?? false,
+    sources: {
+      caseInsensitive: options?.sources?.caseInsensitive ?? false
+    },
     token: {
       pattern: options?.token?.pattern ?? TokenPatterns.Default,
       prefix: (() => {
@@ -302,6 +307,7 @@ export async function replaceTokens(
   for (const pattern of patterns) {
     var inputs = await fg.glob(pattern.inputPatterns, {
       absolute: true,
+      caseSensitiveMatch: !options.sources!.caseInsensitive,
       cwd: options.root,
       onlyFiles: true,
       unique: true

tests/data/loadvariables/VARS2.json

@@ -0,0 +1,6 @@
+{
+  "var1": "value1",
+  "var2": {
+    "sub2": ["value2"]
+  }
+}

tests/loadvariables.test.ts

@@ -234,4 +234,14 @@ describe('loadVariables', () => {
 
     expect(result).toEqual({ VAR1: 'value1', VAR2: 'file', 'VAR2.SUB2.0': 'value2', VAR3: 'file' });
   });
+
+  it('options: caseInsensitive', async () => {
+    // act
+    const result = await loadVariables(['@**/vars2.json'], { root: data, caseInsensitive: true });
+
+    // assert
+    expect(consoleSpies.debug).toHaveBeenCalledWith(`loading from file '${path.join(data, 'VARS2.json')}'`);
+
+    expect(result).toEqual({ VAR1: 'value1', 'VAR2.SUB2.0': 'value2' });
+  });
 });

tests/replacetokens.test.ts

@@ -257,6 +257,25 @@ describe('replaceTokens', () => {
       await expectFileToEqual(input, 'default.json');
       await expectFileToEqual(path.join(tmp, 'output/default2.json'), 'default.expected.json');
     });
+
+    it('case insensitive paths', async () => {
+      // arrange
+      const input = await copyData('default.json', 'DEFAULT1.json');
+      spyOnConsole();
+
+      // act
+      const result = await replaceTokens(
+        normalizeSources(path.join(tmp, '**/default1.json')),
+        getVariableCallback({ var1: 'var1_value', var2: 'var2_value' }),
+        {
+          sources: { caseInsensitive: true }
+        }
+      );
+
+      // assert
+      expectCountersToEqual(result, 0, 1, 2, 2, 0);
+      await expectFileToEqual(input, 'default.expected.json');
+    });
   });
 
   describe('variables', () => {

tests/run.test.ts

@@ -254,6 +254,13 @@ describe('run', () => {
     await run();
 
     // assert
+    expect(loadVariablesSpy).toHaveBeenCalledWith(['{}'], {
+      separator: rt.Defaults.Separator,
+      normalizeWin32: false,
+      root: undefined,
+      caseInsensitive: undefined
+    });
+
     expect(replaceTokensSpy).toHaveBeenCalledWith(['file1'], expect.any(Function), {
       root: undefined,
       encoding: 'auto',
@@ -278,6 +285,9 @@ describe('run', () => {
         enabled: undefined,
         prefix: '(',
         suffix: ')'
+      },
+      sources: {
+        caseInsensitive: undefined
       }
     });
 
@@ -732,6 +742,26 @@ describe('run', () => {
     );
   });
 
+  it('case-insensitive-paths', async () => {
+    // arrange
+    jest.replaceProperty(process, 'argv', argv('--case-insensitive-paths'));
+
+    // act
+    await run();
+
+    // assert
+    expect(loadVariablesSpy).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.objectContaining({ caseInsensitive: true })
+    );
+
+    expect(replaceTokensSpy).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.any(Function),
+      expect.objectContaining({ sources: expect.objectContaining({ caseInsensitive: true }) })
+    );
+  });
+
   it('replace tokens', async () => {
     // arrange
     await fs.mkdir(tmp, { recursive: true });