Feat: write or update changelog, tag new version, release new version (#2)

* Feat: delete node_modules and install node_modules with yarn or npm

* Feat: generate all possibile semver versions from a single version

* Feat: get all commits since the last tag or creation of repo

* Feat: get the latest version from this repo

* Feat: check if a repo already have remotes

* Feat: create or update an CHANGELOG.md

* Feat: task update changelog

* Feat: task delete node_modules and reinstall

* Feat: tasks dir is a repo, has added changes and it has new commits

* Feat: task add, commit, tag and release

* Feat: task npm test

* Feat: update package.json

* Feat: combine all subtasks in main tasks

* Feat: inquirer questions

* Feat: add cli entry point

* Test: add all tests and fixtures

* Fix: isGit on current working dir

* Refactor: change error handling

* Fix: change using current working dir

* Test: update tests

* Chore: allow _ for tests

* Refactor: update tasks

* Chore: update dependencies

* Chore: add prepush hook

* Refactor: update git checks

* Test: update tests and fixtures

* Refactor: update to shellSync

* Fix: remove isGit and update errors

* Fix: remove isGit and update errors

* Fix: update errors

* Fix: update errors

* Refactor: remove duplicate git tasks

* Refactor: remove git tasks

* Chore: update nyc

* Fix: remove console.log

* Docs: add new gif for readme

* Fix: make sure to push all fixtures as they are needed for the tests

* Chore: update dependencies

* Refactor: remove getCommits, getRemotes -> new dependencies

* Refactor: update to use new packages

* Docs: update readme

* Docs: update tasks and fix typos

Author: aichbauer

.eslintrc

@@ -2,5 +2,17 @@
   "extends": "airbnb-base",
   "plugins": [
     "import"
-  ]
+  ],
+  "rules": {
+    "arrow-parens": 0,
+    "no-underscore-dangle": [
+      "error",
+      {
+        "allow": [
+          "_tasks"
+        ],
+        "allowAfterThis": false
+      }
+    ]
+  }
 }

README.md

@@ -1 +1,51 @@
 # semantic-git-release-cli
