chore: simplify naming

Author: dangreen

packages/core/README.md

@@ -155,14 +155,14 @@ Project is a class that represents the project and provides methods to work with
 - publish the project
 - etc.
 
-Most of the methods are implemented in base class [GenericProject](./src/project/project.ts) and you can extend it to create your own project class.
+Most of the methods are implemented in base class [Project](./src/project/project.ts) and you can extend it to create your own project class.
 
 In most casses you need just prepare options for the base class and implement `publish` method (like it is done in [PackageJsonProject](./src/project/packageJson.ts)).
 
 ```js
-import { GenericProject } from '@simple-release/core'
+import { Project } from '@simple-release/core'
 
-export class CustomProject extends GenericProject {
+export class CustomProject extends Project {
   constructor(options) {
     super({
       ...options,
@@ -176,7 +176,7 @@ export class CustomProject extends GenericProject {
 }
 ```
 
-There also is a base class for monorepo projects - [GenericMonorepoProject](./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)).
+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
 
@@ -185,9 +185,9 @@ Release creator is a class that creates a release in the remote repository (like
 Signature of the class is very simple, you just need to implement `create` method:
 
 ```js
-import { GenericReleaseCreator } from '@simple-release/core'
+import { ReleaseCreator } from '@simple-release/core'
 
-export class CustomReleaseCreator extends GenericReleaseCreator {
+export class CustomReleaseCreator extends ReleaseCreator {
   async create({ project, dryRun, logger }) {
     // Create the release in the remote repository
     // You can use `project` to get information about the project

packages/core/src/project/monorepo.ts

@@ -6,17 +6,17 @@ import {
 import { type ReleaseData } from '../release/release.js'
 import { type ProjectManifest } from '../manifest/index.js'
 import {
-  type GenericProjectOptions,
-  type GenericProjectBumpOptions,
+  type ProjectOptions,
+  type ProjectBumpOptions,
   bumpDefaultOptions,
-  GenericProject
+  Project
 } from './project.js'
 
 export type MonorepoMode = 'fixed' | 'independent'
 
-export type GetProjectsOptions = Required<Pick<GenericProjectOptions, 'compose' | 'gitClient' | 'manifest'>>
+export type GetProjectsOptions = Required<Pick<ProjectOptions, 'compose' | 'gitClient' | 'manifest'>>
 
-export interface GenericMonorepoProjectOptions extends GenericProjectOptions {
+export interface MonorepoProjectOptions extends ProjectOptions {
   /**
    * The mode of the monorepo.
    * If mode is 'fixed', all projects will be bumped to the same version.
@@ -31,7 +31,7 @@ export interface GenericMonorepoProjectOptions extends GenericProjectOptions {
   /**
    * Get projects in the monorepo.
    */
-  getProjects(options: GetProjectsOptions): AsyncIterable<GenericProject>
+  getProjects(options: GetProjectsOptions): AsyncIterable<Project>
   /**
    * Get the scope for the project of monorepo.
    * @param projectName - Project name to get the scope for.
@@ -51,32 +51,32 @@ export interface GenericMonorepoProjectOptions extends GenericProjectOptions {
   gitClient?: ConventionalGitClient
 }
 
-export interface GenericMonorepoProjectBumpOptions extends Omit<GenericProjectBumpOptions, 'tagPrefix'> {
+export interface MonorepoProjectBumpOptions extends Omit<ProjectBumpOptions, 'tagPrefix'> {
   /**
    * Force bump projects without changes in the monorepo with fixed mode.
    */
   force?: boolean
   /**
    * Bump options for specific projects.
    */
-  byProject?: Record<string, Pick<GenericProjectBumpOptions, 'version' | 'as' | 'prerelease' | 'firstRelease'>>
+  byProject?: Record<string, Pick<ProjectBumpOptions, 'version' | 'as' | 'prerelease' | 'firstRelease'>>
 }
 
-export abstract class GenericMonorepoProject extends GenericProject {
+export abstract class MonorepoProject extends Project {
   /**
    * The mode of the monorepo.
    * If mode is 'fixed', all projects will be bumped to the same version.
    * If mode is 'independent', each project will be bumped to its own version.
    */
   mode: MonorepoMode
-  declare options: GenericMonorepoProjectOptions & GenericProjectOptions
-  private projectsMutex: Promise<GenericProject[]> | undefined
+  declare options: MonorepoProjectOptions & ProjectOptions
+  private projectsMutex: Promise<Project[]> | undefined
 
   /**
    * Creates a new instance of the generic monorepo project.
    * @param options - The options to use for the monorepo project.
    */
-  constructor(options: GenericMonorepoProjectOptions) {
+  constructor(options: MonorepoProjectOptions) {
     const {
       mode,
       compose
@@ -107,10 +107,10 @@ export abstract class GenericMonorepoProject extends GenericProject {
         gitClient: this.gitClient,
         manifest: this.manifest
       }
-      const projects: GenericProject[] = []
-      let resolve: (projects: GenericProject[]) => void
+      const projects: Project[] = []
+      let resolve: (projects: Project[]) => void
 
-      this.projectsMutex = new Promise<GenericProject[]>((r) => {
+      this.projectsMutex = new Promise<Project[]>((r) => {
         resolve = r
       })
 
@@ -243,8 +243,8 @@ export abstract class GenericMonorepoProject extends GenericProject {
   }
 
   private async getBumpOptions(
-    project: GenericProject,
-    options: GenericMonorepoProjectBumpOptions
+    project: Project,
+    options: MonorepoProjectBumpOptions
   ) {
     const {
       preset = bumpDefaultOptions.preset,
@@ -272,7 +272,7 @@ export abstract class GenericMonorepoProject extends GenericProject {
   }
 
   override getNextVersion(
-    options: GenericMonorepoProjectBumpOptions = {}
+    options: MonorepoProjectBumpOptions = {}
   ): Promise<string | null> {
     if (this.mode === 'fixed' && options.version) {
       return super.getNextVersion(options)
@@ -284,7 +284,7 @@ export abstract class GenericMonorepoProject extends GenericProject {
   }
 
   private async independentBump(
-    options: GenericMonorepoProjectBumpOptions = {}
+    options: MonorepoProjectBumpOptions = {}
   ) {
     let hasBump = false
 
@@ -308,12 +308,12 @@ export abstract class GenericMonorepoProject extends GenericProject {
   }
 
   private async fixedBump(
-    options: GenericMonorepoProjectBumpOptions = {}
+    options: MonorepoProjectBumpOptions = {}
   ) {
     const { force } = options
     const updatedProjects: {
-      project: GenericProject
-      options: GenericMonorepoProjectBumpOptions
+      project: Project
+      options: MonorepoProjectBumpOptions
     }[] = []
     let hasBump = false
     let fixedVersion: string | undefined
@@ -363,7 +363,7 @@ export abstract class GenericMonorepoProject extends GenericProject {
   }
 
   override async bump(
-    options: GenericMonorepoProjectBumpOptions = {}
+    options: MonorepoProjectBumpOptions = {}
   ) {
     const { mode } = this
 

packages/core/src/project/packageJson.ts

@@ -1,11 +1,11 @@
 import { PackageJsonManifest } from '../manifest/index.js'
 import {
-  type GenericProjectOptions,
-  type GenericProjectPublishOptions,
-  GenericProject
+  type ProjectOptions,
+  type ProjectPublishOptions,
+  Project
 } from './project.js'
 
-export interface PackageJsonProjectOptions extends Omit<GenericProjectOptions, 'manifest'> {
+export interface PackageJsonProjectOptions extends Omit<ProjectOptions, 'manifest'> {
   /**
    * Path to the package.json file
    */
@@ -15,7 +15,7 @@ export interface PackageJsonProjectOptions extends Omit<GenericProjectOptions, '
 /**
  * A package.json based project.
  */
-export class PackageJsonProject extends GenericProject {
+export class PackageJsonProject extends Project {
   /**
    * Creates a package.json based project.
    * @param options
@@ -29,7 +29,7 @@ export class PackageJsonProject extends GenericProject {
     })
   }
 
-  override publish(_options?: GenericProjectPublishOptions): Promise<void> {
+  override publish(_options?: ProjectPublishOptions): Promise<void> {
     throw new Error('Publishing a package.json project is not supported')
   }
 }

packages/core/src/project/packageJsonMonorepo.spec.ts

@@ -11,7 +11,7 @@ import {
   forkProject
 } from 'test'
 import type { GetProjectsOptions } from './monorepo.js'
-import type { GenericProject } from './project.js'
+import type { Project } from './project.js'
 import { PackageJsonMonorepoProject } from './packageJsonMonorepo.js'
 
 async function* getProjects(options: GetProjectsOptions) {
@@ -143,7 +143,7 @@ describe('core', () => {
             root: path,
             getProjects
           })
-          const projects: GenericProject[] = []
+          const projects: Project[] = []
 
           for await (const subProject of project.getProjects()) {
             projects.push(subProject)

packages/core/src/project/packageJsonMonorepo.ts

@@ -3,16 +3,16 @@ import {
   join
 } from 'path'
 import { PackageJsonManifest } from '../manifest/index.js'
-import { type GenericProjectPublishOptions } from './project.js'
+import { type ProjectPublishOptions } from './project.js'
 import { PackageJsonProject } from './packageJson.js'
 import {
-  type GenericMonorepoProjectOptions,
+  type MonorepoProjectOptions,
   type MonorepoMode,
   type GetProjectsOptions,
-  GenericMonorepoProject
+  MonorepoProject
 } from './monorepo.js'
 
-export interface PackageJsonMonorepoProjectOptions extends Omit<GenericMonorepoProjectOptions, 'getProjects' | 'manifest'> {
+export interface PackageJsonMonorepoProjectOptions extends Omit<MonorepoProjectOptions, 'getProjects' | 'manifest'> {
   mode: MonorepoMode
   /**
    * Root path of the monorepo
@@ -27,7 +27,7 @@ export interface PackageJsonMonorepoProjectOptions extends Omit<GenericMonorepoP
 /**
  * A package.json based monorepo project.
  */
-export class PackageJsonMonorepoProject extends GenericMonorepoProject {
+export class PackageJsonMonorepoProject extends MonorepoProject {
   /**
    * Creates a package.json based monorepo project.
    * @param options
@@ -52,7 +52,7 @@ export class PackageJsonMonorepoProject extends GenericMonorepoProject {
     })
   }
 
-  override publish(_options?: GenericProjectPublishOptions): Promise<void> {
+  override publish(_options?: ProjectPublishOptions): Promise<void> {
     throw new Error('Publishing a package.json monorepo project is not supported')
   }
 }

packages/core/src/project/project.ts

@@ -18,11 +18,11 @@ import { type ReleaseData } from '../release/index.js'
 import { type ChildLogger } from '../logger.js'
 import { getReleaseType } from '../utils.js'
 
-export interface GenericProjectVersionUpdate extends ProjectManifestVersionUpdate {
+export interface ProjectVersionUpdate extends ProjectManifestVersionUpdate {
   notes: string
 }
 
-export interface GenericProjectOptions {
+export interface ProjectOptions {
   /**
    * The manifest of the project.
    */
@@ -43,7 +43,7 @@ export interface GenericProjectOptions {
   gitClient?: ConventionalGitClient
 }
 
-export interface GenericProjectBumpOptions {
+export interface ProjectBumpOptions {
   /**
    * Force a specific version to bump to.
    * If not provided, the version will be determined based on the commits.
@@ -77,7 +77,7 @@ export interface GenericProjectBumpOptions {
   logger?: ChildLogger
 }
 
-export interface GenericProjectTagsOptions {
+export interface ProjectTagsOptions {
   /**
    * The prefix to use for the tag.
    * @default 'v'
@@ -91,15 +91,15 @@ export interface GenericProjectTagsOptions {
   verify?: boolean
 }
 
-export interface GenericProjectReleaseOptions {
+export interface ProjectReleaseOptions {
   /**
    * The prefix to use for the tag.
    * @default 'v'
    */
   tagPrefix?: string
 }
 
-export interface GenericProjectPublishOptions {
+export interface ProjectPublishOptions {
   dryRun?: boolean
   logger?: ChildLogger
 }
@@ -114,7 +114,7 @@ export const bumpDefaultOptions = {
 /**
  * A class that represents a generic project.
  */
-export abstract class GenericProject {
+export abstract class Project {
   /**
    * The manifest of the project.
    */
@@ -123,21 +123,21 @@ export abstract class GenericProject {
    * The git client used to interact with the repository.
    */
   gitClient: ConventionalGitClient
-  options: GenericProjectOptions
+  options: ProjectOptions
   /**
    * Changed files after interacting with the project.
    */
   changedFiles: string[] = []
   /**
    * Version updates after interacting with the project.
    */
-  versionUpdates: GenericProjectVersionUpdate[] = []
+  versionUpdates: ProjectVersionUpdate[] = []
 
   /**
    * Creates a new instance of the generic project.
    * @param options - The options to use for the project.
    */
-  constructor(options: GenericProjectOptions) {
+  constructor(options: ProjectOptions) {
     const {
       manifest,
       compose,
@@ -171,7 +171,7 @@ export abstract class GenericProject {
    * @param options - The options to use for getting the tags.
    * @returns The new git tags.
    */
-  async getTags(options: GenericProjectTagsOptions = {}) {
+  async getTags(options: ProjectTagsOptions = {}) {
     const {
       manifest,
       gitClient
@@ -199,7 +199,7 @@ export abstract class GenericProject {
    * @param options - The options to use for getting the release data.
    * @returns The release data.
    */
-  async getReleaseData(options: GenericProjectReleaseOptions = {}): Promise<ReleaseData[]> {
+  async getReleaseData(options: ProjectReleaseOptions = {}): Promise<ReleaseData[]> {
     const {
       manifest,
       versionUpdates
@@ -243,7 +243,7 @@ export abstract class GenericProject {
    * @param options - The options to use for getting the next version.
    * @returns The next version.
    */
-  async getNextVersion(options: GenericProjectBumpOptions = {}): Promise<string | null> {
+  async getNextVersion(options: ProjectBumpOptions = {}): Promise<string | null> {
     const {
       gitClient,
       manifest
@@ -318,7 +318,7 @@ export abstract class GenericProject {
    * @param options - The options to use for bumping the version.
    * @returns Whether the version was bumped.
    */
-  async bump(options: GenericProjectBumpOptions = {}) {
+  async bump(options: ProjectBumpOptions = {}) {
     const nextVersion = await this.getNextVersion(options)
 
     if (!nextVersion) {
@@ -384,5 +384,5 @@ export abstract class GenericProject {
    * Publish the project.
    * @param options
    */
-  abstract publish(options?: GenericProjectPublishOptions): Promise<void>
+  abstract publish(options?: ProjectPublishOptions): Promise<void>
 }