@cmflow/cli 1.1.0 → 1.1.1-alpha.1

package/src/workflow/index.js

@@ -1,42 +1,42 @@
 export const WORKFLOW_CONFIGURATION = [
   {
-    type: 'feat',
-    label: 'Features',
-    release: 'minor'
+    type: "feat",
+    label: "Features",
+    release: "minor"
   },
   {
-    type: 'fix',
-    label: 'Bug Fixes',
-    release: 'patch'
+    type: "fix",
+    label: "Bug Fixes",
+    release: "patch"
   },
   {
-    type: 'chore',
-    label: 'Chores',
+    type: "chore",
+    label: "Chores",
     release: false
   },
   {
-    type: 'ci',
-    label: 'CI',
+    type: "ci",
+    label: "CI",
     release: false
   },
   {
-    type: 'docs',
-    label: 'Documentation',
-    release: 'patch'
+    type: "docs",
+    label: "Documentation",
+    release: "patch"
   },
   {
-    type: 'tech',
-    label: 'Technical Improvements',
-    release: 'patch'
+    type: "tech",
+    label: "Technical Improvements",
+    release: "patch"
   },
   {
-    type: 'refactor',
-    label: 'Technical Improvements',
-    release: 'patch'
+    type: "refactor",
+    label: "Technical Improvements",
+    release: "patch"
   },
   {
-    type: 'default',
-    label: 'Miscellaneous',
+    type: "default",
+    label: "Miscellaneous",
     release: false
   }
-]
+];

package/tsconfig.json

@@ -0,0 +1,54 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "target": "esnext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "sourceMap": true,
+    "declaration": false,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true,
+    "isolatedModules": false,
+    "allowJs": true,
+    "suppressImplicitAnyIndexErrors": false,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": false,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "allowSyntheticDefaultImports": true,
+    "importHelpers": true,
+    "newLine": "LF",
+    "noEmit": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "useDefineForClassFields": false,
+    "lib": [
+      "ESNext",
+      "dom",
+      "ESNext.AsyncIterable"
+    ],
+    "noResolve": false,
+    "preserveConstEnums": true,
+    "verbatimModuleSyntax": true,
+    "outDir": "./dist",
+    "types": [
+      "vitest/globals",
+      "vitest/importMeta",
+      "vite/client",
+      "node",
+      "vitest"
+    ]
+  },
+  "include": [
+    "vite.config.mts",
+    "./src/**",
+    "./src/**/*.spec.js",
+    "./src/**/*.test.js"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/vitest.config.mts

@@ -0,0 +1,10 @@
+// eslint-disable-next-line import/no-unresolved
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node'
+    // ... Specify options here.
+  }
+})

package/bin/cm-publish-pages.js

@@ -1,12 +0,0 @@
-#!/usr/bin/env node
-import commander from 'commander'
-
-import { commands, runCommand } from '../src/index.js'
-
-commander
-  .usage('cmpublishpages [options]')
-  .alias('cm publish-pages')
-  .option('-s, --source <source>', 'Publish given directory on the github pages')
-  .parse(process.argv)
-
-runCommand(commands.PublishPages, commander)

package/semantic.js

@@ -1 +0,0 @@
-export * from './src/semantic-release/actions/index.js'

package/src/commands/publish-pages.js

@@ -1,29 +0,0 @@
-import chalk from 'chalk'
-import figures from 'figures'
-import { ghPagesPublish } from '../semantic-release/utils/ghpages-publish.js'
-
-export class PublishPages {
-  mapContext (commander, context) {
-    return {
-      ...context
-    }
-  }
-
-  prompt (context) {
-    return []
-  }
-
-  getTasks (context) {
-    return [
-      {
-        title: 'Publish github pages',
-        task: () => ghPagesPublish(context)
-      }
-    ]
-  }
-
-  success (context) {
-    // eslint-disable-next-line no-console
-    console.log(chalk.green(figures.tick), 'Github pages deployed')
-  }
-}

package/src/common/cli/heroku.js

