feat(commonality): Adds workspaces property to project configuration (

#284)

.changeset/silver-bees-bake.md

@@ -0,0 +1,7 @@
+---
+"@commonalityco/data-project": patch
+"@commonalityco/utils-core": patch
+"commonality": patch
+---
+
+Adds a `workspaces` property to the project configuration file. This will allow you to override your package manager's workspaces. This will also allow integrated monorepos to filter packages without adding a workspaces property to their package manager.

apps/commonality/src/define-config.ts

@@ -1,5 +1,5 @@
-import { ProjectConfig } from '@commonalityco/utils-core';
+import { ProjectConfigInput } from '@commonalityco/utils-core';
 
-export function defineConfig(config: ProjectConfig): ProjectConfig {
+export function defineConfig(config: ProjectConfigInput): ProjectConfigInput {
   return config;
 }

packages/data-constraints/src/get-constraint-results.ts

@@ -1,5 +1,5 @@
 import { Dependency, TagsData, ConstraintResult } from '@commonalityco/types';
-import { ProjectConfig } from '@commonalityco/utils-core';
+import { ProjectConfigOutput } from '@commonalityco/utils-core';
 
 const edgeKey = (dep: Dependency) => `${dep.source}|${dep.target}`;
 
@@ -108,7 +108,7 @@ export async function getConstraintResults({
   dependencies = [],
   tagsData = [],
 }: {
-  constraints?: ProjectConfig['constraints'];
+  constraints?: ProjectConfigOutput['constraints'];
   dependencies: Dependency[];
   tagsData: TagsData[];
 }): Promise<ConstraintResult[]> {

packages/data-project/package.json

@@ -30,8 +30,10 @@
     "@commonalityco/config-tsconfig": "workspace:*",
     "@commonalityco/types": "workspace:*",
     "@types/fs-extra": "^11.0.2",
+    "@types/mock-fs": "^4.13.4",
     "@types/node": "^20.10.0",
     "eslint-config-commonality": "workspace:*",
+    "mock-fs": "^5.2.0",
     "typescript": "^5.2.2"
   },
   "dependencies": {
@@ -48,4 +50,4 @@
     "url": "https://github.com/commonalityco/commonality",
     "directory": "packages/data-project"
   }
-}
+}

packages/data-project/src/get-project-config.ts

@@ -1,7 +1,10 @@
 import jiti from 'jiti';
 import { findUp } from 'find-up';
