refactor monorepo structure (#829)

bdehamer · web-flow · commit 3236bff9475d · 2024-12-31T11:05:13.000-08:00
Signed-off-by: Brian DeHamer &lt;bdehamer@github.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -3,5 +3,5 @@ node_modules
 coverage
 examples/client/targets
 examples/client/metadata
-tsconfig.tsbuildinfo
+tsconfig.build.tsbuildinfo
 *.code-workspace
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -17,7 +17,7 @@
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.10",
-    "@tsconfig/node16": "^16.1.3",
+    "@tsconfig/node18": "^18.2.4",
     "@types/jest": "^29.5.14",
     "@types/node": "^22.10.2",
     "@typescript-eslint/eslint-plugin": "^8.18.0",
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -19,7 +19,7 @@
     "provenance": true
   },
   "scripts": {
-    "clean": "shx rm -rf dist",
+    "clean": "shx rm -rf dist && shx rm tsconfig.build.tsbuildinfo",
     "prebuild": "npm run clean",
     "build": "tsc --build",
     "postpack": "shx rm -f oclif.manifest.json",
diff --git a/packages/cli/tsconfig.build.json b/packages/cli/tsconfig.build.json
@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src"],
+  "references": [
+    { "path": "../client/tsconfig.build.json" }
+  ]
+}
diff --git a/packages/cli/tsconfig.json b/packages/cli/tsconfig.json
@@ -1,11 +1,3 @@
 {
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist"
-  },
-  "exclude": ["./dist", "**/__tests__"],
-  "references": [
-    { "path": "../client" }
-  ]
+  "extends": "./tsconfig.json"
 }
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -5,8 +5,8 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "tsc --build",
-    "clean": "rm -rf dist && rm tsconfig.tsbuildinfo",
+    "build": "tsc --build tsconfig.build.json",
+    "clean": "rm -rf dist && rm tsconfig.build.tsbuildinfo",
     "test": "jest"
   },
   "repository": {
diff --git a/packages/client/tests/error.test.ts b/packages/client/tests/error.test.ts
@@ -1,4 +1,4 @@
-import * as error from '../error';
+import * as error from '../src/error';
 
 describe('Error Test', () => {
   describe('Value Error', () => {
diff --git a/packages/client/tests/fetcher.test.ts b/packages/client/tests/fetcher.test.ts
@@ -1,6 +1,6 @@
 import nock from 'nock';
-import { DownloadHTTPError, DownloadLengthMismatchError } from '../error';
-import { DefaultFetcher } from '../fetcher';
+import { DownloadHTTPError, DownloadLengthMismatchError } from '../src/error';
+import { DefaultFetcher } from '../src/fetcher';
 
 describe('Fetcher Test', () => {
   const baseURL = 'http://localhost:8080';
diff --git a/packages/client/tests/index.test.ts b/packages/client/tests/index.test.ts
@@ -1,4 +1,4 @@
-import * as tuf from '..';
+import * as tuf from '../src';
 
 it('exports classes', () => {
   expect(tuf.BaseFetcher).toBeInstanceOf(Function);
diff --git a/packages/client/tests/integration.test.ts b/packages/client/tests/integration.test.ts
@@ -4,7 +4,7 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 
-import { Updater } from '../index';
+import { Updater } from '../src/index';
 
 describe('Updater', () => {
   const baseURL = 'http://localhost:8080';
diff --git a/packages/client/tests/updater.test.ts b/packages/client/tests/updater.test.ts
@@ -4,7 +4,7 @@ import fs from 'fs';
 import nock from 'nock';
 import os from 'os';
 import path from 'path';
-import { Updater, UpdaterOptions } from '../updater';
+import { Updater, UpdaterOptions } from '../src/updater';
 
 describe('Updater', () => {
   const baseURL = 'http://localhost:8080';
diff --git a/packages/client/tests/utils/tmpfile.test.ts b/packages/client/tests/utils/tmpfile.test.ts
@@ -1,5 +1,5 @@
 import fs from 'fs/promises';
-import { withTempFile } from '../../utils/tmpfile';
+import { withTempFile } from '../../src/utils/tmpfile';
 
 describe('withTempFile', () => {
   it('creates a temporary file', async () => {
diff --git a/packages/client/tests/utils/url.ts b/packages/client/tests/utils/url.ts
@@ -1,4 +1,4 @@
-import * as url from '../../utils/url';
+import * as url from '../../src/utils/url';
 
 describe('url', () => {
   describe('join', () => {
diff --git a/packages/client/tsconfig.build.json b/packages/client/tsconfig.build.json
@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src"],
+  "references": [
+    { "path": "../models/tsconfig.build.json" },
+    { "path": "../repo-mock/tsconfig.build.json" }
+  ]
+}
diff --git a/packages/client/tsconfig.json b/packages/client/tsconfig.json
@@ -1,13 +1,12 @@
 {
-  "extends": "../../tsconfig.base.json",
+  "extends": "./tsconfig.build.json",
   "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist",
-    "composite": true
+    "composite": false,
+    "rootDir": "."
   },
-  "exclude": ["./dist", "**/__tests__"],
+  "include": ["src", "tests"],
   "references": [
-    { "path": "../models" },
-    { "path": "../repo-mock" }
+    { "path": "../models/tsconfig.build.json" },
+    { "path": "../repo-mock/tsconfig.build.json" }
   ]
 }
diff --git a/packages/models/package.json b/packages/models/package.json
@@ -8,8 +8,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsc --build",
-    "clean": "rm -rf dist && rm tsconfig.tsbuildinfo",
+    "build": "tsc --build tsconfig.build.json",
+    "clean": "rm -rf dist && rm tsconfig.build.tsbuildinfo",
     "test": "jest"
   },
   "repository": {
diff --git a/packages/models/tests/__fixtures__/role1.json b/packages/models/tests/__fixtures__/role1.json
diff --git a/packages/models/tests/__fixtures__/root.json b/packages/models/tests/__fixtures__/root.json
diff --git a/packages/models/tests/__fixtures__/snapshot.json b/packages/models/tests/__fixtures__/snapshot.json
diff --git a/packages/models/tests/__fixtures__/targets.json b/packages/models/tests/__fixtures__/targets.json
diff --git a/packages/models/tests/__fixtures__/timestamp.json b/packages/models/tests/__fixtures__/timestamp.json
diff --git a/packages/models/tests/base.test.ts b/packages/models/tests/base.test.ts
@@ -1,6 +1,6 @@
-import { isMetadataKind, Signed, SignedOptions } from '../base';
-import { ValueError } from '../error';
-import { JSONObject } from '../utils';
+import { isMetadataKind, Signed, SignedOptions } from '../src/base';
+import { ValueError } from '../src/error';
+import { JSONObject } from '../src/utils';
 
 describe('Signed', () => {
   class DummySigned extends Signed {
diff --git a/packages/models/tests/delegations.test.ts b/packages/models/tests/delegations.test.ts
@@ -1,7 +1,7 @@
-import { Delegations } from '../delegations';
-import { ValueError } from '../error';
-import { Key } from '../key';
-import { DelegatedRole, SuccinctRoles } from '../role';
+import { Delegations } from '../src/delegations';
+import { ValueError } from '../src/error';
+import { Key } from '../src/key';
+import { DelegatedRole, SuccinctRoles } from '../src/role';
 
 describe('Delegations', () => {
   const succinctRoleOpts = {
diff --git a/packages/models/tests/file.test.ts b/packages/models/tests/file.test.ts
@@ -1,6 +1,6 @@
 import { Readable } from 'stream';
-import { LengthOrHashMismatchError, ValueError } from '../error';
-import { MetaFile, TargetFile } from '../file';
+import { LengthOrHashMismatchError, ValueError } from '../src/error';
+import { MetaFile, TargetFile } from '../src/file';
 
 describe('MetaFile', () => {
   describe('constructor', () => {
diff --git a/packages/models/tests/key.test.ts b/packages/models/tests/key.test.ts
@@ -1,7 +1,7 @@
-import { Signed, SignedOptions } from '../base';
-import { UnsignedMetadataError } from '../error';
-import { Key } from '../key';
-import { Signature } from '../signature';
+import { Signed, SignedOptions } from '../src/base';
+import { UnsignedMetadataError } from '../src/error';
+import { Key } from '../src/key';
+import { Signature } from '../src/signature';
 
 describe('Key', () => {
   describe('constructor', () => {
diff --git a/packages/models/tests/metadata.test.ts b/packages/models/tests/metadata.test.ts
@@ -1,4 +1,10 @@
-import { Metadata, MetadataKind, Root, Signature, ValueError } from '../index';
+import {
+  Metadata,
+  MetadataKind,
+  Root,
+  Signature,
+  ValueError,
+} from '../src/index';
 
 describe('Metadata', () => {
   describe('#sign', () => {
diff --git a/packages/models/tests/role.test.ts b/packages/models/tests/role.test.ts
@@ -1,5 +1,5 @@
-import { ValueError } from '../error';
-import { DelegatedRole, Role } from '../role';
+import { ValueError } from '../src/error';
+import { DelegatedRole, Role } from '../src/role';
 
 describe('Role', () => {
   describe('constructor', () => {
diff --git a/packages/models/tests/root.test.ts b/packages/models/tests/root.test.ts
@@ -1,7 +1,7 @@
-import { ValueError } from '../error';
-import { Key } from '../key';
-import { Role } from '../role';
-import { Root, RootOptions } from '../root';
+import { ValueError } from '../src/error';
+import { Key } from '../src/key';
+import { Role } from '../src/role';
+import { Root, RootOptions } from '../src/root';
 
 describe('Root', () => {
   describe('constructor', () => {
diff --git a/packages/models/tests/signature.test.ts b/packages/models/tests/signature.test.ts
@@ -1,4 +1,4 @@
-import { Signature } from '../signature';
+import { Signature } from '../src/signature';
 
 describe('Signature', () => {
   describe('constructor', () => {
diff --git a/packages/models/tests/snapshot.test.ts b/packages/models/tests/snapshot.test.ts
@@ -1,5 +1,5 @@
-import { MetaFile } from '../file';
-import { Snapshot } from '../snapshot';
+import { MetaFile } from '../src/file';
+import { Snapshot } from '../src/snapshot';
 
 describe('Snapshot', () => {
   describe('constructor', () => {
diff --git a/packages/models/tests/succinct_roles.test.ts b/packages/models/tests/succinct_roles.test.ts
@@ -1,5 +1,5 @@
-import { ValueError } from '../error';
-import { SuccinctRoles } from '../role';
+import { ValueError } from '../src/error';
+import { SuccinctRoles } from '../src/role';
 
 describe('SuccinctRoles', () => {
   const opts = {
diff --git a/packages/models/tests/targets.test.ts b/packages/models/tests/targets.test.ts
@@ -1,6 +1,6 @@
-import { Delegations } from '../delegations';
-import { TargetFile } from '../file';
-import { Targets } from '../targets';
+import { Delegations } from '../src/delegations';
+import { TargetFile } from '../src/file';
+import { Targets } from '../src/targets';
 
 describe('Targets', () => {
   describe('constructor', () => {
diff --git a/packages/models/tests/timestamp.test.ts b/packages/models/tests/timestamp.test.ts
@@ -1,5 +1,5 @@
-import { MetaFile } from '../file';
-import { Timestamp } from '../timestamp';
+import { MetaFile } from '../src/file';
+import { Timestamp } from '../src/timestamp';
 
 describe('Timestamp', () => {
   describe('constructor', () => {
diff --git a/packages/models/tests/utils/guard.test.ts b/packages/models/tests/utils/guard.test.ts
@@ -4,7 +4,7 @@ import {
   isObjectRecord,
   isStringArray,
   isStringRecord,
-} from '../../utils/guard';
+} from '../../src/utils/guard';
 
 describe('isDefined', () => {
   describe('when the value is defined', () => {
diff --git a/packages/models/tests/utils/key.test.ts b/packages/models/tests/utils/key.test.ts
@@ -1,5 +1,5 @@
-import { UnsupportedAlgorithmError } from '../../error';
-import { getPublicKey } from '../../utils/key';
+import { UnsupportedAlgorithmError } from '../../src/error';
+import { getPublicKey } from '../../src/utils/key';
 
 describe('getPublicKey', () => {
   describe('when key is ed25519', () => {
diff --git a/packages/models/tests/utils/oid.test.ts b/packages/models/tests/utils/oid.test.ts
@@ -1,4 +1,4 @@
-import { encodeOIDString } from '../../utils/oid';
+import { encodeOIDString } from '../../src/utils/oid';
 
 describe('encodeOIDString', () => {
   const testCases = [
diff --git a/packages/models/tests/verify.test.ts b/packages/models/tests/verify.test.ts
@@ -1,4 +1,4 @@
-import { Metadata, MetadataKind, ValueError } from '../index';
+import { Metadata, MetadataKind, ValueError } from '../src/index';
 
 /* eslint-disable @typescript-eslint/no-require-imports */
 const rootJSON = require('./__fixtures__/root.json');
diff --git a/packages/models/tsconfig.build.json b/packages/models/tsconfig.build.json
@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src"]
+}
+
diff --git a/packages/models/tsconfig.json b/packages/models/tsconfig.json
@@ -1,9 +1,9 @@
 {
-  "extends": "../../tsconfig.base.json",
+  "extends": "./tsconfig.build.json",
   "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist",
-    "composite": true
+    "composite": false,
+    "rootDir": "."
   },
-  "exclude": ["./dist", "**/__tests__"]
+  "include": ["src", "tests"],
+  "exclude": ["tests/__fixtures__"]
 }
diff --git a/packages/repo-mock/package.json b/packages/repo-mock/package.json
@@ -8,8 +8,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsc --build",
-    "clean": "rm -rf dist && rm tsconfig.tsbuildinfo",
+    "build": "tsc --build tsconfig.build.json",
+    "clean": "rm -rf dist && rm tsconfig.build.tsbuildinfo",
     "test": "jest"
   },
   "repository": {
diff --git a/packages/repo-mock/tests/crypto.test.ts b/packages/repo-mock/tests/crypto.test.ts
@@ -1,4 +1,4 @@
-import { digestSHA256, generateKeyPair, signSHA256 } from '../crypto';
+import { digestSHA256, generateKeyPair, signSHA256 } from '../src/crypto';
 
 describe('crypto', () => {
   describe('digestSHA256', () => {
diff --git a/packages/repo-mock/tests/index.test.ts b/packages/repo-mock/tests/index.test.ts
@@ -1,7 +1,7 @@
 import { Metadata, MetadataKind } from '@tufjs/models';
 import fs from 'fs';
 import http from 'http';
-import tufmock, { clearMock, mockRepo } from '../index';
+import tufmock, { clearMock, mockRepo } from '../src/index';
 
 describe('mockRepo', () => {
   const baseURL = 'http://localhost:8000';
diff --git a/packages/repo-mock/tests/key.test.ts b/packages/repo-mock/tests/key.test.ts
diff --git a/packages/repo-mock/tests/metadata.test.ts b/packages/repo-mock/tests/metadata.test.ts
diff --git a/packages/repo-mock/tests/targets.test.ts b/packages/repo-mock/tests/targets.test.ts
diff --git a/packages/repo-mock/tsconfig.build.json b/packages/repo-mock/tsconfig.build.json
diff --git a/packages/repo-mock/tsconfig.json b/packages/repo-mock/tsconfig.json
diff --git a/tsconfig.base.json b/tsconfig.base.json
diff --git a/tsconfig.build.json b/tsconfig.build.json

Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,3 @@`
`1`	`1`	`{`
`2`		`- "extends": "../../tsconfig.base.json",`
`3`		`- "compilerOptions": {`
`4`		`- "rootDir": "src",`
`5`		`- "outDir": "dist"`
`6`		`- },`
`7`		`- "exclude": ["./dist", "**/__tests__"],`
`8`		`- "references": [`
`9`		`- { "path": "../client" }`
`10`		`- ]`
	`2`	`+ "extends": "./tsconfig.json"`
`11`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import * as error from '../error';`
	`1`	`+import * as error from '../src/error';`
`2`	`2`
`3`	`3`	`describe('Error Test', () => {`
`4`	`4`	`describe('Value Error', () => {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import * as tuf from '..';`
	`1`	`+import * as tuf from '../src';`
`2`	`2`
`3`	`3`	`it('exports classes', () => {`
`4`	`4`	`expect(tuf.BaseFetcher).toBeInstanceOf(Function);`