Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(cli): introduce validation-utils package to reduce duplicated code #5651

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/cli/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
"@fern-api/task-context": "workspace:*",
"@fern-api/venus-api-sdk": "0.10.2",
"@fern-api/workspace-loader": "workspace:*",
"@fern-api/validation-utils": "workspace:*",
"@fern-fern/fiddle-sdk": "0.0.584",
"@fern-fern/generators-sdk": "0.114.0-5745f9e74",
"@fern-typescript/fetcher": "workspace:*",
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/cli/src/commands/validate/logViolations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ import chalk from "chalk";

import { formatLog } from "@fern-api/cli-logger";
import { assertNever } from "@fern-api/core-utils";
import { NodePath } from "@fern-api/fern-definition-schema";
import { ValidationViolation } from "@fern-api/fern-definition-validator";
import { LogLevel } from "@fern-api/logger";
import { TaskContext } from "@fern-api/task-context";
import { NodePath } from "@fern-api/validation-utils";

export interface LogViolationsResponse {
hasErrors: boolean;
Expand Down
10 changes: 5 additions & 5 deletions packages/cli/fern-definition/schema/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
export { EXAMPLE_REFERENCE_PREFIX, YAML_SCHEMA_VERSION } from "./constants";
export { type NodePath, type NodePathItem } from "./NodePath";
export * as RawSchemas from "./schemas";
export { type DefinitionFileSchema, type RootApiFileSchema, type PackageMarkerFileSchema } from "./schemas";
export * from "./utils/generics";
export { type DefinitionFileSchema, type PackageMarkerFileSchema, type RootApiFileSchema } from "./schemas/api";
export * from "./utils/auth";
export * from "./utils/generics";
export { getRequestBody } from "./utils/getRequestBody";
export { HttpEndpointReferenceParser } from "./utils/HttpEndpointReferenceParser";
export { isInlineRequestBody } from "./utils/isInlineRequestBody";
export { isRawProtobufSourceSchema } from "./utils/isRawProtobufSourceSchema";
export { isOpenApiSourceSchema } from "./utils/isOpenApiSourceSchema";
export { isRawProtobufSourceSchema } from "./utils/isRawProtobufSourceSchema";
export { isRawTextType } from "./utils/isRawTextType";
export { parseBytesRequest, type BytesRequest } from "./utils/parseBytesRequest";
export { parseFileUploadRequest, type RawFileUploadRequest } from "./utils/parseFileUploadRequest";
Expand Down Expand Up @@ -44,4 +44,4 @@ export {
type RawTypeDeclarationVisitor
} from "./utils/visitRawTypeDeclaration";
export { FernContainerRegex, visitRawTypeReference } from "./utils/visitRawTypeReference";
export { HttpEndpointReferenceParser } from "./utils/HttpEndpointReferenceParser";

1 change: 1 addition & 0 deletions packages/cli/fern-definition/validator/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"@fern-api/lazy-fern-workspace": "workspace:*",
"@fern-api/logger": "workspace:*",
"@fern-api/task-context": "workspace:*",
"@fern-api/validation-utils": "workspace:*",
"chalk": "^5.3.0",
"lodash-es": "^4.17.21",
"strip-ansi": "^7.1.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { LazyFernWorkspace } from "@fern-api/lazy-fern-workspace";
import { CONSOLE_LOGGER } from "@fern-api/logger";
import { createMockTaskContext } from "@fern-api/task-context";

import { ValidationViolation } from "../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { validateFernWorkspace } from "../../validateFernWorkspace";

interface Fixture {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { Values } from "@fern-api/core-utils";
import { NodePath, RawSchemas } from "@fern-api/fern-definition-schema";
import { RawSchemas } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

export type DefinitionFileAstVisitor<R = void | void> = {
[K in keyof DefinitionFileAstNodeTypes]: DefinitionFileAstNodeVisitor<K, R>;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { NodePath } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

export type PackageMarkerAstVisitor<R = void | void> = {
[K in keyof PackageMarkerAstNodeTypes]: PackageMarkerAstNodeVisitor<K, R>;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { NodePath, RawSchemas, RootApiFileSchema } from "@fern-api/fern-definition-schema";
import { RawSchemas, RootApiFileSchema } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

export type RootApiFileAstVisitor<R = void | void> = {
[K in keyof RootApiFileAstNodeTypes]: RootApiFileAstNodeVisitor<K, R>;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { noop, visitObject } from "@fern-api/core-utils";
import {
NodePath,
RawSchemas,
isInlineRequestBody,
isVariablePathParameter,
visitExampleResponseSchema
} from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

import { DefinitionFileAstVisitor, TypeReferenceLocation } from "../../DefinitionFileAstVisitor";
import { RootApiFileAstVisitor } from "../../RootApiFileAstVisitor";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { NodePath } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

import { DefinitionFileAstVisitor } from "../../DefinitionFileAstVisitor";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { isPlainObject } from "@fern-api/core-utils";
import { EXAMPLE_REFERENCE_PREFIX, NodePath } from "@fern-api/fern-definition-schema";
import { EXAMPLE_REFERENCE_PREFIX } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

import { DefinitionFileAstVisitor } from "../../DefinitionFileAstVisitor";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { NodePath, RawSchemas } from "@fern-api/fern-definition-schema";
import { RawSchemas } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

import { DefinitionFileAstVisitor, TypeReferenceLocation } from "../../DefinitionFileAstVisitor";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { noop, visitObject } from "@fern-api/core-utils";
import { NodePath, RawSchemas } from "@fern-api/fern-definition-schema";
import { RawSchemas } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

import { DefinitionFileAstVisitor } from "../DefinitionFileAstVisitor";
import { createDocsVisitor } from "./utils/createDocsVisitor";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { NodePath } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

import { DefinitionFileAstVisitor } from "../DefinitionFileAstVisitor";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { noop, visitObject } from "@fern-api/core-utils";
import { NodePath, RawSchemas, visitRawTypeDeclaration } from "@fern-api/fern-definition-schema";
import { RawSchemas, visitRawTypeDeclaration } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

import { DefinitionFileAstVisitor } from "../DefinitionFileAstVisitor";
import { createDocsVisitor } from "./utils/createDocsVisitor";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { noop, visitObject } from "@fern-api/core-utils";
import { NodePath, RawSchemas } from "@fern-api/fern-definition-schema";
import { RawSchemas } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

import { DefinitionFileAstVisitor, TypeReferenceLocation } from "../DefinitionFileAstVisitor";
import { createDocsVisitor } from "./utils/createDocsVisitor";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { DefinitionFileSchema, NodePath } from "@fern-api/fern-definition-schema";
import { DefinitionFileSchema } from "@fern-api/fern-definition-schema";
import { RelativeFilePath } from "@fern-api/fs-utils";
import { NodePath } from "@fern-api/validation-utils";

import { RuleVisitors } from "./Rule";
import { ValidationViolation } from "./ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { DefinitionFileAstNodeTypes, DefinitionFileAstNodeVisitor, DefinitionFileAstVisitor } from "./ast";
import { RuleVisitors } from "./Rule";

export function createDefinitionFileAstVisitorForRules({
relativeFilepath,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { NodePath, PackageMarkerFileSchema } from "@fern-api/fern-definition-schema";
import { PackageMarkerFileSchema } from "@fern-api/fern-definition-schema";
import { RelativeFilePath } from "@fern-api/fs-utils";
import { NodePath } from "@fern-api/validation-utils";

import { RuleVisitors } from "./Rule";
import { ValidationViolation } from "./ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { PackageMarkerAstNodeTypes, PackageMarkerAstNodeVisitor, PackageMarkerAstVisitor } from "./ast";
import { RuleVisitors } from "./Rule";

export function createPackageMarkerAstVisitorForRules({
relativeFilepath,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { NodePath, RootApiFileSchema } from "@fern-api/fern-definition-schema";
import { RootApiFileSchema } from "@fern-api/fern-definition-schema";
import { RelativeFilePath } from "@fern-api/fs-utils";
import { NodePath } from "@fern-api/validation-utils";

import { RuleVisitors } from "./Rule";
import { ValidationViolation } from "./ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { RootApiFileAstNodeTypes, RootApiFileAstNodeVisitor, RootApiFileAstVisitor } from "./ast";
import { RuleVisitors } from "./Rule";

export function createRootApiFileAstVisitorForRules({
relativeFilepath,
Expand Down
3 changes: 2 additions & 1 deletion packages/cli/fern-definition/validator/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export { type ValidationViolation } from "@fern-api/validation-utils";
export * from "./ast";
export { VALID_NAME_REGEX } from "./rules/valid-field-names/regex";
export { validateFernWorkspace } from "./validateFernWorkspace";
export { type ValidationViolation } from "./ValidationViolation";

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { MatchingEnvironmentUrlsRule } from "../matching-environment-urls";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { NoConflictingEndpointPathsRule } from "../no-conflicting-endpoint-paths";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { NoExtensionsWithFileUploadRule } from "../no-extensions-with-file-upload";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { NoObjectSinglePropertyKeyRule } from "../no-missing-union-variant-key";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import { mapValues } from "lodash-es";

import { FernWorkspace, visitAllDefinitionFiles } from "@fern-api/api-workspace-commons";
import {
NodePath,
isRawTextType,
parseGeneric,
parseRawBytesType,
Expand All @@ -12,6 +11,7 @@ import {
} from "@fern-api/fern-definition-schema";
import { RelativeFilePath } from "@fern-api/fs-utils";
import { parseReferenceToTypeName } from "@fern-api/ir-generator";
import { NodePath } from "@fern-api/validation-utils";

import { Rule, RuleViolation } from "../../Rule";
import { TypeReferenceLocation, visitDefinitionFileYamlAst } from "../../ast";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { NoUndefinedVariableReferenceRule } from "../no-undefined-variable-reference";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { OnlyObjectExtensionsRule } from "../only-object-extensions";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidBasePathRule } from "../valid-base-path";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidEndpointPathRule } from "../valid-endpoint-path";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidExampleEndpointCallRule } from "../valid-example-endpoint-call";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidExampleErrorRule } from "../valid-example-error";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidExampleTypeRule } from "../valid-example-type";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidFieldNamesRule } from "../valid-field-names";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/* eslint-disable @typescript-eslint/no-empty-function */
import { FernWorkspace, visitAllDefinitionFiles } from "@fern-api/api-workspace-commons";
import { NodePath, isGeneric, parseGeneric, visitRawTypeDeclaration } from "@fern-api/fern-definition-schema";
import { isGeneric, parseGeneric, visitRawTypeDeclaration } from "@fern-api/fern-definition-schema";
import { NodePath } from "@fern-api/validation-utils";

import { Rule, RuleViolation } from "../../Rule";
import { visitDefinitionFileYamlAst } from "../../ast";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidNavigationRule } from "../valid-navigation";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidOauthRule } from "../valid-oauth";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidPaginationRule } from "../valid-pagination";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidServiceUrlsRule } from "../valid-service-url";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidTypeNameRule } from "../valid-type-name";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { AbsoluteFilePath, RelativeFilePath, join } from "@fern-api/fs-utils";

import { ValidationViolation } from "../../../ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { getViolationsForRule } from "../../../testing-utils/getViolationsForRule";
import { ValidVersionRule } from "../valid-version";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import stripAnsi from "strip-ansi";

import { generatorsYml, loadGeneratorsConfiguration } from "@fern-api/configuration-loader";
import { loadGeneratorsConfiguration } from "@fern-api/configuration-loader";
import { AbsoluteFilePath } from "@fern-api/fs-utils";
import { LazyFernWorkspace } from "@fern-api/lazy-fern-workspace";
import { CONSOLE_LOGGER } from "@fern-api/logger";
import { createMockTaskContext } from "@fern-api/task-context";

import { ValidationViolation } from "@fern-api/validation-utils";
import { Rule } from "../Rule";
import { ValidationViolation } from "../ValidationViolation";
import { runRulesOnWorkspace } from "../validateFernWorkspace";

export declare namespace getViolationsForRule {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
import { FernWorkspace, visitAllDefinitionFiles, visitAllPackageMarkers } from "@fern-api/api-workspace-commons";
import { GENERATORS_CONFIGURATION_FILENAME, ROOT_API_FILENAME, generatorsYml } from "@fern-api/configuration-loader";
import { ROOT_API_FILENAME } from "@fern-api/configuration-loader";
import { DefinitionFileSchema, PackageMarkerFileSchema, RootApiFileSchema } from "@fern-api/fern-definition-schema";
import { RelativeFilePath } from "@fern-api/fs-utils";
import { Logger } from "@fern-api/logger";

import { Rule, RuleVisitors } from "./Rule";
import { ValidationViolation } from "./ValidationViolation";
import { ValidationViolation } from "@fern-api/validation-utils";
import { visitDefinitionFileYamlAst, visitPackageMarkerYamlAst, visitRootApiFileYamlAst } from "./ast";
import { createDefinitionFileAstVisitorForRules } from "./createDefinitionFileAstVisitorForRules";
import { createPackageMarkerAstVisitorForRules } from "./createPackageMarkerAstVisitorForRules";
import { createRootApiFileAstVisitorForRules } from "./createRootApiFileAstVisitorForRules";
import { getAllEnabledRules } from "./getAllRules";
import { Rule, RuleVisitors } from "./Rule";

export function validateFernWorkspace(workspace: FernWorkspace, logger: Logger): ValidationViolation[] {
return runRulesOnWorkspace({ workspace, rules: getAllEnabledRules(), logger });
Expand Down
Loading
Loading