mlcl 1.0.0

package/src/commands/utilities/branchExists.ts

@@ -0,0 +1,15 @@
+import { asyncExec } from './asyncExec.js'
+
+/**
+ * Resolves `true` if the branch exists.
+ */
+export const branchExists = async (branchName: string, repoPath = ``, branchPath = `refs/heads`) => {
+  try {
+    const result = await asyncExec(`git${repoPath ? ` -C "${repoPath}"` : ``} show-ref ${branchPath}/${branchName}`)
+
+    return Boolean(result.stdout)
+  } catch (error) {
+  }
+
+  return false
+}

package/src/commands/utilities/checkoutSelectionBranch.ts

@@ -0,0 +1,62 @@
+import { asyncExec } from './asyncExec.js'
+import { branchExists } from './branchExists.js'
+import { getCurrentBranch } from './getCurrentBranch.js'
+import { logger } from '../../logger.js'
+
+/**
+ * Checks out the branch for the Molecule selection.
+ * 
+ * If it does not yet exist, it will be created as an empty branch.
+ * 
+ * Returns `true` if an empty branch was created.
+ */
+export const checkoutSelectionBranch = async (
+  selectionHash: string,
+  repoPath = ``,
+  branchPath = ``,
+  resetIfLocalExists = false,
+) => {
+  const branchName = `mlcl-${selectionHash}`
+
+  if (await branchExists(branchName, repoPath, branchPath)) {
+    if ((await getCurrentBranch(repoPath)) === branchName) {
+      logger.info(`Already on branch ${branchName}.`)
+      return false
+    }
+
+    if (/^remotes\/(.+)/.test(branchPath)) {
+      logger.info(`Branch ${branchName} exists at ${branchPath}.`)
+      logger.info(`Checking out ${branchName} with tracking from ${branchPath}...`)
+      await asyncExec(`git${repoPath ? ` -C "${repoPath}"` : ``} checkout --track ${branchPath.replace(/^remotes\//, ``)}/${branchName}`)
+    } else {
+      logger.info(`Checking out branch ${branchName}...`)
+      await asyncExec(`git${repoPath ? ` -C "${repoPath}"` : ``} checkout ${branchName}`)
+    }
+
+    return false
+  }
+
+  const localBranchExists = await branchExists(branchName, repoPath)
+
+  if (localBranchExists) {
+    logger.info(`Branch ${branchName} already exists locally!`)
+
+    if (!resetIfLocalExists) {
+      return false
+    }
+  } else {
+    // Branch does not yet exist, so create it.
+    logger.info(`Creating new orphan branch ${branchName}...`)
+    await asyncExec(`git${repoPath ? ` -C "${repoPath}"` : ``} checkout --orphan ${branchName}`)
+  }
+
+  // Reset it to an empty repository.
+  logger.info(`Resetting branch to an empty repository...`)
+  await asyncExec(`git${repoPath ? ` -C "${repoPath}"` : ``} rm -rf .`)
+
+  logger.info(`Creating empty initial commit...`)
+  await asyncExec(`git${repoPath ? ` -C "${repoPath}"` : ``} commit --allow-empty -m "initialize empty repository"`)
+  logger.info(`Branch ${branchName} is ready for assembly.`)
+
+  return true
+}

package/src/commands/utilities/cherryPick.ts

@@ -0,0 +1,23 @@
+import { asyncExec } from './asyncExec.js'
+import { logger } from '../../logger.js'
+
+/**
+ * Cherry picks the commit onto the current branch.
+ * 
+ * Returns `true` if successful.
+ */
+export const cherryPick = async (commitHash: string, repoPath = ``, parameters = ``) => {
+  try {
+    const { stderr } = await asyncExec(`git${repoPath ? ` -C "${repoPath}"` : ``} cherry-pick ${commitHash} ${parameters}`)
+
+    if (stderr) {
+      throw new Error(stderr)
+    }
+
+    return true
+  } catch (error) {
+    logger.error(error)
+  }
+
+  return false
+}

package/src/commands/utilities/cloneRepo.ts

@@ -0,0 +1,10 @@
+import { logger } from '../../logger.js'
+import { asyncExec } from './asyncExec.js'
+
+/**
+ * Clones a repository by URL to the specified path.
+ */
+export const cloneRepo = (repoUrl: string, repoPath: string) => {
+  logger.info(`Cloning ${repoUrl} into ${repoPath}...`)
+  return asyncExec(`git clone ${repoUrl} ${repoPath}`)
+}

package/src/commands/utilities/convertNpmToYarn.ts

