feat: valid if files containing exports (#606)

package.json

@@ -13,10 +13,10 @@
     "clean": "rm -rf ./dist",
     "typecheck": "tsc --noEmit && tsc -p test/tsconfig.json --noEmit",
     "prepublishOnly": "pnpm clean && pnpm build && chmod +x ./dist/bin/cli.js && pnpm test:ci",
-    "cli": "cross-env SWC_NODE_IGNORE_DYNAMIC=1 node -r @swc-node/register",
-    "ts-bunchee": "pnpm cli ./src/bin/index.ts",
+    "run-ts": "cross-env SWC_NODE_IGNORE_DYNAMIC=1 node -r @swc-node/register",
+    "ts-bunchee": "pnpm run-ts ./src/bin/index.ts",
     "build-dir": "pnpm ts-bunchee --cwd",
-    "build": "pnpm cli ./src/bin/index.ts --runtime node",
+    "build": "pnpm run-ts ./src/bin/index.ts --runtime node",
     "format": "prettier --write .",
     "prepare": "husky"
   },
@@ -63,6 +63,7 @@
     "glob": "^11.0.0",
     "magic-string": "^0.30.11",
     "ora": "^8.0.1",
+    "picomatch": "^4.0.2",
     "pretty-bytes": "^5.6.0",
     "rollup": "^4.27.4",
     "rollup-plugin-dts": "^6.1.1",
@@ -90,6 +91,7 @@
     "@types/clean-css": "^4.2.11",
     "@types/jest": "29.0.0",
     "@types/node": "^22.9.3",
+    "@types/picomatch": "^3.0.1",
     "@types/yargs": "^17.0.33",
     "bunchee": "link:./",
     "cross-env": "^7.0.3",

src/bin/index.ts