+
+[![Build Status](https://travis-ci.org/aichbauer/node-semantic-git-release-cli.svg?branch=master)](https://travis-ci.org/aichbauer/node-semantic-git-release-cli)
+[![Build status](https://ci.appveyor.com/api/projects/status/7kedayu8diw41day?svg=true)](https://ci.appveyor.com/project/rudolfsonjunior/node-semantic-git-release-cli)
+[![Coverage Status](https://coveralls.io/repos/github/aichbauer/node-semantic-git-release-cli/badge.svg?branch=master)](https://coveralls.io/github/aichbauer/node-semantic-git-release-cli?branch=master)
+
+> A CLI for semantic releases. Writes a changelog and tags the new version.
+
+<img src="https://raw.githubusercontent.com/aichbauer/node-semantic-git-release-cli/master/media/screenshot.gif">
+
+## Why?
+
+Many projects need versioning. It is always the same: testing, writing the changelog, updating the version, tagging the commit, and finally releasing the new version.
+
+`sgr` will take care of all of them, so you can focus on the more important stuff: **code**
+
+## Installation
+
+```sh
+$ npm i -g semantic-git-release-cli
+```
+
+or
+
+```sh
+$ yarn add global semantic-git-release-cli
+```
+
+## Usage
+
+Forget the times when you had to manually write changelogs, update versions, tag commits. Now just type:
+
+```sh
+$ sgr
+```
+
+or if you already have an alias for sgr, use following instead:
+
+```sh
+$ semantic-git-release
+```
+
+## Tasks
+
+So there are a few tasks `semantic-git-release-cli` will do for you:
+
+- removes and reinstalls `node_modules` (prefers `yarn` by default)
+- runs tests by calling `npm test`
+- updates the `version` in `package.json`
+- creates or updates the `CHANGELOG.md`
+- commits and tags the new `version`

lib/cli.js

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+
+import inquirer from 'inquirer';
+import isAdded from 'is-git-added';
+import isGit from 'is-git-repository';
+import getGitRemotes from 'get-git-remotes';
+import getCommitRange from 'git-commit-range';
+import taggedCommit from 'tagged-git-commit';
+import updateNotifier from 'update-notifier';
+import yargs from 'yargs';
+
+import generateVersions from './helpers/generateVersions';
+import getLatestVersion from './helpers/getLatestVersion';
+import pkg from '../package.json';
+import questions from './questions';
+import tasks from './tasks';
+
+const argv = yargs
+  .usage('Usage: $0')
+  .alias('v', 'version')
+  .describe('v', 'Version number')
+  .help('h')
+  .alias('h', 'help')
+  .argv;
+
+updateNotifier({ pkg }).notify();
+
+const cli = () => {
+  const cwd = process.cwd();
+  const latestTaggedCommit = taggedCommit({ path: cwd });
+  const commits = getCommitRange({ path: cwd, from: latestTaggedCommit });
+  const latestVersion = getLatestVersion();
+  const newVersions = generateVersions(latestVersion);
+  const questionsList = questions(newVersions);
+
+  if (!isGit(cwd)) {
+    return console.warn('Error: this is not a git repository... make sure you are in the right directory');
+  } else if (!isAdded(cwd) && commits.length === 0) {
+    return console.warn('Error: no changes... try to git add <files>');
+  } else if (commits.length === 0) {
+    return console.warn('Error:  no commits yet... try to git commit -m <message>');
+  } else if (!getGitRemotes(cwd)) {
+    return console.warn('Error: it seems you do not have a remote repository set... try to git remote add origin <remote-url>');
+  }
+
+  return inquirer
+    .prompt(questionsList)
+    .then((answers) => {
+      if (answers.ownVersion) {
+        return tasks(commits, answers.ownVersion)
+          .run()
+          .catch(() => console.warn('Error: whoops, try to solve the problem mentioned above...'));
+      }
+
+      return tasks(commits, answers.version)
+        .run()
+        .catch(() => console.warn('Error: whoops, try to solve the problem mentioned above...'));
+    })
+    .catch((err) => console.warn(err));
+};
+
+if (argv.v) {
+  console.info(`v${pkg.version}`);
+} else {
+  cli();
+}

lib/helpers/cleanNodeModules.js

@@ -0,0 +1,22 @@
+import execa from 'execa';
+import fs from 'fs-extra';
+import path from 'path';
+
+const deleteNodeModules = () => {
+  const cwd = process.cwd();
+
+  return fs.removeSync(path.join(cwd, 'node_modules'));
+};
+
+const installNodeModules = (hasYarn) => {
+  if (hasYarn) {
+    return execa.shellSync('yarn');
+  }
+
+  return execa.shellSync('npm i');
+};
+
+export {
+  deleteNodeModules,
+  installNodeModules,
+};

lib/helpers/generateVersions.js

@@ -0,0 +1,22 @@
+import semver from 'semver';
+
+const versions = (latestVersion) => {
+  const patch = semver.inc(latestVersion, 'patch');
+  const minor = semver.inc(latestVersion, 'minor');
+  const major = semver.inc(latestVersion, 'major');
+  const prereleaseAlpha = semver.inc(latestVersion, 'prerelease', 'alpha');
+  const prereleaseBeta = semver.inc(latestVersion, 'prerelease', 'beta');
+  const prereleaseRC = semver.inc(latestVersion, 'prerelease', 'rc');
+
+  return [
+    patch,
+    minor,
+    major,
+    prereleaseAlpha,
+    prereleaseBeta,
+    prereleaseRC,
+    'Other (specify)',
+  ];
+};
+
+export default versions;

lib/helpers/getLatestVersion.js

@@ -0,0 +1,38 @@
+import taggedCommits from 'tagged-git-commit';
+import path from 'path';
+import fs from 'fs-extra';
+
+const getLatestVersion = () => {
+  const cwd = process.cwd();
+  const exitstsPkg = fs.existsSync(path.join(cwd, 'package.json'));
+
+  if (!exitstsPkg) {
+    return '';
+  }
+
+  const pkg = fs.readJsonSync(path.join(cwd, 'package.json'));
+  const latestPkgVersion = pkg.version;
+  const latestTag = taggedCommits({ path: cwd });
+
+  let latestVersion;
+  let latestTaggedVersion;
+
+  if (latestTag[0]) {
+    latestTaggedVersion = latestTag[0].split('refs/tags/')[1];
+  } else {
+    latestTaggedVersion = undefined;
+  }
+
+  if (`v${latestPkgVersion}` !== `${latestTaggedVersion}`
+    && latestTaggedVersion === undefined) {
+    latestVersion = `v${latestPkgVersion}`;
+  } else if (`v${latestPkgVersion}` === `${latestTaggedVersion}`) {
+    latestVersion = `v${latestPkgVersion}`;
+  } else {
+    latestVersion = '';
+  }
+
+  return latestVersion;
+};
+
+export default getLatestVersion;

lib/helpers/updateChangelog.js

@@ -0,0 +1,45 @@
+import fs from 'fs';
+import gitCommitInfo from 'git-commit-info';
+import moment from 'moment';
+import path from 'path';
+
+const writeToFile = (commits = [], version, exists) => {
+  const cwd = process.cwd();
+
+  let changelogData;
+
+  if (exists) {
+    const changelog = fs.readFileSync(path.join(cwd, 'CHANGELOG.md'), 'utf8');
+    changelogData = `\n${changelog}`;
+  } else {
+    changelogData = '';
+  }
+
+  const stream = fs.createWriteStream(path.join(cwd, 'CHANGELOG.md'), 'utf8');
+
+  stream.write(`${version} - ${moment().format('MMMM, DD YYYY')}\n\n`);
+
+  commits.forEach((commithash) => {
+    const commitInfo = gitCommitInfo({ commit: commithash, cwd });
+
+    stream.write(`* ${commitInfo.shortHash} ${commitInfo.message} (${commitInfo.author})\n`);
+  });
+
+  stream.write(changelogData);
+
+  return stream.end();
+};
+
+const updateChangelog = (commits = [], version) => {
+  try {
+    const cwd = process.cwd();
+
+    const exists = fs.existsSync(path.join(cwd, 'CHANGELOG.md'));
+
+    return writeToFile(commits, version, exists);
+  } catch (err) {
+    return false;
+  }
+};
+
+export default updateChangelog;

lib/questions.js

@@ -0,0 +1,20 @@
+const questions = (versions) => {
+  const questionsList = [
+    {
+      type: 'list',
+      name: 'version',
+      message: 'Select semver increment or specify new version:',
+      choices: versions,
+    },
+    {
+      type: 'input',
+      name: 'ownVersion',
+      message: 'Version',
+      when: answers => answers.version === versions[versions.length - 1],
+    },
+  ];
+
+  return questionsList;
+};
+
+export default questions;

lib/sub-tasks/changelog.js

@@ -0,0 +1,20 @@
+import Listr from 'listr';
+
+import updateChangelog from '../helpers/updateChangelog';
+
+const changelogTasks = (commits, version) => (
+  new Listr([
+    {
+      title: 'generate or update changelog',
+      task: () => {
+        const updated = updateChangelog(commits, version);
+
+        if (updated === 'could not write') {
+          throw new Error('could not write CHANGELOG.md... make sure you have write and read access to it');
+        }
+      },
+    },
+  ])
+);
+
+export default changelogTasks;

lib/sub-tasks/cleanup.js

@@ -0,0 +1,36 @@
+import Listr from 'listr';
+import hasYarn from 'has-yarn';
+import fs from 'fs-extra';
+import path from 'path';
+import {
+  deleteNodeModules,
+  installNodeModules,
+} from '../helpers/cleanNodeModules';
+
+const cleanup = () => {
+  const cwd = process.cwd();
+  return new Listr([
+    {
+      title: 'check package.json',
+      task: () => (
+        fs
+          .pathExists(path.join(cwd, 'package.json'))
+          .then((exists) => {
+            if (!exists) {
+              throw new Error('Error: no package.json found... make sure you are in the correct directory');
+            }
+          })
+      ),
+    },
+    {
+      title: 'delete node_modules',
+      task: () => deleteNodeModules(),
+    },
+    {
+      title: 'install dependencies',
+      task: () => installNodeModules(hasYarn),
+    },
+  ]);
+};
+
+export default cleanup;

lib/sub-tasks/release.js

@@ -0,0 +1,49 @@
+import execa from 'execa';
+import Listr from 'listr';
+
+const releaseTasks = (version) => (
+  new Listr([
+    {
+      title: 'git add CHANGELOG.md and package.json',
+      task: /* istanbul ignore next */ () => (
+        execa
+          .shell('git add .')
+          .catch(() => {
+            throw new Error('Error: could not git add <files>');
+          })
+      ),
+    },
+    {
+      title: 'git commit CHANGELOG.md and package.json',
+      task: /* istanbul ignore next */ () => (
+        execa
+          .shell(`git commit -m "${version}"`)
+          .catch(() => {
+            throw new Error('Error: could not git commit -m <message>');
+          })
+      ),
+    },
+    {
+      title: `git tag -a v${version} -m ${version}`,
+      task: /* istanbul ignore next */ () => (
+        execa
+          .shell(`git tag -a v${version} -m ${version}`)
+          .catch(() => {
+            throw new Error(`Error: could not tag with v${version}... make sure this version is not tagged already`);
+          })
+      ),
+    },
+    {
+      title: `release new version v${version}`,
+      task: /* istanbul ignore next */ () => (
+        execa
+          .shell('git push --follow-tags')
+          .catch(() => {
+            throw new Error('Error: could not push to remote repository... make sure you have access to it');
+          })
+      ),
+    },
+  ])
+);
+
+export default releaseTasks;