Change to include dotfiles by default

Closes GH-55.
unifiedjs · Aug 17, 2023 · 2249314 · 2249314
1 parent 65da801
commit 2249314
Show file tree

Hide file tree

Showing 12 changed files with 107 additions and 28 deletions.
diff --git a/doc/ignore.md b/doc/ignore.md
@@ -47,10 +47,8 @@ directory instead, by setting
 (default).
 
 If paths or globs to directories are given to the engine, they will be searched
-for matching files, but `node_modules` and hidden directories (those starting
-with a dot, `.`, such as `.git`) are normally not searched.
-Pass paths or globs to files or those directories to include files inside
-`node_modules` and hidden directories.
+for matching files, but `node_modules` are normally not searched.
+Pass paths or globs to `node_modules` to include files inside them.
 
 The format for ignore files is the same as [`.gitignore`][gitignore], so it’s
 possible to pass a `.gitignore` in as [`ignorePath`][ignore-path].

diff --git a/doc/options.md b/doc/options.md
@@ -104,8 +104,7 @@ Directories and globs to directories can be given alongside
 [`extensions`][extensions] to search directories for files matching an extension
 (for example, `dir` to add `dir/readme.txt` and `dir/sub/history.text` if
 `extensions` is `['txt', 'text']`).
-This searching will not include `node_modules` or hidden directories (those
-starting with a dot, `.`, like `.git`).
+This searching will not include `node_modules`, but you can pass it explicitly.
 
 *   Type: `Array<string | URL | VFile>`
 *   Default: `[]`

