Skip to content

Commit 1598453

Browse files
FedeZaraFedeZara
committed
chore(cli): migrate @fern-api/cli-migrations to use CliError
1 parent d5c8fd0 commit 1598453

36 files changed

Lines changed: 219 additions & 113 deletions

File tree

‎packages/cli/cli-migrations/src/migrations/0.0.191/discriminant/getAllYamlFiles.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { AbsoluteFilePath } from "@fern-api/fs-utils";
2-
import { TaskContext } from "@fern-api/task-context";
2+
import { CliError, TaskContext } from "@fern-api/task-context";
33
import { findUp } from "find-up";
44
import { glob } from "glob";
55

@@ -9,7 +9,9 @@ export async function getAllYamlFiles(context: TaskContext): Promise<AbsoluteFil
99
const fernDirectory = await getFernDirectory();
1010
const alphasort = (a: string, b: string) => a.localeCompare(b, "en");
1111
if (fernDirectory == null) {
12-
context.failAndThrow(`Directory "${FERN_DIRECTORY}" not found.`);
12+
context.failAndThrow(`Directory "${FERN_DIRECTORY}" not found.`, undefined, {
13+
code: CliError.Code.ConfigError
14+
});
1315
}
1416
const filepaths = await glob("*/definition/**/*.yml", {
1517
cwd: fernDirectory,

‎packages/cli/cli-migrations/src/migrations/0.0.191/discriminant/migration.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { AbsoluteFilePath } from "@fern-api/fs-utils";
2+
import { CliError } from "@fern-api/task-context";
23
import { readFile, writeFile } from "fs/promises";
34

45
import { Migration } from "../../../types/Migration.js";
@@ -15,7 +16,7 @@ export const migration: Migration = {
1516
const newContents = addDiscriminantToFile(fileContents);
1617
await writeFile(yamlFilepath, newContents);
1718
} catch (error) {
18-
context.failAndThrow("Failed to migrate " + yamlFilepath, error);
19+
context.failAndThrow("Failed to migrate " + yamlFilepath, error, { code: CliError.Code.ParseError });
1920
}
2021
}
2122
}

‎packages/cli/cli-migrations/src/migrations/0.0.203/union-single-property-key/getAllYamlFiles.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { AbsoluteFilePath } from "@fern-api/fs-utils";
2-
import { TaskContext } from "@fern-api/task-context";
2+
import { CliError, TaskContext } from "@fern-api/task-context";
33
import { findUp } from "find-up";
44
import { glob } from "glob";
55

@@ -9,7 +9,9 @@ export async function getAllYamlFiles(context: TaskContext): Promise<AbsoluteFil
99
const fernDirectory = await getFernDirectory();
1010
const alphasort = (a: string, b: string) => a.localeCompare(b, "en");
1111
if (fernDirectory == null) {
12-
context.failAndThrow(`Directory "${FERN_DIRECTORY}" not found.`);
12+
context.failAndThrow(`Directory "${FERN_DIRECTORY}" not found.`, undefined, {
13+
code: CliError.Code.ConfigError
14+
});
1315
}
1416
const filepaths = await glob("*/definition/**/*.yml", {
1517
cwd: fernDirectory,

‎packages/cli/cli-migrations/src/migrations/0.0.203/union-single-property-key/migration.ts‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { AbsoluteFilePath } from "@fern-api/fs-utils";
2-
import { TaskContext } from "@fern-api/task-context";
2+
import { CliError, TaskContext } from "@fern-api/task-context";
33
import { readFile, writeFile } from "fs/promises";
44
import YAML from "yaml";
55

@@ -15,7 +15,9 @@ export const migration: Migration = {
1515
try {
1616
await migrateFile(filepath, context);
1717
} catch (error) {
18-
context.failWithoutThrowing(`Failed to add 'key' property to union in ${filepath}`, error);
18+
context.failWithoutThrowing(`Failed to add 'key' property to union in ${filepath}`, error, {
19+
code: CliError.Code.ParseError
20+
});
1921
}
2022
}
2123
}
@@ -29,7 +31,9 @@ async function migrateFile(filepath: AbsoluteFilePath, context: TaskContext): Pr
2931
return;
3032
}
3133
if (!YAML.isMap(types)) {
32-
context.failWithoutThrowing(`"types" is not a map in ${filepath}`);
34+
context.failWithoutThrowing(`"types" is not a map in ${filepath}`, undefined, {
35+
code: CliError.Code.ParseError
36+
});
3337
return;
3438
}
3539