@@ -150,6 +150,13 @@ async function parseCliArgs(argv: string[]) {
     .showHelpOnFail(true)
     .parse()
 
+  const cmd = args._[0]
+  if (cmd === 'prepare' || cmd === 'lint') {
+    return {
+      cmd,
+    }
+  }
+
   const source: string = args._[0] as string
   const parsedArgs: CliArgs = {
     source,
@@ -340,6 +347,9 @@ async function main() {
     // if (!error) help()
     return exit(error as Error)
   }
+  if ('cmd' in params) {
+    return
+  }
   await run(params)
 }
 

src/lint.ts

@@ -3,6 +3,7 @@ import { parseExports } from './exports'
 import { logger } from './logger'
 import { PackageMetadata } from './types'
 import { hasCjsExtension, isESModulePackage, isTypeFile } from './utils'
+import picomatch from 'picomatch'
 
 type BadExportItem = {
   value: boolean
@@ -19,6 +20,56 @@ function validateTypesFieldCondition(pair: [string, string]) {
   return false
 }
 
+const isPathIncluded = (filesField: string[], filePath: string) => {
+  return filesField.some((pattern) => {
+    const normalizedPattern = path.normalize(pattern)
+    const matcher = picomatch(normalizedPattern)
+    return matcher(filePath)
+  })
+}
+
+function validateFilesField(packageJson: PackageMetadata) {
+  const state: {
+    definedField: boolean
+    missingFiles: string[]
+  } = {
+    definedField: false,
+    missingFiles: [],
+  }
+  const filesField = packageJson.files || []
+  const exportsField = packageJson.exports || {}
+
+  state.definedField = !!packageJson.files
+
+  const resolveExportsPaths = (exports: any): string[] => {
+    const paths = []
+    if (typeof exports === 'string') {
+      paths.push(exports)
+    } else if (typeof exports === 'object') {
+      for (const key in exports) {
+        paths.push(...resolveExportsPaths(exports[key]))
+      }
+    }
+    return paths
+  }
+
+  const exportedPaths = resolveExportsPaths(exportsField).map((p) =>
+    path.normalize(p),
+  )
+  const commonFields = ['main', 'module', 'types', 'module-sync']
+  for (const field of commonFields) {
+    if (field in packageJson) {
+      exportedPaths.push((packageJson as any)[field])
+    }
+  }
+
+  state.missingFiles = exportedPaths.filter((exportPath) => {
+    return !isPathIncluded(filesField, exportPath)
+  })
+
+  return state
+}
+
 export function lint(pkg: PackageMetadata) {
   const { name, main, exports } = pkg
   const isESM = isESModulePackage(pkg.type)
@@ -144,6 +195,17 @@ export function lint(pkg: PackageMetadata) {
     }
   }
 
+  const fieldState = validateFilesField(pkg)
+
+  if (!fieldState.definedField) {
+    logger.warn('Missing files field in package.json')
+  } else if (fieldState.missingFiles.length) {
+    logger.warn('Missing files in package.json')
+    fieldState.missingFiles.forEach((p) => {
+      logger.warn(`  ${p}`)
+    })
+  }
+
   if (state.badMainExtension) {
     logger.warn(
       'Cannot export `main` field with .mjs extension in CJS package, only .js extension is allowed',

src/types.ts

@@ -66,6 +66,7 @@ type PackageMetadata = {
   main?: string
   bin?: string | Record<string, string>
   module?: string
+  files?: string[]
   type?: 'commonjs' | 'module'
   dependencies?: Record<string, string>
   peerDependencies?: Record<string, string>

test/integration/cjs-pkg-esm-main-field/index.test.ts → test/integration/lint/cjs-pkg-esm-main-field/index.test.ts

@@ -1,9 +1,10 @@
-import { createIntegrationTest } from '../utils'
+import { createIntegrationTest } from '../../utils'
 
 describe('integration cjs-pkg-esm-main-field', () => {
   it('should warn if main field with .mjs extension in CJS package', async () => {
     await createIntegrationTest(
       {
+        args: ['lint'],
         directory: __dirname,
       },
       ({ stderr }) => {

test/integration/invalid-exports-cjs/index.test.ts → test/integration/lint/invalid-exports-cjs/index.test.ts

@@ -1,16 +1,13 @@
-import { assertFilesContent, createIntegrationTest } from '../utils'
+import { createIntegrationTest } from '../../utils'
 
 describe('integration invalid-exports-cjs', () => {
   it('should warn on invalid exports as CJS', async () => {
     await createIntegrationTest(
       {
+        args: ['lint'],
         directory: __dirname,
       },
-      async ({ stderr, distDir }) => {
-        assertFilesContent(distDir, {
-          './index.esm.js': 'export { index }',
-        })
-
+      async ({ stderr }) => {
         expect(stderr).toContain('Missing package name')
         expect(stderr).toContain(
           'Cannot export `require` field with .mjs extension in CJS package, only .cjs and .js extensions are allowed',

test/integration/invalid-exports-esm/index.test.ts → test/integration/lint/invalid-exports-esm/index.test.ts

@@ -1,9 +1,10 @@
-import { createIntegrationTest } from '../utils'
+import { createIntegrationTest } from '../../utils'
 
 describe('integration invalid-exports-esm', () => {
   it('should warn on invalid exports as ESM', async () => {
     await createIntegrationTest(
       {
+        args: ['lint'],
         directory: __dirname,
       },
       async ({ stderr }) => {

test/integration/lint/missing-files-exports/foo/index.js

@@ -0,0 +1,3 @@
+const foo = 'foo'
+
+exports.foo = foo

test/integration/lint/missing-files-exports/index.test.ts

@@ -0,0 +1,16 @@
+import { createIntegrationTest } from '../../utils'
+
+describe('integration - lint - missing-files-exports', () => {
+  it('should warn on missing files', async () => {
+    await createIntegrationTest(
+      {
+        args: ['lint'],
+        directory: __dirname,
+      },
+      async ({ stderr }) => {
+        expect(stderr).toContain('Missing files in package.json')
+        expect(stderr).toContain('foo/index.js')
+      },
+    )
+  })
+})

test/integration/lint/missing-files-exports/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "missing-files-exports",
+  "exports": {
+    ".": "./dist/index.js",
+    "./foo": "./foo/index.js"
+  },
+  "files": [
+    "dist"
+  ]
+}

test/integration/lint/missing-files-exports/src/foo.js

@@ -0,0 +1 @@
+export const foo = 'foo'

test/integration/lint/missing-files-exports/src/index.js

@@ -0,0 +1 @@
+export const index = 'index'

test/integration/lint/missing-files-main/index.js

@@ -0,0 +1,3 @@
+const index = 'index'
+
+exports.index = index

test/integration/lint/missing-files-main/index.test.ts

@@ -0,0 +1,16 @@
+import { createIntegrationTest } from '../../utils'
+
+describe('integration - lint - missing-files-main', () => {
+  it('should warn on missing files', async () => {
+    await createIntegrationTest(
+      {
+        args: ['lint'],
+        directory: __dirname,
+      },
+      async ({ stderr }) => {
+        expect(stderr).toContain('Missing files in package.json')
+        expect(stderr).toContain('index.js')
+      },
+    )
+  })
+})

test/integration/lint/missing-files-main/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "missing-files-main",
+  "main": "index.js",
+  "files": [
+    "dist"
+  ]
+}

test/integration/lint/missing-files-main/src/index.js

@@ -0,0 +1 @@
+export const index = 'index'

test/integration/single-entry/index.test.ts → test/integration/lint/single-entry/index.test.ts

@@ -2,8 +2,8 @@ import {
   assertContainFiles,
   assertFilesContent,
   stripANSIColor,
-} from '../../testing-utils'
-import { createIntegrationTest } from '../utils'
+} from '../../../testing-utils'
+import { createIntegrationTest } from '../../utils'
 
 describe('integration single-entry', () => {
   it('should warn on invalid exports as CJS', async () => {