@@ -1,21 +0,0 @@
-import { Cli } from './cli.js'
-
-export class HerokuCli extends Cli {
-  constructor () {
-    super('heroku')
-  }
-
-  containerLogin (...args) {
-    return this.run('container:login', ...args)
-  }
-
-  containerPush (...args) {
-    return this.run('container:push', ...args)
-  }
-
-  containerRelease (...args) {
-    return this.run('container:release', ...args)
-  }
-}
-
-export const heroku = new HerokuCli()

package/src/common/cli/heroku.test.js

@@ -1,62 +0,0 @@
-import { beforeEach, describe, expect, it, jest } from '@jest/globals'
-
-jest.unstable_mockModule('execa', () => {
-  const execaMock = jest.fn()
-  execaMock.sync = jest.fn()
-  return { default: execaMock }
-})
-const { default: execa } = await import('execa')
-
-const { Cli } = await import('./cli.js')
-const { heroku } = await import('./heroku.js')
-
-execa.sync.mockImplementation((...args) => {
-  return {
-    stdout: `CMD: ${[].concat(...args.filter(arg => typeof arg === 'string' || Array.isArray(arg))).join(' ')}`
-  }
-})
-
-execa.mockReturnValue({})
-
-describe('HerokuCli', () => {
-  beforeEach(() => {
-    jest.spyOn(Cli, 'getRaw').mockImplementation((...args) => {
-      return `CMD: ${[].concat(...args.filter(arg => typeof arg === 'string' || Array.isArray(arg))).join(' ')}`
-    })
-  })
-  describe('containerLogin', () => {
-    it('should run cmd', () => {
-      const result = heroku.containerLogin('arg').sync()
-
-      expect(result.stdout).toEqual('CMD: heroku container:login arg')
-      expect(execa.sync).toHaveBeenCalledWith('heroku', ['container:login', 'arg'], {
-        cwd: process.cwd(),
-        stdio: 'inherit'
-      })
-    })
-  })
-
-  describe('containerPush', () => {
-    it('should run cmd', () => {
-      const result = heroku.containerPush('arg').sync()
-
-      expect(result.stdout).toEqual('CMD: heroku container:push arg')
-      expect(execa.sync).toHaveBeenCalledWith('heroku', ['container:push', 'arg'], {
-        cwd: process.cwd(),
-        stdio: 'inherit'
-      })
-    })
-  })
-
-  describe('containerRelease', () => {
-    it('should run cmd', () => {
-      const result = heroku.containerRelease('arg').sync()
-
-      expect(result.stdout).toEqual('CMD: heroku container:release arg')
-      expect(execa.sync).toHaveBeenCalledWith('heroku', ['container:release', 'arg'], {
-        cwd: process.cwd(),
-        stdio: 'inherit'
-      })
-    })
-  })
-})

package/src/main.js

@@ -1,10 +0,0 @@
-import * as commands from './commands/index.js'
-
-export * from './workflow/index.js'
-export * from './common/index.js'
-export * from './commands/release.js'
-export * from './semantic-release/get-semantic-config.js'
-
-export {
-  commands
-}

package/src/semantic-release/actions/analyze-commits.js

@@ -1,14 +0,0 @@
-import * as commitAnalyzerPlugins from '@semantic-release/commit-analyzer'
-import { calculateSnapshotVersion } from '../utils/calculate-snapshot-version.js'
-
-export async function analyzeCommits (pluginConfig, context) {
-  if (context.branch && context.branch.type !== 'prerelease') {
-    return commitAnalyzerPlugins.analyzeCommits(pluginConfig, context)
-  }
-  const analyzedCommits = await commitAnalyzerPlugins.analyzeCommits(pluginConfig, context)
-  context.nextRelease = context.nextRelease || {}
-  context.nextRelease.type = analyzedCommits
-  context.nextRelease.version = calculateSnapshotVersion(context)
-  context.lastRelease.version = null
-  return 'patch'
-}

package/src/semantic-release/actions/fail.js

@@ -1,16 +0,0 @@
-import * as githubPlugins from '@semantic-release/github'
-import { git } from '../../common/index.js'
-
-export async function fail (pluginConfig, context) {
-  if (context.branch && context.branch.type !== 'prerelease') {
-    const { tagFormat, config: { ORIGIN } } = context
-
-    try {
-      // eslint-disable-next-line no-template-curly-in-string
-      await git.push('--delete', ORIGIN, tagFormat.replace('${version}', context.nextRelease.version))
-    } catch (er) {
-    }
-
-    await githubPlugins.fail(pluginConfig, context)
-  }
-}

