feat: Indicate lack of support for missing "files" in package.jsons u…

…sed by linkable
ogre-works · Apr 24, 2023 · e0d14e6 · e0d14e6
1 parent c4e2db4
commit e0d14e6
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 0 deletions.
diff --git a/packages/linkable/src/create-links.injectable.ts b/packages/linkable/src/create-links.injectable.ts
@@ -4,6 +4,7 @@ import { getInjectable } from '@ogre-tools/injectable';
 import { createSymlinksInjectable } from './create-symlinks/create-symlinks.injectable';
 import getConfigInjectable from './config/get-config.injectable';
 import createEmptyConfigInjectable from './config/create-empty-config.injectable';
+import { PackageJsonAndPath } from './shared/package-json-and-path';
 
 export type CreateLinks = () => Promise<void>;
 
@@ -30,8 +31,26 @@ export const createLinksInjectable = getInjectable({
 
       const packageJsons = await getPackageJsons(config);
 
+      checkForMissingPropertyForFiles(packageJsons);
+
       await ensureEmptyLinkDirectories(packageJsons);
       await createSymlinks(packageJsons);
     };
   },
 });
+
+const checkForMissingPropertyForFiles = (
+  packageJsons: PackageJsonAndPath[],
+) => {
+  const bad = packageJsons
+    .filter(x => x.content.files === undefined)
+    .map(x => x.packageJsonPath);
+
+  if (bad.length) {
+    throw new Error(
+      `Tried create links of linkable, but some package.jsons didn't specify property "files": "${bad.join(
+        '", "',
+      )}"`,
+    );
+  }
+};
diff --git a/packages/linkable/src/linkable.test.ts b/packages/linkable/src/linkable.test.ts
@@ -260,6 +260,38 @@ describe('creation of "npm pack" -like symlinks', () => {
             });
           });
 
+          describe('given some of the packages do not specify "files", when all contents resolve', () => {
+            beforeEach(async () => {
+              existsMock.mockClear();
+
+              readJsonFileMock.resolveSpecific(
+                ([path]) => path === '/some-directory/some-module/package.json',
+                {
+                  files: undefined,
+                  name: '@some-scope/some-module',
+                  main: 'irrelevant',
+                },
+              );
+
+              readJsonFileMock.resolveSpecific(
+                ([path]) =>
+                  path ===
+                  '/some-other-directory/some-other-module/package.json',
+                {
+                  name: 'irrelevant',
+                  files: ['irrelevant'],
+                  main: 'irrelevant',
+                },
+              );
+            });
+
+            it('rejects entire script', () => {
+              return expect(actualPromise).rejects.toThrow(
+                'Tried create links of linkable, but some package.jsons didn\'t specify property "files": "/some-directory/some-module/package.json"',
+              );
+            });
+          });
+
           describe('given some of the packages have globs as files, when all contents resolve', () => {
             beforeEach(async () => {
               existsMock.mockClear();