@@ -40,7 +44,9 @@ async function migrateFile(filepath: AbsoluteFilePath, context: TaskContext): Pr
4044
continue;
4145
}
4246
if (!YAML.isMap(union)) {
43-
context.failWithoutThrowing(`"union" is not a map in ${filepath}`);
47+
context.failWithoutThrowing(`"union" is not a map in ${filepath}`, undefined, {
48+
code: CliError.Code.ParseError
49+
});
4450
continue;
4551
}
4652
for (const singleUnionType of union.items) {

‎packages/cli/cli-migrations/src/migrations/0.0.207/add-mode-to-draft-generators/getAllGeneratorYamlFiles.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { AbsoluteFilePath } from "@fern-api/fs-utils";
2-
import { TaskContext } from "@fern-api/task-context";
2+
import { CliError, TaskContext } from "@fern-api/task-context";
33
import { findUp } from "find-up";
44
import { glob } from "glob";
55

@@ -9,7 +9,9 @@ export async function getAllGeneratorYamlFiles(context: TaskContext): Promise<Ab
99
const fernDirectory = await getFernDirectory();
1010
const alphasort = (a: string, b: string) => a.localeCompare(b, "en");
1111
if (fernDirectory == null) {
12-
context.failAndThrow(`Directory "${FERN_DIRECTORY}" not found.`);
12+
context.failAndThrow(`Directory "${FERN_DIRECTORY}" not found.`, undefined, {
13+
code: CliError.Code.ConfigError
14+
});
1315
}
1416
const filepaths = await glob("*/generators.yml", {
1517
cwd: fernDirectory,

‎packages/cli/cli-migrations/src/migrations/0.0.207/add-mode-to-draft-generators/migration.ts‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { AbsoluteFilePath } from "@fern-api/fs-utils";
2-
import { TaskContext } from "@fern-api/task-context";
2+
import { CliError, TaskContext } from "@fern-api/task-context";
33
import { readFile, writeFile } from "fs/promises";
44
import YAML from "yaml";
55

@@ -15,7 +15,7 @@ export const migration: Migration = {
1515
try {
1616
await migrateGeneratorsYml(filepath, context);
1717
} catch (error) {
18-
context.failWithoutThrowing(`Failed to migrate ${filepath}`, error);
18+
context.failWithoutThrowing(`Failed to migrate ${filepath}`, error, { code: CliError.Code.ParseError });
1919
}
2020
}
2121
}
@@ -29,17 +29,23 @@ async function migrateGeneratorsYml(filepath: AbsoluteFilePath, context: TaskCon
2929
return;
3030
}
3131
if (!YAML.isSeq(draftGenerators)) {
32-
context.failWithoutThrowing(`draft generators are not a list in ${filepath}`);
32+
context.failWithoutThrowing(`draft generators are not a list in ${filepath}`, undefined, {
33+
code: CliError.Code.ParseError
34+
});
3335
return;
3436
}
3537
draftGenerators.items.forEach((draftGenerator) => {
3638
if (!YAML.isMap(draftGenerator)) {
37-
context.failWithoutThrowing(`draft generator is not an object in ${filepath}`);
39+
context.failWithoutThrowing(`draft generator is not an object in ${filepath}`, undefined, {
40+
code: CliError.Code.ParseError
41+
});
3842
return;
3943
}
4044
const name = draftGenerator.get("name", true);
4145
if (typeof name?.value !== "string") {
42-
context.failWithoutThrowing(`draft generator didn't have name in ${filepath}`);
46+
context.failWithoutThrowing(`draft generator didn't have name in ${filepath}`, undefined, {
47+
code: CliError.Code.ParseError
48+
});
4349
return;
4450
}
4551
const localOutput = draftGenerator.get("local-output");

‎packages/cli/cli-migrations/src/migrations/0.0.210/remove-inline-error-declarations/getAllYamlFiles.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { AbsoluteFilePath } from "@fern-api/fs-utils";
2-
import { TaskContext } from "@fern-api/task-context";
2+
import { CliError, TaskContext } from "@fern-api/task-context";
33
import { findUp } from "find-up";
44
import { glob } from "glob";
55

@@ -9,7 +9,9 @@ export async function getAllYamlFiles(context: TaskContext): Promise<AbsoluteFil
99
const fernDirectory = await getFernDirectory();
1010
const alphasort = (a: string, b: string) => a.localeCompare(b, "en");
1111
if (fernDirectory == null) {
12-
return context.failAndThrow(`Directory "${FERN_DIRECTORY}" not found.`);
12+
return context.failAndThrow(`Directory "${FERN_DIRECTORY}" not found.`, undefined, {
13+
code: CliError.Code.ConfigError
14+
});
1315
}
1416
const filepaths = await glob("*/definition/**/*.yml", {
1517
cwd: fernDirectory,

‎packages/cli/cli-migrations/src/migrations/0.0.210/remove-inline-error-declarations/migration.ts‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { AbsoluteFilePath } from "@fern-api/fs-utils";
2-
import { TaskContext } from "@fern-api/task-context";
2+
import { CliError, TaskContext } from "@fern-api/task-context";
33
import { readFile, writeFile } from "fs/promises";
44
import YAML from "yaml";
55

@@ -15,7 +15,9 @@ export const migration: Migration = {
1515
try {
1616
await migrateFile(filepath, context);
1717
} catch (error) {
18-
context.failWithoutThrowing(`Failed to add 'key' property to union in ${filepath}`, error);
18+
context.failWithoutThrowing(`Failed to add 'key' property to union in ${filepath}`, error, {
19+
code: CliError.Code.ParseError
20+
});
1921
}
2022
}
2123
}
@@ -32,7 +34,9 @@ async function migrateFile(filepath: AbsoluteFilePath, context: TaskContext): Pr
3234
[typeName]: typeDeclaration
3335
});
3436
} else if (!YAML.isMap(types)) {
35-
context.failWithoutThrowing(`"types" is not a map in ${filepath}`);
37+
context.failWithoutThrowing(`"types" is not a map in ${filepath}`, undefined, {
38+
code: CliError.Code.ParseError
39+
});
3640
} else {
3741
types.set(typeName, typeDeclaration);
3842
}
@@ -44,13 +48,17 @@ async function migrateFile(filepath: AbsoluteFilePath, context: TaskContext): Pr
4448
}
4549

4650
if (!YAML.isMap(errors)) {
47-
context.failWithoutThrowing(`"errors" is not a map in ${filepath}`);
51+
context.failWithoutThrowing(`"errors" is not a map in ${filepath}`, undefined, {
52+
code: CliError.Code.ParseError
53+
});
4854
return;
4955
}
5056

5157
for (const errorDeclaration of errors.items) {
5258
if (!YAML.isMap(errorDeclaration.value)) {
53-
context.failWithoutThrowing(`Error "${errorDeclaration.key}" is not a map in ${filepath}`);
59+
context.failWithoutThrowing(`Error "${errorDeclaration.key}" is not a map in ${filepath}`, undefined, {
60+
code: CliError.Code.ParseError
61+
});
5462
continue;
5563
}
5664

@@ -66,7 +74,11 @@ async function migrateFile(filepath: AbsoluteFilePath, context: TaskContext): Pr
6674
const httpSection = errorDeclaration.value.get("http");
6775
if (httpSection != null) {
6876
if (!YAML.isMap(httpSection)) {
69-
context.failWithoutThrowing(`http in "${errorDeclaration.key}" is not a map in ${filepath}`);
77+
context.failWithoutThrowing(
78+
`http in "${errorDeclaration.key}" is not a map in ${filepath}`,
79+
undefined,
80+
{ code: CliError.Code.ParseError }
81+
);
7082
} else {
7183
const statusCode = httpSection.get("statusCode", true);
7284
errorDeclaration.value.delete("http");

‎packages/cli/cli-migrations/src/migrations/0.0.212/add-publishing-to-release-generators/getAllGeneratorYamlFiles.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { AbsoluteFilePath } from "@fern-api/fs-utils";
2-
import { TaskContext } from "@fern-api/task-context";
2+
import { CliError, TaskContext } from "@fern-api/task-context";
33
import { findUp } from "find-up";
44
import { glob } from "glob";
55

@@ -9,7 +9,9 @@ export async function getAllGeneratorYamlFiles(context: TaskContext): Promise<Ab
99
const fernDirectory = await getFernDirectory();
1010
const alphasort = (a: string, b: string) => a.localeCompare(b, "en");
1111
if (fernDirectory == null) {
12-
return context.failAndThrow(`Directory "${FERN_DIRECTORY}" not found.`);
12+
return context.failAndThrow(`Directory "${FERN_DIRECTORY}" not found.`, undefined, {
13+
code: CliError.Code.ConfigError
14+
});
1315
}
1416
const filepaths = await glob("*/generators.yml", {
1517
cwd: fernDirectory,

‎packages/cli/cli-migrations/src/migrations/0.0.212/add-publishing-to-release-generators/migration.ts‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { AbsoluteFilePath } from "@fern-api/fs-utils";
2-
import { TaskContext } from "@fern-api/task-context";
2+
import { CliError, TaskContext } from "@fern-api/task-context";
33
import { readFile, writeFile } from "fs/promises";
44
import YAML from "yaml";
55

@@ -15,7 +15,7 @@ export const migration: Migration = {
1515
try {
1616
await migrateGeneratorsYml(filepath, context);
1717
} catch (error) {
18-
context.failWithoutThrowing(`Failed to migrate ${filepath}`, error);
18+
context.failWithoutThrowing(`Failed to migrate ${filepath}`, error, { code: CliError.Code.ParseError });
1919
}
2020
}
2121
}
@@ -29,17 +29,23 @@ async function migrateGeneratorsYml(filepath: AbsoluteFilePath, context: TaskCon
2929
return;
3030
}
3131
if (!YAML.isSeq(releaseGenerators)) {
32-
context.failWithoutThrowing(`release generators are not a list in ${filepath}`);
32+
context.failWithoutThrowing(`release generators are not a list in ${filepath}`, undefined, {
33+
code: CliError.Code.ParseError
34+
});
3335
return;
3436
}
3537
releaseGenerators.items.forEach((releaseGenerator) => {
3638
if (!YAML.isMap(releaseGenerator)) {
37-
context.failWithoutThrowing(`release generator is not an object in ${filepath}`);
39+
context.failWithoutThrowing(`release generator is not an object in ${filepath}`, undefined, {
40+
code: CliError.Code.ParseError
41+
});
3842
return;
3943
}
4044
const outputs = releaseGenerator.get("outputs");
4145
if (!YAML.isMap(outputs)) {
42-
context.failWithoutThrowing(`outputs is not an object in ${filepath}`);
46+
context.failWithoutThrowing(`outputs is not an object in ${filepath}`, undefined, {
47+
code: CliError.Code.ParseError
48+
});
4349
return;
4450
}
4551

0 commit comments

Comments
 (0)