package/src/semantic-release/actions/generate-notes.js

@@ -1,12 +0,0 @@
-import * as releaseNotesPlugins from '@semantic-release/release-notes-generator'
-import { getConfig, npm, yarn } from '../../common/index.js'
-
-export async function generateNotes (pluginConfig, context) {
-  context.config = getConfig()
-  if (context.branch.type === 'release' && !context.config.SKIP_GITHUB_PUBLISH) {
-    if (context.config.HAS_BUILD_CHANGELOG) {
-      await (context.config.HAS_YARN ? yarn : npm).run('build_changelog')
-    }
-    return releaseNotesPlugins.generateNotes(pluginConfig, context)
-  }
-}

package/src/semantic-release/actions/index.js

@@ -1,8 +0,0 @@
-export * from './verify-conditions.js'
-export * from './analyze-commits.js'
-export * from './verify-release.js'
-export * from './generate-notes.js'
-export * from './prepare.js'
-export * from './publish.js'
-export * from './success.js'
-export * from './fail.js'

package/src/semantic-release/actions/prepare.js

@@ -1,114 +0,0 @@
-import { dockerPublish } from '../utils/docker-publish.js'
-import { configureGitWorkspace, getConfig, git, lerna, npm, yarn } from '../../common/index.js'
-import { bumpPackagesVersion } from '../utils/bump-packages-version.js'
-
-async function gitPrepareRelease (pluginConfig, context) {
-  context.config = getConfig()
-  const {
-    logger,
-    config: {
-      CI_NAME,
-      BUILD_NUMBER
-    }
-  } = context
-
-  logger.info('Adding files to commit')
-  git.add('-A').sync()
-
-  logger.info('Get commit stage status')
-  git.status()
-
-  const revisionMessage = `${CI_NAME} build: ${context.branch.name} ${BUILD_NUMBER} ${context.nextRelease.gitTag} [ci skip]`
-
-  logger.info('Commit changes with revision message: ')
-  logger.info(revisionMessage)
-
-  git.commit('-m', revisionMessage).sync()
-
-  logger.success('Change committed')
-}
-
-export async function prepare (pluginConfig, context) {
-  context.config = getConfig()
-  const {
-    branch,
-    config: {
-      RELEASE_CANDIDATE_TAG,
-      HAS_BUILD,
-      HAS_E2E,
-      E2E_CMD,
-      SKIP_DEPLOY,
-      SKIP_E2E,
-      SKIP_GITHUB_PUBLISH,
-      HAS_YARN,
-      HAS_LERNA,
-      BUMP_METHOD,
-      WORKSPACES
-    },
-    logger
-  } = context
-  const pkgManager = HAS_YARN ? yarn : npm
-
-  logger.info(`Start bump version for all packages using method: ${BUMP_METHOD}`)
-
-  switch (BUMP_METHOD) {
-    case 'native':
-      logger.info('Using package manager')
-      npm.newVersion(context.nextRelease.version)
-      break
-    case 'lerna':
-      if (HAS_LERNA) {
-        await lerna.newVersion(context.nextRelease.version)
-      }
-      break
-    case 'cmflow':
-      await bumpPackagesVersion(context.nextRelease.version, WORKSPACES)
-      await pkgManager.install()
-      break
-    case 'native:lerna':
-    default:
-      npm.newVersion(context.nextRelease.version)
-
-      if (HAS_LERNA) {
-        await lerna.newVersion(context.nextRelease.version)
-      }
-  }
-
-  logger.info('Bump version finished with success...')
-
-  if (HAS_BUILD && !SKIP_DEPLOY) {
-    logger.info('Start build task')
-    await pkgManager.run('build')
-    logger.info('Build task finished with success...')
-  } else {
-    logger.info('Skipping build task')
-  }
-
-  if (HAS_E2E && !SKIP_DEPLOY && !SKIP_E2E) {
-    logger.info('Start test_e2e task')
-    await pkgManager.run(E2E_CMD || 'test_e2e')
-    logger.info('test_e2e task finished with success...')
-  } else {
-    logger.info('Skipping test_e2e task')
-  }
-
-  if (!SKIP_GITHUB_PUBLISH) {
-    if (branch.type === 'release') {
-      logger.info('Prepare release')
-      configureGitWorkspace(context)
-      return gitPrepareRelease(pluginConfig, context)
-    }
-
-    const lastCommitMessage = git.getLastCommitMsg()
-    logger.info('Last commit message:', lastCommitMessage)
-    if (lastCommitMessage.includes(RELEASE_CANDIDATE_TAG)) {
-      process.exit(0)
-    }
-  }
-
-  if (!SKIP_DEPLOY) {
-    await dockerPublish(context)
-  }
-  // avoid next semantic-release steps when is a prerelease or release branch with SKIP_GITHUB_PUBLISH
-  process.exit(0)
-}

