@cmflow/cli 0.65.1

package/README.md

@@ -0,0 +1,106 @@
+<h1 style="text-align: center" align="center">CMFLOW</h1>
+
+<div align="center">
+
+   <hr />
+
+[![npm version](https://badge.fury.io/js/%40cmflow%cli.svg)](https://badge.fury.io/js/%40cmflow%2Fcli)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+</div>
+
+<hr />
+
+```
+npm i -g @cmflow/cli
+ ```
+
+## CmFlow release
+### Installation
+
+CmFlow is compatible with [semantic-release](https://github.com/semantic-release/semantic-release) 📦🚀. You can use
+CmFlow release to deploy your projects based on CmFlow convention.
+
+Add the cmflow to your project:
+
+```
+npm i --save-dev @cmflow/cli
+```
+
+Then create `release.config.js` with this configuration:
+
+```javascript
+const { getSemanticConfig } = require('@cmflow/cli')
+
+module.exports = {
+  ...getSemanticConfig(),
+  // Additional semantic configuration props
+  npmPublish: false
+}
+```
+
+Then edit your `package.json` add the following tasks on script property:
+
+```json
+{
+  "script": {
+    "release": "cmrelease",
+    "release_dry_run": "cmrelease --dry-run"
+  }
+}
+```
+
+Now, CmFlow and semantic release are correctly installed on your project.
+
+### Build and E2E Test
+
+CmFlow release are able to run `build` and `test_e2e` task during the deploy process. It's useful when you want to
+deploy a docker image on docker hub with the right revision number in the `package.json`. The only requirement, is to
+have a `build` and `test_e2e` tasks in you npm scripts.
+
+Example:
+
+```json
+{
+  "scripts": {
+    "build": "docker-compose build",
+    "test_e2e": "docker-compose up -d && sleep 10 && npm run test_cucumber && docker-compose stop"
+  }
+}
+```
+
+### Generate changelog
+
+CmFlow release call also a npm task `build_changelog` to let you generate the changelog file with your preferred tool.
+
+Example:
+
+```json
+{
+  "scripts": {
+    "build_changelog": "conventional-changelog --preset angular --release-count 0 --outfile ./CHANGELOG.md",
+    "build_changelog": "cmchangelog"
+  }
+}
+```
+
+### Configure CI
+
+CmFlow release can be used with Travis CI, Circle CI and GitLab. You have to create these environments variables to
+allow git release note deployment, commit push and docker image deployment.
+
+| Variable            | Description                                                                                                               |
+|---------------------|---------------------------------------------------------------------------------------------------------------------------|
+| PROJECT_NAME        | The project to publish artifact on docker                                                                                 |
+| GH_TOKEN            | A GitHub [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line). |
+| GIT_USER_EMAIL      | User mail to sign the commit produced by CmFlow release                                                                   |
+| GIT_USER_NAME       | User name to sign the commit produced by CmFlow release                                                                   |
+| DEPLOY_ON_DOCKER    | Set 1 to deploy on docker                                                                                                 |
+| DOCKER_HUB_ID       | The docker hub id                                                                                                         |
+| DOCKER_HUB_PWD      | The docker password account                                                                                               |
+| HEROKU_APP          | Enable deployment on heroku. Note: You have to configure HEROKU_API_KEY token on your CI                                  |
+| SKIP_DEPLOY         | Skip all deployment task (docker, heroku).                                                                                |
+| SKIP_GITHUB_PUBLISH | Skip tag and release note publication on Github.                                                                          |
+| GITHUB_PAGES_PATH   | Path to the front-end artifact. Enable github pages deployment.                                                           |
+

package/bin/checkfeatures.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+git fetch --all --prune --tags
+for branch in `git branch -r | grep -v HEAD`;do echo -e `git show --format="%ci %cr %an" $branch | head -n 1` \\t$branch; done | sort -r

package/bin/cm-changelog.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+commander
+  .usage('cmchangelog [options]')
+  .alias('cm changelog')
+  .option('-p, --preset <preset>', 'Name of the preset you want to use. Must be one of the following:\n' +
+    'angular, atom, codemirror, ember, eslint, express, jquery, jscs or jshint', 'angular')
+  .option('-r, --release-count <count>', 'How many releases to be generated from the latest\n' +
+    'If 0, the whole changelog will be regenerated and the outfile will be overwritten\n' +
+    'Default: 0', 0)
+  .option('-t, --tag-prefix <prefix>', 'Tag prefix to consider when reading the tags')
+  .parse(process.argv)
+
+runCommand(commands.Changelog, commander)

package/bin/cm-clean.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+commander
+  .usage('cmclean <action> options]')
+  .alias('cm clean')
+  .parse(process.argv)
+
+runCommand(commands.Clean, commander)

package/bin/cm-config.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+commander
+  .usage('cmconfig')
+  .alias('cm config')
+  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
+  .parse(process.argv)
+
+runCommand(commands.Config, {
+  verbose: commander.verbose
+})
+require('../src').release()

package/bin/cm-deploy.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+commander
+  .usage('cmdeploy [options]')
+  .alias('cm deploy')
+  .option('-t, --target <target>', 'Deploy on docker hub/Heroku (docker, heroku)')
+  .parse(process.argv)
+
+runCommand(commands.Deploy, commander)

package/bin/cm-fetch.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+commander
+  .usage('cmfetch [options]')
+  .alias('cm fetch')
+  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
+  .parse(process.argv)
+
+runCommand(commands.Fetch, commander)

package/bin/cm-finish.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+commander
+  .usage('cmfinish [options]')
+  .alias('cm finish')
+  .option('-t, --unit-test', 'Run unit test', (v, t) => t + 1, 0)
+  .option('-c, --cucumber', 'Run cucumber', (v, t) => t + 1, 0)
+  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
+  .parse(process.argv)
+
+runCommand(commands.Finish, commander)

package/bin/cm-publish-pages.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+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/bin/cm-publish.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+commander
+  .usage('cmpublish [options]')
+  .alias('cm publish')
+  .option('-t, --unit-test', 'Run unit test', (v, t) => t + 1, 0)
+  .option('-c, --cucumber', 'Run cucumber', (v, t) => t + 1, 0)
+  .option('-f, --force', 'Force push', (v, t) => t + 1, 0)
+  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
+  .parse(process.argv)
+
+runCommand(commands.Push, commander)

package/bin/cm-push.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+commander
+  .usage('cmpush [options]')
+  .alias('cm push')
+  .option('-t, --unit-test', 'Run unit test', (v, t) => t + 1, 0)
+  .option('-c, --cucumber', 'Run cucumber', (v, t) => t + 1, 0)
+  .option('-f, --force', 'Force push', (v, t) => t + 1, 0)
+  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
+  .parse(process.argv)
+
+runCommand(commands.Push, commander)

package/bin/cm-rebase.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+commander
+  .usage('cmrebase [options]')
+  .alias('cm rebase')
+  .option('-t, --unit-test', 'Run unit test', (v, t) => t + 1, 0)
+  .option('-c, --cucumber', 'Run cucumber', (v, t) => t + 1, 0)
+  .option('-f, --force', 'Force push', (v, t) => t + 1, 0)
+  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
+  .parse(process.argv)
+
+runCommand(commands.Rebase, commander)

package/bin/cm-republish.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+commander
+  .usage('cmrepublish [options]')
+  .alias('cm republish')
+  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
+  .parse(process.argv)
+
+runCommand(commands.Republish, commander)

package/bin/cm-start.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+const commander = require('commander')
+const { commands, runCommand } = require('../src')
+
+const options = {}
+
+commander
+  .usage('cmstart [branchName]')
+  .arguments('[branchName]')
+  .alias('cm start')
+  .option('-v, --verbose', 'Enable verbose log', (v, t) => t + 1, 0)
+  .action((branchName) => {
+    options.branchName = branchName
+  })
+  .parse(process.argv)
+
+runCommand(commands.Start, {
+  ...options,
+  verbose: commander.verbose
+})

package/bin/cm.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+const commander = require('commander')
+const cliPkg = require('../package.json')
+
+commander
+  .version(cliPkg.version)
+  .command('finish', 'Rebase the branch, add [MEP] tag on latest commit and push it')
+  .command('changelog', 'Update changelog file for the project')
+  .command('start', 'Create a new branch from the latest commit of production branch')
+  .command('push', 'Rebase the current branch from production and push all commit')
+  .command('publish', 'Rebase the current branch from production and push all commit (alias of cm push)')
+  .command('republish', 'Rebase all branches from production')
+  .command('publish-pages', 'Publish github pages')
+  .command('deploy', 'Deploy app on docker hub/Heroku')
+  .command('rebase', 'Rebase the current branch from production')
+  .command('fetch', 'Download objects and refs from repository (--all and --prune)')
+  .command('clean', 'Clean deployed docker image on Docker hub')
+  .command('config', 'Configure git workspace with expected information')
+  .parse(process.argv)

package/bin/cmexpedit.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -e
+git fetch --all --prune --tags
+FEATURE_BRANCH=$(git rev-parse --abbrev-ref HEAD)
+npm version patch
+git push -u -f origin "${FEATURE_BRANCH}"
+echo "${FEATURE_BRANCH}" ' PUBLISH DONE'
+echo 'End publishfeat'
+exit 0

package/bin/cmpull.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -e
+
+git fetch --all --prune --tags
+git branch -D $1 | echo 'existing locale branch' $1 'deleted'
+git checkout origin/$1 --track
+echo 'BRANCH ' $1 ' RETRIEVE DONE'

package/bin/cmrelease.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../src').release()

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@cmflow/cli",
+  "version": "0.65.1",
+  "description": "An awesome Git Flow",
+  "author": "camfou",
+  "license": "MIT",
+  "email": "camfou@gmail.com",
+  "main": "./src/index.js",
+  "module": "./src/main.js",
+  "private": false,
+  "bin": {
+    "cm": "./bin/cm.js",
+    "cmfetch": "bin/cm-fetch.js",
+    "cmrebase": "bin/cm-rebase.js",
+    "cmfinish": "bin/cm-finish.js",
+    "cmexpedit": "./bin/cmexpedit.sh",
+    "cmpublish": "bin/cm-publish.js",
+    "cmrepublish": "bin/cm-republish.js",
+    "cmpush": "bin/cm-push.js",
+    "cmpull": "./bin/cmpull.sh",
+    "cmstart": "bin/cm-start.js",
+    "checkfeatures": "./bin/checkfeatures.sh",
+    "cmrelease": "./bin/cmrelease.js",
+    "cmchangelog": "bin/cm-changelog.js",
+    "cmconfig": "bin/cm-config.js"
+  },
+  "dependencies": {
+    "@samverschueren/stream-to-observable": "0.3.1",
+    "axios": "^0.21.0",
+    "chalk": "^4.1.0",
+    "commander": "5.1.0",
+    "conventional-changelog": "3.1.24",
+    "conventional-changelog-cli": "2.1.1",
+    "esm": "3.2.25",
+    "execa": "^4.0.2",
+    "figures": "3.2.0",
+    "has-yarn": "^2.1.0",
+    "inquirer": "7.3.3",
+    "listr": "0.14.3",
+    "lodash": "4.17.20",
+    "rxjs": "6.6.3",
+    "semantic-release": "17.3.0",
+    "semver": "7.3.4",
+    "split": "1.0.1"
+  },
+  "devDependencies": {
+    "@babel/core": "7.12.10",
+    "@babel/preset-env": "7.12.11",
+    "babel-jest": "26.6.3",
+    "eslint": "7.15.0",
+    "eslint-config-standard": "16.0.2",
+    "eslint-plugin-import": "2.22.1",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-promise": "4.2.1",
+    "eslint-plugin-standard": "4.0.2",
+    "husky": "4.3.6",
+    "jest": "^24.9.0",
+    "jest-junit": "^11.0.1",
+    "lint-staged": "10.5.3"
+  },
+  "peerDependencies": {
+    "@semantic-release/commit-analyzer": "8.0.1",
+    "@semantic-release/github": "7.0.7",
+    "@semantic-release/release-notes-generator": "9.0.1"
+  },
+  "scripts": {
+    "test": "yarn lint && yarn test_unit",
+    "test_unit": "jest",
+    "lint": "eslint -c .eslintrc src/**",
+    "lint_ci": "eslint -c .eslintrc src/** --format junit --output-file ./reports/eslint.xml",
+    "lint_fix": "eslint -c .eslintrc src/** --fix",
+    "release": "node bin/cmrelease.js",
+    "release_dry_run": "node bin/cmrelease.js --dry-run",
+    "build_changelog": "node bin/cm-changelog.js"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "post-commit": "git update-index --again"
+    }
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint -c .eslintrc --fix",
+      "git add"
+    ]
+  }
+}