diff --git a/lib/finder.js b/lib/finder.js
@@ -267,11 +267,7 @@ function search(input, options, next) {
 
     const part = base(file)
 
-    if (
-      options.nested &&
-      part &&
-      (part.charAt(0) === '.' || part === 'node_modules')
-    ) {
+    if (options.nested && part && part === 'node_modules') {
       return
     }
 

diff --git a/test/color.js b/test/color.js
@@ -1,4 +1,5 @@
 import assert from 'node:assert/strict'
+import fs from 'node:fs/promises'
 import test from 'node:test'
 import {promisify} from 'node:util'
 import {engine} from '../index.js'
@@ -11,10 +12,14 @@ const fixtures = new URL('fixtures/', import.meta.url)
 
 test('color', async function (t) {
   await t.test('should support color', async function () {
+    const cwd = new URL('empty/', fixtures)
     const stderr = spy()
+
+    await fs.mkdir(cwd, {recursive: true})
+
     const code = await run({
       color: true,
-      cwd: new URL('empty/', fixtures),
+      cwd,
       files: ['readme.md'],
       processor: noop,
       streamError: stderr.stream

diff --git a/test/file-path.js b/test/file-path.js
@@ -1,4 +1,5 @@
 import assert from 'node:assert/strict'
+import fs from 'node:fs/promises'
 import {sep} from 'node:path'
 import {PassThrough} from 'node:stream'
 import test from 'node:test'
@@ -27,15 +28,18 @@ test('file-path', async function (t) {
   })
 
   await t.test('should support `filePath`', async function () {
+    const cwd = new URL('empty/', fixtures)
     const stderr = spy()
     const stdout = spy()
     const stream = new PassThrough()
     let index = 0
 
+    await fs.mkdir(cwd, {recursive: true})
+
     send()
 
     const code = await run({
-      cwd: new URL('empty/', fixtures),
+      cwd,
       filePath: 'foo' + sep + 'bar.baz',
       processor: noop,
       streamError: stderr.stream,

diff --git a/test/fixtures/hidden-directory/.fooignore b/test/fixtures/hidden-directory/.fooignore
diff --git a/test/fixtures/empty/.empty → ...de-modules-directory/node_modules/two.txt b/test/fixtures/empty/.empty → ...de-modules-directory/node_modules/two.txt
diff --git a/test/fixtures/node-modules-directory/one.txt b/test/fixtures/node-modules-directory/one.txt
diff --git a/test/ignore.js b/test/ignore.js
@@ -89,14 +89,35 @@ test('ignore', async function (t) {
     )
   })
 
-  await t.test('should not look into hidden files', async function () {
+  await t.test('should look into hidden files', async function () {
     const stderr = spy()
 
     const code = await run({
       cwd: new URL('hidden-directory/', fixtures),
       extensions: ['txt'],
       files: ['.'],
-      // No `ignoreName`.
+      processor: noop,
+      streamError: stderr.stream
+    })
+
+    assert.equal(code, 0)
+    assert.equal(
+      stderr(),
+      [
+        '.hidden' + sep + 'two.txt: no issues found',
+        'one.txt: no issues found',
+        ''
+      ].join('\n')
+    )
+  })
+
+  await t.test('should not look into `node_modules`', async function () {
+    const stderr = spy()
+
+    const code = await run({
+      cwd: new URL('node-modules-directory/', fixtures),
+      extensions: ['txt'],
+      files: ['.'],
       processor: noop,
       streamError: stderr.stream
     })
@@ -105,6 +126,31 @@ test('ignore', async function (t) {
     assert.equal(stderr(), 'one.txt: no issues found\n')
   })
 
+  await t.test(
+    'should look into `node_modules` w/ explicit search',
+    async function () {
+      const stderr = spy()
+
+      const code = await run({
+        cwd: new URL('node-modules-directory/', fixtures),
+        extensions: ['txt'],
+        files: ['node_modules/', '.'],
+        processor: noop,
+        streamError: stderr.stream
+      })
+
+      assert.equal(code, 0)
+      assert.equal(
+        stderr(),
+        [
+          'node_modules' + sep + 'two.txt: no issues found',
+          'one.txt: no issues found',
+          ''
+        ].join('\n')
+      )
+    }
+  )
+
   await t.test('should support no ignore files', async function () {
     const stderr = spy()
 

diff --git a/test/input.js b/test/input.js
@@ -3,6 +3,7 @@
  */
 
 import assert from 'node:assert/strict'
+import fs from 'node:fs/promises'
 import {join, sep} from 'node:path'
 import {PassThrough} from 'node:stream'
 import test from 'node:test'
@@ -56,10 +57,13 @@ test('input', async function (t) {
   })
 
   await t.test('should not fail on unmatched given globs', async function () {
+    const cwd = new URL('empty/', fixtures)
     const stderr = spy()
 
+    await fs.mkdir(cwd, {recursive: true})
+
     const code = await run({
-      cwd: new URL('empty/', fixtures),
+      cwd,
       files: ['.'],
       processor: unified(),
       streamError: stderr.stream
@@ -70,10 +74,13 @@ test('input', async function (t) {
   })
 
   await t.test('should report unfound given files', async function () {
+    const cwd = new URL('empty/', fixtures)
     const stderr = spy()
 
+    await fs.mkdir(cwd, {recursive: true})
+
     const code = await run({
-      cwd: new URL('empty/', fixtures),
+      cwd,
       files: ['readme.md'],
       processor: unified(),
       streamError: stderr.stream
@@ -101,6 +108,7 @@ test('input', async function (t) {
 
       const code = await run({
         cwd: new URL('directory/', fixtures),
+        extensions: ['txt'],
         files: ['empty/'],
         processor: unified(),
         streamError: stderr.stream
@@ -374,6 +382,8 @@ test('input', async function (t) {
       const stderr = spy()
       const cwd = new URL('empty/', fixtures)
 
+      await fs.mkdir(cwd, {recursive: true})
+
       const code = await run({
         cwd,
         files: [
@@ -421,6 +431,8 @@ test('input', async function (t) {
       const cwd = join('test', 'fixtures', 'empty')
       const file = new VFile({value: 'foo'})
 
+      await fs.mkdir(cwd, {recursive: true})
+
       const code = await run({
         cwd,
         files: [file],
@@ -523,9 +535,12 @@ test('input', async function (t) {
   await t.test(
     'should fail w/ `ignoreUnconfigured` and `rcPath`',
     async function () {
+      const cwd = new URL('empty/', fixtures)
+      await fs.mkdir(cwd, {recursive: true})
+
       try {
         await run({
-          cwd: new URL('empty/', fixtures),
+          cwd,
           files: ['.'],
           ignoreUnconfigured: true,
           processor: unified(),
@@ -545,9 +560,12 @@ test('input', async function (t) {
   await t.test(
     'should fail w/ `ignoreUnconfigured` and w/o `rcName`, `packageField`',
     async function () {
+      const cwd = new URL('empty/', fixtures)
+      await fs.mkdir(cwd, {recursive: true})
+
       try {
         await run({
-          cwd: new URL('empty/', fixtures),
+          cwd,
           files: ['.'],
           ignoreUnconfigured: true,
           processor: unified(),
@@ -566,9 +584,12 @@ test('input', async function (t) {
   await t.test(
     'should fail w/ `ignoreUnconfigured` and `detectConfig: false`',
     async function () {
+      const cwd = new URL('empty/', fixtures)
+      await fs.mkdir(cwd, {recursive: true})
+
       try {
         await run({
-          cwd: new URL('empty/', fixtures),
+          cwd,
           detectConfig: false,
           files: ['.'],
           ignoreUnconfigured: true,
@@ -593,6 +614,7 @@ test('input', async function (t) {
     const code = await run({
       cwd: new URL('config-ignore-unconfigured/', fixtures),
       files: ['.'],
+      extensions: ['txt'],
       ignoreUnconfigured: true,
       processor: noop,
       rcName: '.foorc',
@@ -633,6 +655,8 @@ test('input', async function (t) {
       const cwd = new URL('empty/', fixtures)
       const stderr = spy()
 
+      await fs.mkdir(cwd, {recursive: true})
+
       const code = await run({
         cwd,
         files: [

diff --git a/test/output.js b/test/output.js
@@ -358,6 +358,8 @@ test('output', async function (t) {
       const targetFile = new URL('one.txt', cwd)
       const stderr = spy()
 
+      await fs.mkdir(cwd, {recursive: true})
+
       const code = await run({
         cwd,
         extensions: ['txt'],

diff --git a/test/stdin.js b/test/stdin.js
@@ -1,4 +1,5 @@
 import assert from 'node:assert/strict'
+import fs from 'node:fs/promises'
 import {PassThrough} from 'node:stream'
 import test from 'node:test'
 import {promisify} from 'node:util'
@@ -11,16 +12,19 @@ const fixtures = new URL('fixtures/', import.meta.url)
 
 test('stdin', async function (t) {
   await t.test('should support stdin', async function () {
-    const stdout = spy()
+    const cwd = new URL('empty/', fixtures)
     const stderr = spy()
+    const stdout = spy()
     const stream = new PassThrough()
     let index = 0
 
+    await fs.mkdir(cwd, {recursive: true})
+
     setImmediate(send)
 
     const code = await run({
+      cwd,
       processor: noop,
-      cwd: new URL('empty/', fixtures),
       streamIn: stream,
       streamOut: stdout.stream,
       streamError: stderr.stream
@@ -41,20 +45,23 @@ test('stdin', async function (t) {
   })
 
   await t.test('should not output if `out: false`', async function () {
-    const stdout = spy()
+    const cwd = new URL('empty/', fixtures)
     const stderr = spy()
+    const stdout = spy()
     const stream = new PassThrough()
     let index = 0
 
+    await fs.mkdir(cwd, {recursive: true})
+
     setImmediate(send)
 
     const code = await run({
+      cwd,
+      out: false,
       processor: noop,
-      cwd: new URL('empty/', fixtures),
       streamIn: stream,
       streamOut: stdout.stream,
-      streamError: stderr.stream,
-      out: false
+      streamError: stderr.stream
     })
 
     assert.equal(code, 0)