package/src/semantic-release/actions/publish.js

@@ -1,17 +0,0 @@
-import * as githubPlugins from '@semantic-release/github'
-import { dockerPublish } from '../utils/docker-publish.js'
-import { ghPagesPublish } from '../utils/ghpages-publish.js'
-
-export async function publish (pluginConfig, context) {
-  const { branch, env: { SKIP_GITHUB_PUBLISH, GITHUB_PAGES_PATH } } = context
-
-  if (!SKIP_GITHUB_PUBLISH && branch.type === 'release') {
-    await githubPlugins.publish(pluginConfig, context)
-  }
-
-  if (GITHUB_PAGES_PATH && branch.type === 'release') {
-    await ghPagesPublish(context)
-  }
-
-  await dockerPublish(context)
-}

package/src/semantic-release/actions/success.js

@@ -1,32 +0,0 @@
-import * as githubPlugins from '@semantic-release/github'
-import { dockerCleanTags } from '../utils/docker-clean-tags.js'
-import { getConfig } from '../../common/get-config.js'
-import { git } from '../../common/index.js'
-
-async function githubSuccess (pluginConfig, context) {
-  const { logger, config: { PRODUCTION_BRANCH, ORIGIN, DEVELOP_BRANCH } } = context
-  await git.push('--quiet', '--set-upstream', ORIGIN, PRODUCTION_BRANCH)
-
-  if (PRODUCTION_BRANCH !== DEVELOP_BRANCH) {
-    logger.start(`Reset HEAD of ${ORIGIN}/${DEVELOP_BRANCH} branch to HEAD of  ${ORIGIN}/${PRODUCTION_BRANCH} `)
-    await git.push('-f', ORIGIN, `refs/remotes/${ORIGIN}/${PRODUCTION_BRANCH}:refs/heads/${DEVELOP_BRANCH}`)
-    logger.success(`${ORIGIN}/${DEVELOP_BRANCH} branch correctly updated`)
-  }
-
-  await githubPlugins.success(pluginConfig, context)
-}
-
-export async function success (pluginConfig, context) {
-  context.config = getConfig()
-  const { branch, config: { SKIP_GITHUB_PUBLISH } } = context
-
-  if (branch.type !== 'prerelease' && !SKIP_GITHUB_PUBLISH) {
-    await githubSuccess(pluginConfig, context)
-  }
-
-  try {
-    await dockerCleanTags(context)
-  } catch (er) {
-    context.logger.warn(er)
-  }
-}

package/src/semantic-release/actions/verify-conditions.js

@@ -1,30 +0,0 @@
-import chalk from 'chalk'
-import * as githubPlugins from '@semantic-release/github'
-import { getConfig, git } from '../../common/index.js'
-
-export function verifyConditions (pluginConfig, context) {
-  context.config = getConfig()
-  if (pluginConfig.dryRun) {
-    return
-  }
-
-  const { branch, config: { USER, EMAIL, ORIGIN } } = context
-
-  if (USER && EMAIL) {
-    context.logger.info('Configure git with username')
-
-    git.config('--global', 'user.name', USER)
-    git.config('--global', 'user.email', EMAIL)
-
-    context.logger.info('Configure git branch')
-    context.logger.success('Workspace is correctly configured')
-  } else {
-    context.logger.error(chalk.red('Ignore git configuration (Empty GIT_USER_EMAIL or/and GIT_USER_NAME variables)'))
-    process.exit(1)
-  }
-  git.fetch().sync()
-  git.checkout(branch.name).sync()
-  git.branch(`--set-upstream-to=${ORIGIN}/${branch.name}`, branch.name).sync()
-
-  return githubPlugins.verifyConditions(pluginConfig, context)
-}