-import { ProjectConfig, projectConfigSchema } from '@commonalityco/utils-core';
-import { ZodError } from 'zod';
+import {
+  ProjectConfigOutput,
+  projectConfigSchema,
+} from '@commonalityco/utils-core';
+import z, { ZodError } from 'zod';
 
 const normalizeZodMessage = (error: unknown): string => {
   return (error as ZodError).issues
@@ -20,12 +23,14 @@ const normalizeZodMessage = (error: unknown): string => {
     .join('\n');
 };
 
-export const getValidatedProjectConfig = (config: unknown): ProjectConfig => {
+export const getValidatedProjectConfig = (
+  config: unknown,
+): ProjectConfigOutput => {
   return projectConfigSchema.parse(config);
 };
 
 export interface ProjectConfigData {
-  config: ProjectConfig | Record<string, never>;
+  config: ProjectConfigOutput | Record<string, never>;
   filepath: string;
   isEmpty?: boolean;
 }

packages/data-project/src/get-workspace-globs.ts

@@ -3,6 +3,7 @@ import fs from 'fs-extra';
 import { PackageJson } from '@commonalityco/types';
 import yaml from 'yaml';
 import { PackageManager } from '@commonalityco/utils-core';
+import { getProjectConfig } from './get-project-config';
 
 const defaultWorkspaceGlobs = ['./**'];
 
@@ -13,6 +14,15 @@ export const getWorkspaceGlobs = async ({
   rootDirectory: string;
   packageManager: PackageManager;
 }): Promise<string[]> => {
+  const projectConfig = await getProjectConfig({ rootDirectory });
+
+  if (
+    projectConfig?.config.workspaces &&
+    projectConfig.config.workspaces.length > 0
+  ) {
+    return projectConfig.config.workspaces;
+  }
+
   if (
     packageManager === PackageManager.NPM ||
     packageManager === PackageManager.BUN ||

packages/data-project/test/fixtures/empty-configuration/commonality.config.ts

@@ -0,0 +1,3 @@
+import { defineConfig } from 'commonality';
+
+export default defineConfig({});

packages/data-project/test/fixtures/empty-workspaces/commonality.config.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from 'commonality';
+
+export default defineConfig({
+  workspaces: [],
+});

packages/data-project/test/fixtures/explicit-workspaces/commonality.config.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from 'commonality';
+
+export default defineConfig({
+  workspaces: ['apps/**', 'packages/**'],
+});

packages/data-project/test/fixtures/npm-workspace/package.json

@@ -1,6 +1,6 @@
 {
   "workspaces": [
-    "./packages/**",
-    "./apps/**"
+    "apps/**",
+    "packages/**"
   ]
 }

packages/data-project/test/fixtures/pnpm-workspace/pnpm-workspace.yaml

@@ -1,3 +1,3 @@
 packages:
-  - './packages/**'
-  - './apps/**'
+  - 'apps/**'
+  - 'packages/**'

packages/data-project/test/fixtures/yarn-workspace/package.json

@@ -1,6 +1,6 @@
 {
   "workspaces": [
-    "./packages/**",
-    "./apps/**"
+    "apps/**",
+    "packages/**"
   ]
 }

packages/data-project/test/get-project-config.test.ts

@@ -7,8 +7,19 @@ import { describe, expect, it, test } from 'vitest';
 import { fileURLToPath } from 'node:url';
 
 describe('getValidatedProjectConfig', () => {
+  test('defaults missing properties', () => {
+    const config = getValidatedProjectConfig({});
+
+    expect(config).toEqual({
+      workspaces: [],
+      checks: {},
+      constraints: {},
+    });
+  });
+
   test('strips out invalid properties', () => {
     const config = getValidatedProjectConfig({
+      workspacees: 1,
       checks: {
         '*': [
           {
@@ -41,13 +52,15 @@ describe('getValidatedProjectConfig', () => {
     });
 
     expect(config).toEqual({
+      workspaces: [],
       checks: {
         '*': [
           {
             name: 'foo',
             validate: expect.any(Function),
             fix: expect.any(Function),
             message: 'foo',
+            level: 'warning',
           },
         ],
       },
@@ -86,6 +99,8 @@ describe('getProjectConfig', () => {
     });
   });
 
+  it('returns defaults when the configuration file is empty', () => {});
+
   describe('when run in an initialized project', () => {
     it('should return the parsed project config if the file exists and is valid', async () => {
       const rootDirectory = path.join(
@@ -100,6 +115,7 @@ describe('getProjectConfig', () => {
         isEmpty: false,
         filepath: expect.stringContaining('commonality.config.ts'),
         config: {
+          workspaces: [],
           checks: {},
           constraints: {
             '*': {

packages/data-project/test/get-workspace-globs.test.ts

@@ -1,88 +1,97 @@
 import { PackageManager } from '@commonalityco/utils-core';
 import path from 'node:path';
 import { getWorkspaceGlobs } from '../src/get-workspace-globs';
-import { describe, expect, it } from 'vitest';
+import { describe, expect, test } from 'vitest';
 import { fileURLToPath } from 'node:url';
 
 describe('getWorkspaceGlobs', () => {
-  describe('when run in an un-initialized project', () => {
-    it('returns the default globs', async () => {
-      const rootDirectory = path.join(
-        path.dirname(fileURLToPath(import.meta.url)),
-        './fixtures',
-        'uninitialized',
-      );
-
-      const config = await getWorkspaceGlobs({
-        rootDirectory,
-        packageManager: PackageManager.PNPM,
-      });
-
-      expect(config).toEqual(['./**']);
+  test('returns default globs when there is no package manager workspaces or explicit workspaces configured', async () => {
+    const rootDirectory = path.join(
+      path.dirname(fileURLToPath(import.meta.url)),
+      './fixtures',
+      'uninitialized',
+    );
+
+    const config = await getWorkspaceGlobs({
+      rootDirectory,
+      packageManager: PackageManager.NPM,
+    });
+
+    expect(config).toEqual(['./**']);
+  });
+
+  test('returns the workspaces when set via project configuration', async () => {
+    const rootDirectory = path.join(
+      path.dirname(fileURLToPath(import.meta.url)),
+      './fixtures',
+      'explicit-workspaces',
+    );
+
+    const workspaceGlobs = await getWorkspaceGlobs({
+      rootDirectory,
+      packageManager: PackageManager.PNPM,
+    });
+
+    expect(workspaceGlobs).toEqual(['apps/**', 'packages/**']);
+  });
+
+  test('returns the default globs when set to an empty array via project configuration', async () => {
+    const rootDirectory = path.join(
+      path.dirname(fileURLToPath(import.meta.url)),
+      './fixtures',
+      'empty-workspaces',
+    );
+
+    const workspaceGlobs = await getWorkspaceGlobs({
+      rootDirectory,
+      packageManager: PackageManager.PNPM,
     });
+
+    expect(workspaceGlobs).toEqual(['./**']);
   });
 
-  describe('when run in an initialized project', () => {
-    describe('when the workspace option exists', () => {
-      const expectedWorkspaceGlobs = ['./packages/**', './apps/**'];
-
-      it(`should return the correct globs for an NPM workspace`, async () => {
-        const rootDirectory = path.join(
-          path.dirname(fileURLToPath(import.meta.url)),
-          './fixtures',
-          'npm-workspace',
-        );
-        const workspaceGlobs = await getWorkspaceGlobs({
-          rootDirectory,
-          packageManager: PackageManager.NPM,
-        });
-
-        expect(workspaceGlobs).toEqual(expectedWorkspaceGlobs);
-      });
-
-      it(`should return the correct globs for a Yarn workspace`, async () => {
-        const rootDirectory = path.join(
-          path.dirname(fileURLToPath(import.meta.url)),
-          './fixtures',
-          'yarn-workspace',
-        );
-        const workspaceGlobs = await getWorkspaceGlobs({
-          rootDirectory,
-          packageManager: PackageManager.YARN,
-        });
-
-        expect(workspaceGlobs).toEqual(expectedWorkspaceGlobs);
-      });
-
-      it(`should return the correct globs for a pnpm workspace`, async () => {
-        const rootDirectory = path.join(
-          path.dirname(fileURLToPath(import.meta.url)),
-          './fixtures',
-          'pnpm-workspace',
-        );
-        const workspaceGlobs = await getWorkspaceGlobs({
-          rootDirectory,
-          packageManager: PackageManager.PNPM,
-        });
-
-        expect(workspaceGlobs).toEqual(expectedWorkspaceGlobs);
-      });
+  test('returns the workspaces when set with npm', async () => {
+    const rootDirectory = path.join(
+      path.dirname(fileURLToPath(import.meta.url)),
+      './fixtures',
+      'npm-workspace',
+    );
+
+    const workspaceGlobs = await getWorkspaceGlobs({
+      rootDirectory,
+      packageManager: PackageManager.NPM,
     });
 
-    describe('when the workspace option does not exist', () => {
-      it(`should return the default globs`, async () => {
-        const rootDirectory = path.join(
-          path.dirname(fileURLToPath(import.meta.url)),
-          './fixtures',
-          'missing-workspace-globs',
-        );
-        const workspaceGlobs = await getWorkspaceGlobs({
-          rootDirectory,
-          packageManager: PackageManager.PNPM,
-        });
-
-        expect(workspaceGlobs).toEqual(['./**']);
-      });
+    expect(workspaceGlobs).toEqual(['apps/**', 'packages/**']);
+  });
+
+  test('returns the workspaces when set with yarn', async () => {
+    const rootDirectory = path.join(
+      path.dirname(fileURLToPath(import.meta.url)),
+      './fixtures',
+      'yarn-workspace',
+    );
+
+    const workspaceGlobs = await getWorkspaceGlobs({
+      rootDirectory,
+      packageManager: PackageManager.YARN,
     });
+
+    expect(workspaceGlobs).toEqual(['apps/**', 'packages/**']);
+  });
+
+  test('returns the workspaces when set with pnpm', async () => {
+    const rootDirectory = path.join(
+      path.dirname(fileURLToPath(import.meta.url)),
+      './fixtures',
+      'pnpm-workspace',
+    );
+
+    const workspaceGlobs = await getWorkspaceGlobs({
+      rootDirectory,
+      packageManager: PackageManager.PNPM,
+    });
+
+    expect(workspaceGlobs).toEqual(['apps/**', 'packages/**']);
   });
 });

packages/ui-constraints/src/feature-graph-chart.tsx

@@ -8,12 +8,12 @@ import FeatureGraphToolbar from './feature-graph-toolbar';
 import { cn } from '@commonalityco/ui-design-system/cn';
 import debounce from 'lodash-es/debounce';
 import { getElementDefinitions } from '@commonalityco/ui-graph';
-import { ProjectConfig } from '@commonalityco/utils-core';
+import { ProjectConfigOutput } from '@commonalityco/utils-core';
 
 interface GraphProperties {
   packages: Package[];
   results: ConstraintResult[];
-  constraints: ProjectConfig['constraints'];
+  constraints: ProjectConfigOutput['constraints'];
   dependencies: Dependency[];
   theme?: string;
   onPackageClick: (packageName: string) => void;