analyzer library

Tools for analyzing the protocol files of a Serverpod project.

Classes

ClassDefinition
A representation of a yaml file in the protocol directory defining a class or exception.
CodeAnalysisCollector
EndpointsAnalyzer
Analyzes dart files for the protocol specification.
EnumDefinition
A representation of a yaml file in the protocol directory defining an enum.
GeneratorConfig
The configuration of the generation and analyzing process.
MigrationGenerator
MigrationVersion
ProtocolDefinition
Defines a projects protocol. This does not include stuff the ProtocolYamlFileAnalyzer analyzed.
SerializableModelAnalyzer
Used to analyze a singe yaml model file.
SerializableModelDefinition
An abstract representation of a yaml file in the protocol directory.
SerializableModelFieldDefinition
Describes a single field of a ClassDefinition.
SerializableModelIndexDefinition
The definition of an index for a file, that is also stored in the database.
TypeDefinition
Contains information about the type of fields, arguments and return values.

Enums

ModelFieldScopeDefinition
The scope of a field.
PackageType
The type of the package.

Extensions

ColumnComparisons on ColumnDefinition
ColumnDefinitionPgSqlGeneration on ColumnDefinition
ColumnMigrationPgSqlGenerator on ColumnMigration
DatabaseComparisons on DatabaseDefinition
DatabaseDefinitionPgSqlGeneration on DatabaseDefinition
DatabaseDiffComparisons on DatabaseMigration
DatabaseMigrationPgSqlGenerator on DatabaseMigration
ForeignKeyComparisons on ForeignKeyDefinition
ForeignKeyDefinitionPgSqlGeneration on ForeignKeyDefinition
IndexComparisons on IndexDefinition
IndexDefinitionPgSqlGeneration on IndexDefinition
MigrationActionPgSqlGeneration on DatabaseMigrationAction
TableComparisons on TableDefinition
TableDefinitionExtension on TableDefinition
TableDefinitionPgSqlGeneration on TableDefinition
TableDiffComparisons on TableMigration
TableMigrationPgSqlGenerator on TableMigration

Functions

generateDatabaseMigration({required DatabaseDefinition databaseSource, required DatabaseDefinition databaseTarget}) → DatabaseMigration
generateTableMigration(TableDefinition srcTable, TableDefinition dstTable, List<DatabaseMigrationWarning> warnings) → TableMigration?
removeNullability(String type) String

Exceptions / Errors

SourceSpanException
A class for exceptions that have source span information attached.