package/src/semantic-release/actions/verify-release.js

@@ -1,9 +0,0 @@
-import { displayPackageInfo } from '../utils/display-package-info.js'
-import { displayReleaseInfo } from '../utils/display-release-info.js'
-import { getConfig } from '../../common/index.js'
-
-export function verifyRelease (pluginConfig, context) {
-  context.config = getConfig()
-  displayPackageInfo(context)
-  displayReleaseInfo(context)
-}

package/src/semantic-release/get-semantic-config.js

@@ -1,115 +0,0 @@
-import { getConfig } from '../common/get-config.js'
-import { WORKFLOW_CONFIGURATION } from '../workflow/index.js'
-
-const releaseRules = WORKFLOW_CONFIGURATION.map(({ label, ...props }) => props)
-const commitTypeMapping = WORKFLOW_CONFIGURATION.reduce((obj, { type, label }) => {
-  return {
-    ...obj,
-    [type]: label
-  }
-}, {})
-
-const transformCommitType = commit => {
-  if (commitTypeMapping[commit.type]) {
-    return commitTypeMapping[commit.type]
-  }
-
-  return commitTypeMapping.default
-}
-
-const transform = (commit, context) => {
-  const issues = []
-
-  commit.notes.forEach(note => {
-    note.title = 'BREAKING CHANGES'
-  })
-
-  commit.type = transformCommitType(commit)
-
-  if (commit.message && commit.message.match(/^[\w-]+$/i)) {
-    return
-  }
-
-  if (commit.subject) {
-    commit.subject = commit.subject.replace('[MEP]', '')
-  }
-
-  if (commit.scope === '*') {
-    commit.scope = ''
-  }
-
-  if (typeof commit.hash === 'string') {
-    commit.shortHash = commit.hash.substring(0, 7)
-  }
-
-  if (typeof commit.subject === 'string') {
-    let url = context.repository
-      ? `${context.host}/${context.owner}/${context.repository}`
-      : context.repoUrl
-    if (url) {
-      url = `${url}/issues/`
-      // Issue URLs.
-      commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => {
-        issues.push(issue)
-        return `[#${issue}](${url}${issue})`
-      })
-    }
-    if (context.host) {
-      // User URLs.
-      commit.subject = commit.subject.replace(
-        /\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g,
-        (_, username) => {
-          if (username.includes('/')) {
-            return `@${username}`
-          }
-
-          return `[@${username}](${context.host}/${username})`
-        }
-      )
-    }
-  }
-
-  // remove references that already appear in the subject
-  commit.references = commit.references.filter(reference => {
-    if (issues.indexOf(reference.issue) === -1) {
-      return true
-    }
-
-    return false
-  })
-
-  return commit
-}
-
-export function getSemanticConfig () {
-  const config = getConfig()
-
-  return {
-    noCi: config.PRODUCTION_BRANCH !== config.BRANCH_NAME,
-    branches: [
-      {
-        name: config.PRODUCTION_BRANCH,
-        channel: 'release'
-      },
-      // Use this hack to always run semantic-release (as prerelease for feature/fix branch)
-      {
-        name: config.BRANCH_NAME,
-        channel: 'prerelease',
-        prerelease: true
-      }
-    ],
-    verifyConditions: ['@cmflow/cli/semantic'],
-    analyzeCommits: ['@cmflow/cli/semantic'],
-    verifyRelease: ['@cmflow/cli/semantic'],
-    generateNotes: ['@cmflow/cli/semantic'],
-    prepare: ['@cmflow/cli/semantic'],
-    publish: ['@cmflow/cli/semantic'],
-    success: ['@cmflow/cli/semantic'],
-    fail: ['@cmflow/cli/semantic'],
-    releaseRules,
-    parserOpts: {
-      noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES']
-    },
-    writerOpts: { transform }
-  }
-}