package/release.config.js

@@ -0,0 +1,19 @@
+process.env.PRODUCTION_BRANCH = 'master'
+process.env.DEVELOP_BRANCH = 'master'
+process.env.DEPLOY_ON_DOCKER = 'false'
+
+module.exports = {
+  branch: 'master',
+  plugins: [
+    './semantic'
+  ],
+  verifyConditions: ['./semantic'],
+  analyzeCommits: ['./semantic'],
+  verifyRelease: ['./semantic'],
+  generateNotes: ['./semantic'],
+  prepare: ['./semantic'],
+  publish: ['./semantic'],
+  success: ['./semantic'],
+  fail: ['./semantic'],
+  npmPublish: false
+}

package/semantic.js

@@ -0,0 +1 @@
+module.exports = require('./src/semantic-release/actions')

package/src/commands/changelog.js

@@ -0,0 +1,47 @@
+import conventionalChangelog from 'conventional-changelog'
+import { Observable } from 'rxjs'
+import { createWriteStream } from 'fs'
+
+export class Changelog {
+  mapContext (commander, config) {
+    return {
+      preset: commander.preset || 'angular',
+      releaseCount: commander.releaseCount || 0,
+      outfile: `${process.cwd()}/CHANGELOG.md`,
+      // eslint-disable-next-line no-template-curly-in-string
+      tagPrefix: (config.tagFormat || commander.tagPrefix || '').replace('${version}', '')
+    }
+  }
+
+  exec ({ preset, releaseCount, outfile, tagPrefix }) {
+    const writableStream = createWriteStream(outfile, { encoding: 'utf8' })
+
+    return new Observable(observer => {
+      const stream = conventionalChangelog({
+        preset,
+        releaseCount,
+        path: `${process.cwd()}/package.json`,
+        tagPrefix
+      })
+
+      stream.pipe(writableStream)
+
+      stream.on('error', (err) => {
+        observer.error(err)
+      })
+
+      stream.on('end', () => {
+        observer.complete()
+      })
+    })
+  }
+
+  getTasks (ctx) {
+    return [
+      {
+        title: 'Generate changelog',
+        task: () => this.exec(ctx)
+      }
+    ]
+  }
+}

