refactor(core): rewrite ReleaseCreator to GitRepositoryHosting

Author: dangreen

packages/core/README.md

@@ -36,8 +36,6 @@ A simple tool to release projects with monorepo support.
 <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
 <a href="#usage">Usage</a>
 <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-<a href="#why">Why</a>
-<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
 <a href="#addons">Addons</a>
 <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
 <a href="#custom-addons">Custom addons</a>
@@ -60,18 +58,19 @@ npm i @simple-release/core
 ```js
 import { Releaser } from '@simple-release/core'
 import { PnpmProject } from '@simple-release/pnpm'
-import { GithubReleaseCreator } from '@simple-release/github-release'
-
-const project = new PnpmProject()
+import { GithubHosting } from '@simple-release/github'
 
-await new Releaser(project)
+await new Releaser({
+  project: new PnpmProject(),
+  hosting: new GithubHosting({
+    token: process.env.GITHUB_TOKEN
+  })
+})
   .bump()
   .commit()
   .tag()
   .push()
-  .release(new GithubReleaseCreator({
-    token: process.env.GITHUB_TOKEN
-  }))
+  .release()
   .publish()
   .run()
 ```
@@ -81,13 +80,16 @@ Monorepo example:
 ```js
 import { Releaser } from '@simple-release/core'
 import { PnpmWorkspacesProject } from '@simple-release/pnpm'
-import { GithubReleaseCreator } from '@simple-release/github-release'
+import { GithubHosting } from '@simple-release/github'
 
-const project = new PnpmWorkspacesProject({
-  mode: 'independent'
+await new Releaser({
+  project: new PnpmWorkspacesProject({
+    mode: 'independent'
+  }),
+  hosting: new GithubHosting({
+    token: process.env.GITHUB_TOKEN
+  })
 })
-
-await new Releaser(project)
   .bump()
   .commit()
   .tag()
@@ -99,9 +101,28 @@ await new Releaser(project)
   .run()
 ```
 
-## Why
-
-There no good tool to release projects with conventional-changelog support and with good monorepo support.
+### Options
+
+| Option | Description |
+| --- | --- |
+| `project` | Project instance. |
+| `hosting` | Git repository hosting instance. Optional. |
+| `dryRun` | If true, do not write files, just change the version in memory. |
+| `verbose` | If true, log more information to the console. |
+| `silent` | If true, do not log anything to the console. |
+
+### Available steps
+
+| Step | Description |
+| --- | --- |
+| checkout | Checkout the desired branch. |
+| bump | Bump the version of the project. |
+| commit | Commit the changes with the new version. |
+| tag | Tag the commit with the new version. |
+| push | Push the changes to the remote repository. |
+| release | Create a release in the remote repository. |
+| publish | Publish the project to the package registry. |
+| pullRequest | Create a pull request with the changes. |
 
 ## Addons
 
