Add dot paths support (#16)

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## v1.6.0
 - Add support for case-insensitive glob pattern matching ([#13](https://github.com/qetza/replacetokens/issues/13)).
+- Add support for dot paths in glob pattern matching ([#12](https://github.com/qetza/replacetokens/issues/12)).
 - Remove `readTextFile` function.
 
 ## v1.5.0

README.md

@@ -23,6 +23,7 @@ replacetokens --sources
               [--escape {auto, off, json, xml, custom}]
               [--escape-char]
               [--help]
+              [--include-dot-paths]
               [--log-level {debug, info, warn, error, off}]
               [--missing-var-action {none, keep, replace}]
               [--missing-var-default]
@@ -76,7 +77,7 @@ Add BOM when writing files.
 
 `--case-insensitive-paths`
 
-Enable case-insensitive file path matching in glob patterns (sources and variables).
+Enable case-insensitive file path matching in glob patterns (_sources_ and _variables_).
 
 `--chars-to-escape <string>`
 
@@ -109,6 +110,10 @@ The escape character to use when using `custom` escape.
 
 Show help.
 
+`--include-dot-paths`
+
+Include directories and files starting with a dot (`.`) in glob matching results (_sources_ and _variables_).
+
 `--log-level <string>`
 
 The log level. Default is `info`.
@@ -276,7 +281,7 @@ See CLI documentation for the parsing pattern and constraints.
 
 options:
 - `caseInsensitive` _(default: false)_: enable case-insensitive matching in file paths
-- `dot` _(default: false)_: allow patterns to match entries starting with a dot (`.`)
+- `dot` _(default: false)_: include directories and files starting with a dot (`.`) in glob matching results
 - `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
@@ -315,6 +320,7 @@ options:
 - `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
+  - `dot` _(default: false)_: include directories and files starting with a dot (`.`) in glob matching results
 - `token`: specifies the token pattern
   - `pattern` _(default: default)_: the token pattern
   - `prefix` _(default: null)_: the token prefix if `pattern` is `custom`

src/bin/run.ts

@@ -45,6 +45,11 @@ export async function run() {
         description: 'value escaping'
       },
       'escape-char': { type: 'string', description: 'custom escape character' },
+      'include-dot-paths': {
+        type: 'boolean',
+        description:
+          "Include directories and files starting with a dot ('.') in glob matching results (sources and variables)."
+      },
       'log-level': {
         choice: ['debug', 'info', 'warn', 'error', 'off'],
         default: 'info',
@@ -196,7 +201,8 @@ export async function run() {
       separator: argv.separator,
       normalizeWin32: false,
       root: argv.root,
-      caseInsensitive: argv['case-insensitive-paths']
+      caseInsensitive: argv['case-insensitive-paths'],
+      dot: argv['include-dot-paths']
     });
     const result = await rt.replaceTokens(argv.sources, (name: string) => variables[name], {
       root: argv.root,
@@ -227,7 +233,8 @@ export async function run() {
         suffix: argv['transforms-suffix']
       },
       sources: {
-        caseInsensitive: argv['case-insensitive-paths']
+        caseInsensitive: argv['case-insensitive-paths'],
+        dot: argv['include-dot-paths']
       }
     });
 

src/index.ts

@@ -57,7 +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 };
+  readonly sources?: { readonly caseInsensitive?: boolean; readonly dot?: boolean };
 }
 
 export class Counter {
@@ -237,7 +237,8 @@ export async function replaceTokens(
     },
     recursive: options?.recursive ?? false,
     sources: {
-      caseInsensitive: options?.sources?.caseInsensitive ?? false
+      caseInsensitive: options?.sources?.caseInsensitive ?? false,
+      dot: options?.sources?.dot ?? false
     },
     token: {
       pattern: options?.token?.pattern ?? TokenPatterns.Default,
@@ -308,6 +309,7 @@ export async function replaceTokens(
     var inputs = await fg.glob(pattern.inputPatterns, {
       absolute: true,
       caseSensitiveMatch: !options.sources!.caseInsensitive,
+      dot: options.sources!.dot,
       cwd: options.root,
       onlyFiles: true,
       unique: true

tests/data/loadvariables/.vars.json

@@ -0,0 +1,3 @@
+{
+  "var4": "value4"
+}

tests/loadvariables.test.ts

@@ -60,6 +60,8 @@ describe('loadVariables', () => {
     expect(consoleSpies.debug).toHaveBeenCalledWith(`loading from file '${path.join(data, 'vars.json')}'`);
     expect(consoleSpies.debug).toHaveBeenCalledWith(`loading from file '${path.join(data, 'vars.yml')}'`);
     expect(consoleSpies.debug).toHaveBeenCalledWith(`loading from file '${path.join(data, 'vars.yaml')}'`);
+    expect(consoleSpies.debug).not.toHaveBeenCalledWith(`loading from file '${path.join(data, '.vars.json')}'`);
+    expect(consoleSpies.debug).not.toHaveBeenCalledWith(`loading from file '${path.join(data, '.vars', 'var.json')}'`);
 
     expect(result).toEqual({
       VAR1: 'value1',
@@ -230,9 +232,10 @@ describe('loadVariables', () => {
     // assert
     expect(consoleSpies.debug).toHaveBeenCalledWith(`loading from file '${path.join(data, 'var.jsonc')}'`);
     expect(consoleSpies.debug).toHaveBeenCalledWith(`loading from file '${path.join(data, 'vars.json')}'`);
+    expect(consoleSpies.debug).toHaveBeenCalledWith(`loading from file '${path.join(data, '.vars.json')}'`);
     expect(consoleSpies.debug).toHaveBeenCalledWith(`loading from file '${path.join(data, '.vars', 'var.json')}'`);
 
-    expect(result).toEqual({ VAR1: 'value1', VAR2: 'file', 'VAR2.SUB2.0': 'value2', VAR3: 'file' });
+    expect(result).toEqual({ VAR1: 'value1', VAR2: 'file', 'VAR2.SUB2.0': 'value2', VAR3: 'file', VAR4: 'value4' });
   });
 
   it('options: caseInsensitive', async () => {

tests/replacetokens.test.ts

@@ -21,6 +21,8 @@ describe('replaceTokens', () => {
 
   async function copyData(source: string, dest: string): Promise<string> {
     dest = path.join(tmp, dest);
+
+    await fs.mkdir(path.dirname(dest), { recursive: true });
     await fs.copyFile(path.join(data, source), dest);
 
     return path.resolve(dest);
@@ -276,6 +278,27 @@ describe('replaceTokens', () => {
       expectCountersToEqual(result, 0, 1, 2, 2, 0);
       await expectFileToEqual(input, 'default.expected.json');
     });
+
+    it('dot paths', async () => {
+      // arrange
+      const input1 = await copyData('default.json', '.default1.json');
+      const input2 = await copyData('default.json', '.data/default1.json');
+      spyOnConsole();
+
+      // act
+      const result = await replaceTokens(
+        normalizeSources(path.join(tmp, '**/*.json')),
+        getVariableCallback({ var1: 'var1_value', var2: 'var2_value' }),
+        {
+          sources: { dot: true }
+        }
+      );
+
+      // assert
+      expectCountersToEqual(result, 0, 2, 4, 4, 0);
+      await expectFileToEqual(input1, 'default.expected.json');
+      await expectFileToEqual(input2, 'default.expected.json');
+    });
   });
 
   describe('variables', () => {

tests/run.test.ts

@@ -287,7 +287,8 @@ describe('run', () => {
         suffix: ')'
       },
       sources: {
-        caseInsensitive: undefined
+        caseInsensitive: undefined,
+        dot: undefined
       }
     });
 
@@ -762,6 +763,23 @@ describe('run', () => {
     );
   });
 
+  it('include-dot-paths', async () => {
+    // arrange
+    jest.replaceProperty(process, 'argv', argv('--include-dot-paths'));
+
+    // act
+    await run();
+
+    // assert
+    expect(loadVariablesSpy).toHaveBeenCalledWith(expect.anything(), expect.objectContaining({ dot: true }));
+
+    expect(replaceTokensSpy).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.any(Function),
+      expect.objectContaining({ sources: expect.objectContaining({ dot: true }) })
+    );
+  });
+
   it('replace tokens', async () => {
     // arrange
     await fs.mkdir(tmp, { recursive: true });