package/src/commands/clean.js

@@ -0,0 +1,30 @@
+
+import chalk from 'chalk'
+import figures from 'figures'
+import { dockerCleanTags } from '../semantic-release/utils/docker-clean-tags'
+
+export class Clean {
+  mapContext (commander, context) {
+    return {
+      ...context
+    }
+  }
+
+  prompt (context) {
+    return []
+  }
+
+  getTasks (context) {
+    return [
+      {
+        title: 'Clean docker tags',
+        task: () => dockerCleanTags(context)
+      }
+    ]
+  }
+
+  success (context) {
+    // eslint-disable-next-line no-console
+    console.log(chalk.green(figures.tick), 'Docker tags cleaned')
+  }
+}

package/src/commands/config.js

@@ -0,0 +1,23 @@
+import { configureGitWorkspace, getConfig } from '../common'
+
+export class Config {
+  mapContext (commander, context) {
+    return {
+      ...context,
+      config: getConfig()
+    }
+  }
+
+  prompt () {
+    return []
+  }
+
+  getTasks (context) {
+    return [
+      {
+        title: 'Configure workspace',
+        task: () => configureGitWorkspace(context)
+      }
+    ]
+  }
+}

package/src/commands/deploy.js

@@ -0,0 +1,39 @@
+import chalk from 'chalk'
+import figures from 'figures'
+import { deployOnDockerHub, deployOnHeroku } from '../semantic-release/utils/docker-publish'
+import { getConfig } from '../common'
+
+export class Deploy {
+  mapContext (commander, context) {
+    return {
+      ...context,
+      target: commander.target,
+      config: getConfig()
+    }
+  }
+
+  prompt (context) {
+    return []
+  }
+
+  getTasks (context) {
+    return [
+      {
+        title: `Deploy on ${context.target}`,
+        task: () => {
+          switch (context.target) {
+            case 'docker':
+              return deployOnDockerHub(context)
+            case 'heroku':
+              return deployOnHeroku(context)
+          }
+        }
+      }
+    ]
+  }
+
+  success (context) {
+    // eslint-disable-next-line no-console
+    console.log(chalk.green(figures.tick), 'Github pages deployed')
+  }
+}

