Tweak default ignore for isDirEmpty

Author: jdalton

registry/lib/constants/ignore-globs.d.ts

@@ -18,7 +18,6 @@ import EXTENSIONS_JSON from './extensions-json'
 import getIpc from './get-ipc'
 import GITIGNORE from './gitignore'
 import HIDDEN_PACKAGE_LOCK_JSON from './hidden-package-lock-json'
-import ignoreGlobs from './ignore-globs'
 import IPC from './ipc'
 import kInternalsSymbol from './k-internals-symbol'
 import LATEST from './latest'
@@ -196,7 +195,6 @@ declare const Constants: {
   readonly abortSignal: typeof abortSignal
   readonly copyLeftLicenses: typeof copyLeftLicenses
   readonly execPath: typeof execPath
-  readonly ignoreGlobs: typeof ignoreGlobs
   readonly kInternalsSymbol: typeof kInternalsSymbol
   readonly lifecycleScriptNames: typeof lifecycleScriptNames
   readonly maintainedNodeVersions: typeof maintainedNodeVersions

registry/lib/constants/ignore-globs.js

@@ -23,6 +23,9 @@ declare type BufferEncoding =
   | 'utf-16le'
   | 'ucs2'
   | 'ucs-2'
+declare type IsDirEmptyOptions = {
+  ignore?: string[] | readonly string[] | undefined
+}
 declare type JsonContent = NPMCliPackageJson.Content
 declare type ReadFileOptions =
   | Remap<
@@ -39,6 +42,7 @@ declare type ReadJsonOptions = Remap<
   }
 >
 declare type ReadDirOptions = {
+  ignore?: string[] | readonly string[] | undefined
   includeEmpty?: boolean | undefined
   sort?: boolean | undefined
 }
@@ -51,15 +55,18 @@ declare type WriteJsonOptions = Remap<
   }
 >
 declare const Fs: {
-  isDirEmptySync: (dirname: string) => boolean
+  isDirEmptySync: (
+    dirname: string,
+    options?: IsDirEmptyOptions | undefined
+  ) => boolean
   isSymbolicLinkSync(filepath: PathLike): boolean
-  readDirNames(dirname: PathLike, options?: ReadDirOptions): Promise<string[]>
+  readDirNames(
+    dirname: PathLike,
+    options?: ReadDirOptions | undefined
+  ): Promise<string[]>
   readDirNamesSync: (
     dirname: string,
-    options?: {
-      includeEmpty?: boolean | undefined
-      sort?: boolean | undefined
-    }
+    options?: ReadDirOptions | undefined
   ) => string[]
   readJson(
     filepath: PathLike,

registry/lib/constants/index.d.ts

@@ -6,6 +6,46 @@ const { getGlobMatcher } = /*@__PURE__*/ require('./globs')
 const { naturalCompare } = /*@__PURE__*/ require('./sorts')
 const { stripBom } = /*@__PURE__*/ require('./strings')
 
+const defaultIgnore = ObjectFreeze([
+  // Most of these ignored files can be included specifically if included in the
+  // files globs. Exceptions to this are:
+  // https://docs.npmjs.com/cli/v10/configuring-npm/package-json#files
+  // These can NOT be included.
+  // https://github.com/npm/npm-packlist/blob/v10.0.0/lib/index.js#L280
+  '**/.git',
+  '**/.npmrc',
+  // '**/bun.lockb?',
+  // '**/node_modules',
+  // '**/package-lock.json',
+  // '**/pnpm-lock.ya?ml',
+  // '**/yarn.lock',
+  // Include npm-packlist defaults:
+  // https://github.com/npm/npm-packlist/blob/v10.0.0/lib/index.js#L15-L38
+  '**/.DS_Store',
+  '**/.gitignore',
+  '**/.hg',
+  '**/.lock-wscript',
+  '**/.npmignore',
+  '**/.svn',
+  '**/.wafpickle-*',
+  '**/.*.swp',
+  '**/._*/**',
+  '**/archived-packages/**',
+  '**/build/config.gypi',
+  '**/CVS',
+  '**/npm-debug.log',
+  '**/*.orig',
+  // Inline generic .gitignore entries from the socket-registry repository root.
+  '**/.env',
+  '**/.eslintcache',
+  '**/.nvm',
+  '**/.tap',
+  '**/.tapci.yaml',
+  '**/.vscode',
+  '**/*.tsbuildinfo',
+  '**/Thumbs.db'
+])
+
 const defaultRemoveOptions = ObjectFreeze({
   __proto__: null,
   force: true,
@@ -38,36 +78,34 @@ function getPath() {
 
 /*@__NO_SIDE_EFFECTS__*/
 function innerReadDirNames(dirents, options) {
-  const { includeEmpty, sort } = {
-    __proto__: null,
-    sort: true,
-    includeEmpty: false,
-    ...options
-  }
+  const {
+    ignore,
+    includeEmpty = false,
+    sort = true
+  } = { __proto__: null, ...options }
   const path = getPath()
   const names = dirents
     .filter(
       d =>
         d.isDirectory() &&
-        (includeEmpty || !isDirEmptySync(path.join(d.parentPath, d.name)))
+        (includeEmpty ||
+          !isDirEmptySync(path.join(d.parentPath, d.name), { ignore }))
     )
     .map(d => d.name)
   return sort ? names.sort(naturalCompare) : names
 }
 
 /*@__NO_SIDE_EFFECTS__*/
-function isDirEmptySync(dirname) {
+function isDirEmptySync(dirname, options) {
+  const { ignore = defaultIgnore } = { __proto__: null, ...options }
   const fs = getFs()
   try {
     const files = fs.readdirSync(dirname)
     const { length } = files
     if (length === 0) {
       return true
     }
-    const matcher = getGlobMatcher(
-      /*@__PURE__*/ require('./constants/ignore-globs'),
-      { cwd: dirname }
-    )
+    const matcher = getGlobMatcher(ignore, { cwd: dirname })
     let ignoredCount = 0
     for (let i = 0; i < length; i += 1) {
       if (matcher(files[i])) {

registry/lib/fs.d.ts

@@ -181,10 +181,6 @@
       "types": "./lib/constants/hidden-package-lock-json.d.ts",
       "default": "./lib/constants/hidden-package-lock-json.js"
     },
-    "./lib/constants/ignore-globs": {
-      "types": "./lib/constants/ignore-globs.d.ts",
-      "default": "./lib/constants/ignore-globs.js"
-    },
     "./lib/constants/index": {
       "types": "./lib/constants/index.d.ts",
       "default": "./lib/constants/index.js"