ggcheck

var ActionTypeForm = Check{
	Name: "Action type form",
	Rule: "explicit DSL Payload/Result types must be named types declared in the same model package: struct types use the pointer form, slice and map types use the value form, an empty struct type may only pair with an empty peer side, a Payload type is never an interface with methods, and a type defined over another named type (type A B) gives way to an alias (type A = B) or a struct of its own",
	// contains filtered or unexported fields
}

var ActionTypeNaming = Check{
	Name: "Action type naming",
	Rule: "explicit DSL Payload types must end with Req and Result types with Rsp",
	// contains filtered or unexported fields
}

var ActionTypeUniqueness = Check{
	Name: "Action type uniqueness",
	Rule: "an explicit DSL Payload, Result, StreamingPayload or StreamingResult type name must be declared by one action alone: each action names request and response types of its own, an alias of a shared type when the fields are the same",
	// contains filtered or unexported fields
}

var ArchitectureDependencies = Check{
	Name: "Architecture dependencies",
	Rule: "service code must not call other service code, dao code must not call service, router, controller or middleware code, and model code must not call service or dao code",
	// contains filtered or unexported fields
}

var ColumnReferenceMinting = Check{
	Name: "Column reference minting",
	Rule: "project code, tests included, must not mint column references through gst.NewColumn, NewNumericColumn, NewTimeColumn or NewJSONStringsColumn; columns are read through the XxxCols variables gg gen writes, which the model schema checks, generated files excepted. Generic code, which has no Cols variable to read, may mint a reference whose model is its own type parameter",
	// contains filtered or unexported fields
}

var DSLDesignRules = Check{
	Name: "DSL design rules",
	Rule: "model files must pass the same validation rules that gate gg gen: the Design() DSL rules, the base types model.Base, model.AutoBase and model.Empty embedded by value, never through a pointer, no two actions registering one path, and no two actions writing one service file, one service type into a directory or two packages into one",
	// contains filtered or unexported fields
}

var DatabaseChainTermination = Check{
	Name: "Database chain termination",
	Rule: "a database.Database chain runs one terminal operation: written inline it ends in one, held in a variable it is terminated once, not again and not inside a loop it was bound outside of",
	// contains filtered or unexported fields
}

var DetachedContext = Check{
	Name: "Detached context",
	Rule: "in model, service, dao, cronjob, leader, lock, component and router code, the context passed to a framework database function or to a dao function must not be context.Background() or context.TODO(): the context handed down — the write's for a model hook, a request's, a round's, a tenure's, a lock's, the process's, the start's — carries the identity, the transaction and the lease the work runs under; startup seeding runs in the router package's routes-ready hooks on the context the hook receives",
	// contains filtered or unexported fields
}

var DirectoryRestrictions = Check{
	Name: "Directory restrictions",
	Rule: "top-level directories must be ones the framework layout names, such as model, service, router and dao, or hold no Go packages, such as logs and deploy",
	// contains filtered or unexported fields
}

var ErrorDiscipline = Check{
	Name: "Error discipline",
	Rule: "errors leaving service methods and model hooks must be built by gst.NewError or gst.NewErrorWithCause",
	// contains filtered or unexported fields
}

var FrameworkColumns = Check{
	Name: "Framework columns",
	Rule: "models must keep the framework's fields under the columns the framework fixes, id, created_by, updated_by, created_at, updated_at and deleted_at for the fields of model.Base and model.AutoBase and tenant_id for tenant.Scope: a model re-declaring one of those fields keeps its column, and embeds tenant.Scope without a prefix",
	// contains filtered or unexported fields
}

var GRPCServiceContext = Check{
	Name: "gRPC service context",
	Rule: "the services of models declaring GRPC() must not call the ServiceContext methods only HTTP serves: " + strings.Join(types.HTTPOnlyMethods, ", ") + "; the services of their Import, Export and SSE actions, served over HTTP alone, may",
	// contains filtered or unexported fields
}

var GormTagIndexBan = Check{
	Name: "Gorm tag index ban",
	Rule: "gorm struct tags must not configure indexes (index, uniqueIndex, unique); models declare indexes through the Indexes() []model.Index method",
	// contains filtered or unexported fields
}

var IDAccessors = Check{
	Name: "ID accessors",
	Rule: "a model declaring an ID of its own over the one of model.Base or model.AutoBase, a wider key say, must declare its own GetID, SetID and ClearID: the base's read and write the shadowed field, which no column maps",
	// contains filtered or unexported fields
}

var IndexDeclarations = Check{
	Name: "Index declarations",
	Rule: "on a project configured for MySQL, the Indexes() declarations of every model must be ones MySQL accepts: the fields exist, no column repeats, no declaration duplicates a struct tag index, and every column can be indexed, which a string field without a size cannot, being a longtext column; give it a size (gorm:\"size:191\") or a bounded type",
	// contains filtered or unexported fields
}

