Merge pull request #44 from webdeveric/dev

Added `--dev-condition`

Author: webdeveric

package.json

@@ -32,7 +32,7 @@
   "engines": {
     "node": ">=20.17.0"
   },
-  "packageManager": "pnpm@10.31.0+sha512.e3927388bfaa8078ceb79b748ffc1e8274e84d75163e67bc22e06c0d3aed43dd153151cbf11d7f8301ff4acb98c68bdc5cadf6989532801ffafe3b3e4a63c268",
+  "packageManager": "pnpm@10.32.0+sha512.9b2634bb3fed5601c33633f2d92593f506270a3963b8c51d2b2d6a828da615ce4e9deebef9614ccebbc13ac8d3c0f9c9ccceb583c69c8578436fa477dbb20d70",
   "scripts": {
     "prevalidate": "pnpm build:dev",
     "validate": "./dist/cli.mjs",

pnpm-lock.yaml

@@ -24,6 +24,7 @@ yarn add validate-package-exports -D
 | --- | --- | --- |
 | `--check` / `-s` | Check syntax of JS files | `false` |
 | `--concurrency` / `-c` | Concurrency | `availableParallelism()` |
+| `--dev-condition` | Custom condition name only used during dev | none |
 | `--bail` / `-b` | Stop after the first error | `process.env.CI === 'true'` |
 | `--no-bail` | Turn off `--bail` | `false` |
 | `--info` / `-i` | Show `info` messages.<br>The default behavior is to only show `error`. | `process.env.RUNNER_DEBUG === '1'` |
@@ -59,6 +60,18 @@ OR
 }
 ```
 
+#### Dev Condition
+
+If you use a [`customCondition` in your `tsconfig.json`](https://www.typescriptlang.org/tsconfig/#customConditions), like when using [Nx](https://nx.dev/docs/technologies/test-tools/vitest/guides/testing-without-building-dependencies#step-1-add-customconditions-to-tsconfigbasejson), you can use the `--dev-condition` flag so that those entry points are skipped when validating which files are packed.
+
+```json
+{
+  "scripts": {
+    "prepublishOnly": "validate-package-exports --check --info --dev-condition @example/monorepo"
+  }
+}
+```
+
 ### Using `npx`
 
 ```shell

readme.md

