This PR introduces some API changes that are breaking and thus constitute bumping the major version to 2.0.0. This PR is best viewed by commits as each changes an individual package.
Changes by package:
repository
Move CurrentRepository function from top level gh package to repository package. This felt like a more natural place for it.
Change name of CurrentRepository function to Current as it is now in the repository package.
Change Repository interface type to concrete type. The interface was not serving any purpose as there was only one implementation of it. Allowed for removing of internal/repository/repository.go.
api
Change all references of GQL to GraphQL.
Move RESTClient function from top level gh package to api package. This made more sense in the api package than at the top level.
Move GQLClient function from top level gh package to api package. This made more sense in the api package than at the top level.
Move HTTPClient function from top level gh package to api package. This made more sense in the api package than at the top level.
Change RESTClient interface type to concrete type. The interface was not serving any purpose as there was only one implementation of it.
Change GQLClient interface type to concrete type. The interface was not serving any purpose as there was only one implementation of it.
Change ClientOptions to be used with value semantics instead of pointer semantics. This allows ClientOptions to be used in multiple clients without having to worry about them being modified.
Change methods on HTTPError and GQLError custom error types to take pointers as method receivers. This is a Go convention which should be followed unless good reason not to.
Added DefaultRESTClient, DefaultHTTPClient, DefaultGQLClient convenience functions. With the change to using value semantics for the options these felt nice to have.
These changes allowed for removing of internal/api folder.
Change GQLClientQuery and Mutate methods to return GQLError instead of shurcooL/graphql.Errors.
browser
Change New factory function to return *Browser instead of Browser. All methods on Browser use *Browser as the receiver so we should be returning a pointer.
config
Change methods on InvalidConfigFileError and KeyNotFoundError custom error types to take pointers as method receivers. This is a Go convention which should be followed unless good reason not to.
template
Change New factory function to return *Template instead of Template. All methods on Template use *Template as the receiver so we should be returning a pointer.
This PR introduces some API changes that are breaking and thus constitute bumping the major version to 2.0.0. This PR is best viewed by commits as each changes an individual package.
Changes by package:
CurrentRepositoryfunction from top levelghpackage torepositorypackage. This felt like a more natural place for it.CurrentRepositoryfunction toCurrentas it is now in therepositorypackage.Repositoryinterface type to concrete type. The interface was not serving any purpose as there was only one implementation of it. Allowed for removing ofinternal/repository/repository.go.GQLtoGraphQL.RESTClientfunction from top levelghpackage toapipackage. This made more sense in theapipackage than at the top level.GQLClientfunction from top levelghpackage toapipackage. This made more sense in theapipackage than at the top level.HTTPClientfunction from top levelghpackage toapipackage. This made more sense in theapipackage than at the top level.RESTClientinterface type to concrete type. The interface was not serving any purpose as there was only one implementation of it.GQLClientinterface type to concrete type. The interface was not serving any purpose as there was only one implementation of it.ClientOptionsto be used with value semantics instead of pointer semantics. This allowsClientOptionsto be used in multiple clients without having to worry about them being modified.HTTPErrorandGQLErrorcustom error types to take pointers as method receivers. This is a Go convention which should be followed unless good reason not to.DefaultRESTClient,DefaultHTTPClient,DefaultGQLClientconvenience functions. With the change to using value semantics for the options these felt nice to have.internal/apifolder.GQLClientQueryandMutatemethods to returnGQLErrorinstead ofshurcooL/graphql.Errors.Newfactory function to return*Browserinstead ofBrowser. All methods onBrowseruse*Browseras the receiver so we should be returning a pointer.InvalidConfigFileErrorandKeyNotFoundErrorcustom error types to take pointers as method receivers. This is a Go convention which should be followed unless good reason not to.Newfactory function to return*Templateinstead ofTemplate. All methods onTemplateuse*Templateas the receiver so we should be returning a pointer.Fixes https://github.com/cli/go-gh/issues/97