var JSONTagNaming = Check{
	Name: "JSON tag naming",
	Rule: "model struct and explicit DSL Payload/Result type fields must carry snake_case json tags; an exported field without a json key would be served under its Go name",
	// contains filtered or unexported fields
}

var LogFieldBoundedness = Check{
	Name: "Log field boundedness",
	Rule: "project code must not declare MarshalLogObject or MarshalLogArray methods and must not call zap.Namespace: zapcore marshalers and nested namespaces bypass the reflected-value collapsing that keeps log-store field mappings bounded",
	// contains filtered or unexported fields
}

var ModelFileBoundaries = Check{
	Name: "Model file boundaries",
	Rule: "model files must contain at most one model struct",
	// contains filtered or unexported fields
}

var ModelFileNameHyphens = Check{
	Name: "Model file name hyphens",
	Rule: "model file names must not contain hyphens (use underscores instead)",
	// contains filtered or unexported fields
}

var ModelPackageNaming = Check{
	Name: "Model package naming",
	Rule: "model package names must match their directory names",
	// contains filtered or unexported fields
}

var ModelSingularNaming = Check{
	Name: "Model singular naming",
	Rule: "model directories and files must be singular",
	// contains filtered or unexported fields
}

var ModelTableNameDeclaration = Check{
	Name: "Model table name declaration",
	Rule: "model structs embedding model.Base or model.AutoBase must declare TableName() string on the struct itself, as a single return of a non-empty string literal",
	// contains filtered or unexported fields
}

var ModuleAssembly = Check{
	Name: "Module assembly",
	Rule: "the assembly calls a copied framework module declares in its module.json must be made in the project's non-test code, outside the model and service subtrees the module was copied into: the function called, or handed as a value to the installer that runs it; a function of those subtrees comes from the project's copy of the package",
	// contains filtered or unexported fields
}

var ProtobufDefinitions = Check{
	Name: "Protobuf definitions",
	Rule: "models declaring GRPC(), and the types their actions reach, must be describable in protobuf with a valid pb tag on every field, and their definitions must keep the contract committed under pb/: the checks gg gen runs before writing",
	// contains filtered or unexported fields
}

var QueryNames = Check{
	Name: "Query names",
	Rule: "a model's query tags must name each of its URL query parameters once: no two fields declare one name, a business field's name stays outside the \"_\" namespace of the framework's own parameters, and no tag holds \"[\", \"]\" or \".\", which the operator and the path syntax read",
	// contains filtered or unexported fields
}

var ServiceFileBoundaries = Check{
	Name: "Service file boundaries",
	Rule: "service files must contain at most one service struct",
	// contains filtered or unexported fields
}

var ServiceTestCoverage = Check{
	Name: "Service test coverage",
	Rule: "service files generated for DSL Service() actions must have a matching test file (create.go pairs with create_test.go or create_internal_test.go)",
	// contains filtered or unexported fields
}

var ServiceTestOrganization = Check{
	Name: "Service test organization",
	Rule: "test files under the service directory must pair with a source file of their package; main_test.go only declares TestMain, fixtures_test.go only holds shared test fixtures, and test cases without a source file of their own belong in the test file of a related source file",
	// contains filtered or unexported fields
}

var TenantUniqueIndexes = Check{
	Name: "Tenant unique indexes",
	Rule: "every unique index a model embedding tenant.Scope declares must name TenantID among its fields: the rows of such a model belong to one tenant each, so its uniqueness is declared within the tenant, {Fields: []string{\"TenantID\", \"Code\"}, Unique: true} rather than {Fields: []string{\"Code\"}, Unique: true}",
	// contains filtered or unexported fields
}

var TestMainImports = Check{
	Name: "TestMain imports",
	Rule: "test files declaring TestMain in an external test package must blank-import the interceptor and pb packages exactly when main.go imports them, which is while they hold Go sources",
	// contains filtered or unexported fields
}

var TransactionClosureContext = Check{
	Name: "Transaction closure context",
	Rule: "database.Database chains and nested database.Transaction calls inside a database.Transaction closure must use the closure's context parameter",
	// contains filtered or unexported fields
}

var VersionFieldDeclaration = Check{
	Name: "Version field declaration",
	Rule: `model.Version declarations must keep the optimistic-locking shape: on database models a named field with json:",omitempty" and gorm:"not null;default:1", and on DSL Payload/Result types (plus the same-package types reachable from their fields) a json tag of exactly "version,omitempty"`,
	// contains filtered or unexported fields
}