@@ -157,6 +157,12 @@ export class Validator extends EventEmitter {
     const files = new Set(await getPacklist(packageContext.directory));
 
     const results: Result[] = await Readable.from(unique(entryPoints, (entryPoint) => entryPoint.relativePath))
+      // Remove entry points that are matching a dev condition.
+      // The assumption is that files for dev conditions will not be packed.
+      .filter(
+        (entryPoint: EntryPoint) =>
+          !(entryPoint.condition !== undefined && this.options.devCondition.includes(entryPoint.condition)),
+      )
       .map(
         (entryPoint): Result => {
           const willBePacked = files.has(entryPoint.relativePath);

src/lib/Validator.ts

@@ -36,15 +36,16 @@ export const logLevelMapping = {
 } as const satisfies Record<LogLevelName, LogLevel>;
 
 export type CliArguments = {
-  packages: string[];
   bail: boolean;
   check: boolean;
   concurrency: number;
-  json: boolean;
+  devCondition: string[];
   info: boolean;
+  json: boolean;
+  packages: string[];
 };
 
-export type ValidatorOptions = Pick<CliArguments, 'bail' | 'check' | 'concurrency'> & {
+export type ValidatorOptions = Omit<CliArguments, 'json' | 'info' | 'packages'> & {
   package: PackageJsonPath;
   controller: AbortController;
 };

src/types.ts

@@ -11,9 +11,10 @@ describe('getCliArguments()', () => {
     expect(getCliArguments([])).toEqual({
       bail: process.env.CI === 'true',
       check: false,
+      concurrency: availableParallelism(),
+      devCondition: [],
       info: process.env.RUNNER_DEBUG === '1',
       json: false,
-      concurrency: availableParallelism(),
       packages: ['./package.json'],
     } satisfies CliArguments);
 
@@ -22,9 +23,10 @@ describe('getCliArguments()', () => {
     ).toEqual({
       bail: true,
       check: true,
+      concurrency: 1,
+      devCondition: [],
       info: true,
       json: true,
-      concurrency: 1,
       packages: ['./some-path/package.json'],
     } satisfies CliArguments);
 
@@ -41,6 +43,54 @@ describe('getCliArguments()', () => {
     );
   });
 
+  it('--dev-condition flag', () => {
+    // Single value
+    expect(getCliArguments(['--dev-condition', '@webdeveric/example'])).toEqual({
+      bail: process.env.CI === 'true',
+      check: false,
+      concurrency: availableParallelism(),
+      devCondition: ['@webdeveric/example'],
+      info: process.env.RUNNER_DEBUG === '1',
+      json: false,
+      packages: ['./package.json'],
+    } satisfies CliArguments);
+
+    // Multiple values
+    expect(
+      getCliArguments(['--dev-condition', '@webdeveric/example1', '--dev-condition', '@webdeveric/example2']),
+    ).toEqual({
+      bail: process.env.CI === 'true',
+      check: false,
+      concurrency: availableParallelism(),
+      devCondition: ['@webdeveric/example1', '@webdeveric/example2'],
+      info: process.env.RUNNER_DEBUG === '1',
+      json: false,
+      packages: ['./package.json'],
+    } satisfies CliArguments);
+
+    // CSV string
+    expect(getCliArguments(['--dev-condition', '@webdeveric/example1,@webdeveric/example2'])).toEqual({
+      bail: process.env.CI === 'true',
+      check: false,
+      concurrency: availableParallelism(),
+      devCondition: ['@webdeveric/example1', '@webdeveric/example2'],
+      info: process.env.RUNNER_DEBUG === '1',
+      json: false,
+      packages: ['./package.json'],
+    } satisfies CliArguments);
+
+    // CSV string with whitespace padding
+    expect(getCliArguments(['--dev-condition', ' @webdeveric/example1 , @webdeveric/example2 '])).toEqual({
+      bail: process.env.CI === 'true',
+      check: false,
+      concurrency: availableParallelism(),
+      devCondition: ['@webdeveric/example1', '@webdeveric/example2'],
+      info: process.env.RUNNER_DEBUG === '1',
+      json: false,
+      packages: ['./package.json'],
+    } satisfies CliArguments);
+  });
+
   it('Throws when given incorrect arguments', () => {
     expect(() => {
       getCliArguments(['--not-a-real-flag']);

src/utils/getCliArguments.test.ts

@@ -12,10 +12,17 @@ export function getCliArguments(args?: NodeJS.Process['argv']): CliArguments {
     strict: true,
     tokens: false,
     options: {
+      // This value is used in `Readable` options.
       concurrency: {
         type: 'string',
         short: 'c',
       },
+      // Specify which custom conditions are used only during development.
+      'dev-condition': {
+        type: 'string',
+        multiple: true,
+        default: [],
+      },
       // Stop processing at the first error.
       bail: {
         type: 'boolean',
@@ -30,7 +37,7 @@ export function getCliArguments(args?: NodeJS.Process['argv']): CliArguments {
         short: 's',
       },
       /**
-       * @deprecated This is done automatically and this flag will be removed in the next version.
+       * @deprecated This is done automatically and this flag will be removed in the next major version.
        */
       verify: {
         type: 'boolean',
@@ -74,13 +81,17 @@ export function getCliArguments(args?: NodeJS.Process['argv']): CliArguments {
 
   const noBail = values['no-bail'] ?? config.options['no-bail'].default;
   const noInfo = values['no-info'] ?? config.options['no-info'].default;
+  const devCondition = values['dev-condition'] ?? config.options['dev-condition'].default;
 
   return {
-    packages: positionals.length ? positionals : ['./package.json'],
-    concurrency: parseConcurrency(values.concurrency),
     bail: noBail ? false : (values.bail ?? config.options.bail.default),
     check: values.check ?? config.options.check.default,
-    json: values.json ?? false,
+    concurrency: parseConcurrency(values.concurrency),
+    devCondition: devCondition.flatMap((item) => {
+      return item.split(',').map((singleDevCondition) => singleDevCondition.trim());
+    }),
     info: noInfo ? false : (values.info ?? config.options.info.default),
+    json: values.json ?? false,
+    packages: positionals.length ? positionals : ['./package.json'],
   };
 }