chore: some cleanup

.gitignore

@@ -7,3 +7,5 @@ node_modules
 package-lock.json
 yarn.lock
 .vscode
+.envrc
+.env

.tool-versions

@@ -0,0 +1 @@
+nodejs 18.17.0

package.json

@@ -44,10 +44,96 @@
       "project": true
     }
   },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "patch"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "deps",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
   "scripts": {
     "clean": "aegir clean",
     "lint": "aegir lint",
-    "build": "aegir build"
+    "build": "aegir build",
+    "release": "aegir release"
   },
   "devDependencies": {
     "aegir": "^41.0.4",

src/index.ts

@@ -1,12 +1,13 @@
 import { registerPlugin, getPluginTypes } from 'release-please'
+import { logger } from 'release-please/build/src/util/logger'
 import { CustomPlugin } from './plugin'
 
-export function init(...args: unknown[]) {
-  console.log('@ipfs-shipyard/release-please-ipfs-plugin init called with args: ', args)
+export function init (...args: unknown[]): void {
+  logger.info('@ipfs-shipyard/release-please-ipfs-plugin init called with args: ', args)
 
   registerPlugin('@ipfs-shipyard/release-please-ipfs-plugin', (options: any) => new CustomPlugin(options.github, options.targetBranch, options.repositoryConfig))
-  console.log('registered @ipfs-shipyard/release-please-ipfs-plugin')
-  console.log('currently registered plugins: ', getPluginTypes())
+  logger.info('registered @ipfs-shipyard/release-please-ipfs-plugin')
+  logger.info('currently registered plugins: ', getPluginTypes())
 }
 
 init()

src/plugin.ts

@@ -1,29 +1,28 @@
 // import { type ConventionalCommit } from 'release-please/build/src/commit';
-import { GitHub } from 'release-please/build/src/github';
-import { type CandidateReleasePullRequest, type RepositoryConfig } from 'release-please/build/src/manifest';
-import {ManifestPlugin} from 'release-please/build/src/plugin';
-import { Update } from 'release-please/build/src/update';
-import { UpdateVersionsInReadme } from './readme-updater';
+import { type GitHub } from 'release-please/build/src/github'
+import { type CandidateReleasePullRequest, type RepositoryConfig } from 'release-please/build/src/manifest'
+import { ManifestPlugin } from 'release-please/build/src/plugin'
+import { type Update } from 'release-please/build/src/update'
+import { UpdateVersionsInReadme } from './readme-updater'
 
 export class CustomPlugin extends ManifestPlugin {
-  constructor(
+  constructor (
     github: GitHub,
     targetBranch: string,
     repositoryConfig: RepositoryConfig,
     options: Record<string, unknown> = {}
   ) {
-    super(github, targetBranch, repositoryConfig);
+    super(github, targetBranch, repositoryConfig)
 
-    this.logger.info('ReadMeUpdater initialized with options: ', options);
+    this.logger.info('ReadMeUpdater initialized with options: ', options)
   }
 
   /**
    * called by https://github.com/googleapis/release-please/blob/71dcc7b3b2df4bb3d3e0884b3f0bfb96700cb76a/src/manifest.ts#L757
    */
-  async run(pullRequestCandidates: CandidateReleasePullRequest[]): Promise<CandidateReleasePullRequest[]> {
+  async run (pullRequestCandidates: CandidateReleasePullRequest[]): Promise<CandidateReleasePullRequest[]> {
     const releasePleaseCreatedPr = pullRequestCandidates.find((prCandidate) => {
       return prCandidate.pullRequest.body.toString().includes('This PR was generated with [Release Please](https://github.com/googleapis/release-please)')
-
     })
     if (releasePleaseCreatedPr == null) {
       this.logger.info('no release please created pr found')
@@ -46,7 +45,7 @@ export class CustomPlugin extends ManifestPlugin {
       path: 'README.md',
       createIfMissing: false,
       updater: new UpdateVersionsInReadme({
-        version: pullRequest.version,
+        version: pullRequest.version
       })
     }
     pullRequest.updates.push(updateVersionsInReadme)

src/readme-updater.ts

@@ -1,25 +1,22 @@
-import { DefaultUpdater, type UpdateOptions } from 'release-please/build/src/updaters/default'
-import { logger as defaultLogger, type Logger } from 'release-please/build/src/util/logger';
+import { DefaultUpdater } from 'release-please/build/src/updaters/default'
+import { logger as defaultLogger, type Logger } from 'release-please/build/src/util/logger'
 
 export class UpdateVersionsInReadme extends DefaultUpdater {
-  constructor(options: UpdateOptions) {
-    super(options)
-  }
-  getRegex(oldVersion: string): RegExp {
-    return new RegExp(`((?:ipfs-desktop|IPFS-Desktop-Setup|ipfs-desktop/releases/tag|ipfs-desktop/releases/download)[-/]v?)${oldVersion}`, 'gm');
+  getRegex (oldVersion: string): RegExp {
+    return new RegExp(`((?:ipfs-desktop|IPFS-Desktop-Setup|ipfs-desktop/releases/tag|ipfs-desktop/releases/download)[-/]v?)${oldVersion}`, 'gm')
   }
 
-  updateContent(content: string, logger: Logger = defaultLogger): string {
-    const newVersion = this.version.toString();
+  updateContent (content: string, logger: Logger = defaultLogger): string {
+    const newVersion = this.version.toString()
     /**
      * look for a string "like ipfs-desktop-0.31.0-mac.dmg" and get the version(e.g. 0.31.0) from it
      * TODO: We need a better way to get the old version
+     * TODO: We need a way to accept a custom regex from the user.
      */
-
     const match = content.match(/ipfs\/ipfs-desktop\/releases\/tag\/v(?<version>[^)]+)/)
-    const oldVersion = match?.groups?.version;
-    if (!oldVersion) {
-      throw new Error(`could not find old version in provided README.md content`);
+    const oldVersion = match?.groups?.version
+    if (oldVersion == null) {
+      throw new Error('could not find old version in provided README.md content')
     }
 
     const result = content.replace(this.getRegex(oldVersion), `$1${newVersion}`)

tsconfig.json

@@ -4,9 +4,9 @@
     "outDir": "dist",
     "target": "ES6",
     "module": "commonjs",
-    "verbatimModuleSyntax": false,
+    "verbatimModuleSyntax": false
   },
   "include": [
-    "src",
+    "src"
   ]
 }