@@ -0,0 +1,71 @@
+import fs from 'fs'
+import path from 'path'
+import glob from 'glob'
+
+/**
+ * A very quick and dirty hacked together script to convert an NPM codebase to a Yarn one.
+ */
+export const convertNpmToYarn = async (cwd = `.`) => {
+  try {
+    // Add Yarn to prerequisites in README.
+    const readmePath = path.join(cwd, `README.md`)
+    let README = await fs.promises.readFile(readmePath, `utf8`)
+
+    README = README.replace(
+      `- [Node.js](https://nodejs.org/) (version 16)`,
+      `- [Node.js](https://nodejs.org/) (version 16)
+
+  - [Yarn](https://yarnpkg.com/getting-started/install)
+
+  - The recommended way to install Yarn is by enabling [Corepack](https://github.com/nodejs/corepack), which is included by default with the latest Node.js version, but it is opt-in. To enable Corepack, run \`corepack enable\` in your console, which may require elevated permissions (if on Windows, run command prompt as administrator). `
+    )
+
+    await fs.promises.writeFile(readmePath, README)
+  } catch (error) {
+  }
+
+  try {
+    // Replace all "npm" descriptions/instructions with "yarn". 
+    await new Promise<void>((resolve, reject) => {
+      glob(`{*.md,**!(node_modules)/*.md,src/**/*.{js,jsx,ts,tsx}}`, { cwd }, async (error, files) => {
+        if (error) {
+          reject(error)
+          return
+        }
+
+        const replace = async (file: string) => {
+          const filePath = path.join(cwd, file)
+          const npmContents = await fs.promises.readFile(filePath, `utf8`)
+          const yarnContents = npmContents
+            .replace(/npm run/g, `yarn run`)
+            .replace(/npm start/g, `yarn start`)
+            .replace(/npm install/g, `yarn install`)
+            .replace(/npm version/g, `yarn version`)
+            .replace(/npm test/g, `yarn test`)
+            .replace(/npx cap/g, `yarn run cap`)
+
+          if (npmContents !== yarnContents) {
+            await fs.promises.writeFile(filePath, yarnContents)
+          }
+        }
+
+        await replace(`package.json`)
+
+        try {
+          await fs.promises.access(path.join(cwd, `electron/package.json`), fs.constants.R_OK | fs.constants.W_OK)
+          await replace(`electron/package.json`)
+        } catch (error) {
+        }
+
+        await Promise.all(files.map(file => replace(file)))
+
+        // yarn install
+        // git add yarn.lock
+        // git add electron/yarn.lock
+
+        resolve()
+      })
+    })
+  } catch (error) {
+  }
+}

package/src/commands/utilities/convertTypeDocToJSDoc.ts

@@ -0,0 +1,55 @@
+import fs from 'fs'
+import path from 'path'
+
+/**
+ * A very quick and dirty hacked together script to convert TypeDoc usage to JSDoc.
+ */
+export const convertTypeDocToJSDoc = async (cwd = `.`) => {
+  try {
+    // Replace `typedoc` with `jsdoc` in `package.json`.
+    const packageJsonPath = path.join(cwd, `package.json`)
+    const packageJson = JSON.parse(await fs.promises.readFile(packageJsonPath, `utf8`))
+
+    delete packageJson.devDependencies.typedoc
+    packageJson.devDependencies.jsdoc = `^3.6.10`
+    packageJson.scripts.docs = `jsdoc -r -c jsdoc.json && open-cli ./docs/index.html`
+
+    await fs.promises.writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2))
+  } catch (error) {
+  }
+
+  try {
+    // Replace `typedoc.json` with `jsdoc.json`.
+    await fs.promises.rm(path.join(cwd, `typedoc.json`))
+    await fs.promises.writeFile(path.join(cwd, `jsdoc.json`), JSON.stringify({
+      "source": {
+        "include": "./src",
+        "includePattern": "\\.jsx?$",
+        "excludePattern": "(/|\\\\)__tests__(/|\\\\)|\\.(spec|test)\\.jsx?$"
+      },
+      "opts": {
+        "destination": "./docs",
+        "readme": "./README.md"
+      },
+      "plugins": [
+        "plugins/markdown"
+      ]
+    }, null, 2))
+  } catch (error) {
+  }
+
+  try {
+    // Replace all TypeDoc info with JSDoc.
+    const readmePath = path.join(cwd, `README.md`)
+    let README = await fs.promises.readFile(readmePath, `utf8`)
+
+    README = README
+      .replace(/typedoc\.org/g, `jsdoc.app`)
+      .replace(/TypeDoc\.org/g, `JSDoc.app`)
+      .replace(/typedoc/g, `jsdoc`)
+      .replace(/TypeDoc/g, `JSDoc`)
+
+    await fs.promises.writeFile(readmePath, README)
+  } catch (error) {
+  }
+}