@@ -178,20 +199,25 @@ export class CustomProject extends Project {
 
 There also is a base class for monorepo projects - [MonorepoProject](./src/project/monorepo.ts). It provides methods to work with monorepo projects and you can extend it to create your own monorepo project class (alos see [PackageJsonMonorepoProject](./src/project/packageJsonMonorepo.ts)).
 
-### Release creator
+### GitRepositoryHosting
 
-Release creator is a class that creates a release in the remote repository (like GitHub, GitLab, etc.) or wherever you want. It is used in the `release` step of the releaser.
-
-Signature of the class is very simple, you just need to implement `create` method:
+GitRepositoryHosting is a class that represents a git repository hosting service (like GitHub, GitLab, etc.) or whatever you want. It is used to create a release in the remote repository and create a pull request with the changes.
 
 ```js
-import { ReleaseCreator } from '@simple-release/core'
+import { GitRepositoryHosting } from '@simple-release/core'
 
-export class CustomReleaseCreator extends ReleaseCreator {
-  async create({ project, dryRun, logger }) {
+export class MyRepositoryHosting extends GitRepositoryHosting {
+  async createRelease({ project, dryRun, logger }) {
     // Create the release in the remote repository
     // You can use `project` to get information about the project
-    // or more precisely you can use `project.getgetReleaseData()` to get the data for the release
+    // or more precisely you can use `project.getReleaseData()` to get the data for the release
+  }
+
+  async createPullRequest({ from, to, project, dryRun, logger }) {
+    // Create a pull request with the changes
+    // You can use `project` to get information about the project
   }
 }
 ```
+
+For more detailed example you can look at the [GithubHosting](../github/src/index.ts) implementation.

packages/core/package.json

@@ -58,8 +58,9 @@
     "test": "run -p lint test:unit test:types"
   },
   "dependencies": {
-    "@conventional-changelog/git-client": "^2.4.0",
+    "@conventional-changelog/git-client": "^2.5.1",
     "@simple-libs/child-process-utils": "^1.0.0",
+    "@simple-libs/hosted-git-info": "^1.0.0",
     "@simple-libs/stream-utils": "^1.0.0",
     "conventional-changelog": "^7.0.2",
     "conventional-changelog-conventionalcommits": "^9.0.0",

packages/core/src/hosting/hosting.ts

@@ -0,0 +1,23 @@
+import type {
+  CreateReleaseOptions,
+  CreatePullRequestOptions
+} from './hosting.types.js'
+
+export * from './hosting.types.js'
+
+/**
+ * A base class that represents a git repository hosting service.
+ */
+export abstract class GitRepositoryHosting {
+  /**
+   * Creates a new release for the given project.
+   * @param options
+   */
+  abstract createRelease(options: CreateReleaseOptions): Promise<void>
+
+  /**
+   * Creates a pull request for the given project.
+   * @param options
+   */
+  abstract createPullRequest(options: CreatePullRequestOptions): Promise<void>
+}

packages/core/src/hosting/hosting.types.ts

@@ -0,0 +1,31 @@
+import type { Project } from '../project/project.js'
+import type { ChildLogger } from '../logger.js'
+
+export interface ReleaseData {
+  version: string
+  title: string
+  notes: string
+  previousTag: string
+  nextTag: string
+  isPrerelease: boolean
+}
+
+export interface CreateReleaseOptions {
+  project: Project
+  dryRun?: boolean
+  logger?: ChildLogger
+}
+
+export interface CreatePullRequestOptions {
+  project: Project
+  /**
+   * Base branch for the pull request.
+   */
+  to?: string
+  /**
+   * Head branch for the pull request.
+   */
+  from?: string
+  dryRun?: boolean
+  logger?: ChildLogger
+}

packages/core/src/hosting/index.ts

@@ -0,0 +1 @@
+export * from './hosting.js'

packages/core/src/index.ts

@@ -1,5 +1,5 @@
 export * from './manifest/index.js'
 export * from './project/index.js'
-export * from './release/index.js'
+export * from './hosting/index.js'
 export * from './logger.js'
 export * from './releaser.js'

packages/core/src/logger.ts

@@ -12,7 +12,7 @@ export interface LoggerOptions {
 export interface LoggerMessage {
   dryRun?: boolean
   stage: string
-  message: string
+  message: unknown
 }
 
 function defaultPrinter({
@@ -21,7 +21,7 @@ function defaultPrinter({
   message
 }: LoggerMessage) {
   // eslint-disable-next-line no-console
-  console.log(`${dryRun ? `[dry-run]` : ''}[${stage}]: ${message}`)
+  console.log(`${dryRun ? `[dry-run]` : ''}[${stage}]:`, message)
 }
 
 /**
@@ -42,15 +42,15 @@ export class ChildLogger {
    * Logs an info message.
    * @param message - The message to log.
    */
-  info(message: string) {
+  info(message: unknown) {
     this.parent.info(this.stage, message)
   }
 
   /**
    * Logs a verbose message.
    * @param message - The message to log.
    */
-  verbose(message: string) {
+  verbose(message: unknown) {
     this.parent.verbose(this.stage, message)
   }
 }
@@ -78,7 +78,7 @@ export class Logger {
    * @param stage - The stage of the process.
    * @param message - The message to log.
    */
-  info(stage: string, message: string) {
+  info(stage: string, message: unknown) {
     const {
       silent,
       dryRun
@@ -98,7 +98,7 @@ export class Logger {
    * @param stage - The stage of the process.
    * @param message - The message to log.
    */
-  verbose(stage: string, message: string) {
+  verbose(stage: string, message: unknown) {
     const {
       silent,
       verbose,

packages/core/src/manifest/manifest.ts

@@ -1,12 +1,8 @@
 import { dirname } from 'path'
 import semver from 'semver'
+import type { ProjectManifestVersionUpdate } from './manifest.types.js'
 
-export interface ProjectManifestVersionUpdate {
-  name: string
-  from: string
-  to: string
-  files: string[]
-}
+export * from './manifest.types.js'
 
 /**
  * A base class for project manifests.

packages/core/src/manifest/manifest.types.ts

@@ -0,0 +1,6 @@
+export interface ProjectManifestVersionUpdate {
+  name: string
+  from: string
+  to: string
+  files: string[]
+}

packages/core/src/manifest/packageJson.ts

@@ -3,14 +3,9 @@ import {
   type ProjectManifestVersionUpdate,
   ProjectManifest
 } from './manifest.js'
+import type { PackageJsonProps } from './packageJson.types.js'
 
-export interface PackageJsonKnownProps {
-  name: string
-  version: string
-  private?: boolean
-}
-
-export type PackageJsonProps = PackageJsonKnownProps & Record<string, unknown>
+export * from './packageJson.types.js'
 
 /**
  * A class that represents a package.json manifest.