package/src/commands/fetch.js

@@ -0,0 +1,21 @@
+import { refreshRepository } from './tasks/refresh-repository'
+
+export class Fetch {
+  mapContext (commander, context) {
+    return {
+      ...context,
+      output: []
+    }
+  }
+
+  getTasks (context) {
+    return [
+      refreshRepository(context)
+    ]
+  }
+
+  success (context) {
+    // eslint-disable-next-line no-console
+    console.log(context.output.filter(l => !l.match('Fetching')).join('\n'))
+  }
+}

package/src/commands/finish.js

@@ -0,0 +1,44 @@
+import chalk from 'chalk'
+import figures from 'figures'
+import { Rebase } from './rebase'
+import { git } from '../common/cli/git'
+import { pushBranch } from './tasks/push-branch'
+
+export class Finish extends Rebase {
+  mapContext (commander, context) {
+    return {
+      ...super.mapContext(commander, context),
+      checkStatus: true,
+      force: true
+    }
+  }
+
+  verifyConditions (context) {
+    // Can't finish a production branch
+    if (context.featureBranch === context.fromBranch) {
+      // eslint-disable-next-line no-console
+      console.error(chalk.red(`${figures.cross} ${context.fromBranch} cannot be finished`))
+      process.exit(1)
+    }
+  }
+
+  getTasks (context) {
+    return [
+      ...super.getTasks(context),
+      {
+        title: `Add ${context.RELEASE_CANDIDATE_TAG} on last commit`,
+        task () {
+          const message = `${git.getLastCommitMsg()} ${context.RELEASE_CANDIDATE_TAG}`
+
+          return git.commit('--amend', '-m', message).toObservable()
+        }
+      },
+      pushBranch(context)
+    ]
+  }
+
+  success (context) {
+    // eslint-disable-next-line no-console
+    console.log(chalk.green(figures.tick), 'Branch', chalk.green(context.featureBranch), 'is finished')
+  }
+}

package/src/commands/index.js

@@ -0,0 +1,10 @@
+export * from './changelog'
+export * from './finish'
+export * from './fetch'
+export * from './push'
+export * from './start'
+export * from './republish'
+export * from './rebase'
+export * from './publish-pages'
+export * from './clean'
+export * from './deploy'