feat: Add CHANGELOG handling by default via conventional-changelog

videojs · May 16, 2017 · c53b6cb · c53b6cb
1 parent 678aca9
commit c53b6cb
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 15 deletions.
diff --git a/docs/conventions.md b/docs/conventions.md
@@ -70,7 +70,7 @@ Folder/Filename            | Optional? | Generated? | Description
 `.editorconfig`            |           | ✓          |
 `.gitignore`               |           | ✓          |
 `.npmignore`               |           | ✓          |
-`CHANGELOG.md`             | ✓         | ?          |
+`CHANGELOG.md`             | ✓         | ✓          |
 `CONTRIBUTING.md`          | ✓         | ✓          | Documents how developers can work on the plugin.
 `index.html`               | ✓         | ✓          | An example of usage of the plugin. This can be used with GitHub pages as well.
 `LICENSE`                  | ✓         | ?          | Defaults to `MIT`.

diff --git a/generators/app/constants.js b/generators/app/constants.js
@@ -44,7 +44,6 @@ module.exports = {
   LICENSE_DEFAULT,
 
   PROMPT_DEFAULTS: {
-    changelog: true,
     docs: false,
     husky: 'lint',
     lang: false,

diff --git a/generators/app/index.js b/generators/app/index.js
@@ -138,11 +138,6 @@ module.exports = yeoman.generators.Base.extend({
       message: 'Choose a license for your project',
       default: defaults.license,
       choices: constants.LICENSE_CHOICES
-    }, {
-      type: 'confirm',
-      name: 'changelog',
-      message: 'Do you want to include CHANGELOG tool?',
-      default: defaults.changelog
     }, {
       type: 'confirm',
       name: 'sass',
@@ -307,10 +302,6 @@ module.exports = yeoman.generators.Base.extend({
      * @function changelog
      */
     changelog() {
-      if (!this.context.changelog) {
-        return;
-      }
-
       try {
         fs.statSync(this._dest('CHANGELOG.md'));
       } catch (x) {

diff --git a/generators/app/package-json.js b/generators/app/package-json.js
@@ -14,6 +14,8 @@ const DEFAULTS = {
     'babel-plugin-transform-object-assign': '^6.8.0',
     'babel-preset-es2015': '^6.14.0',
     'bannerize': '^1.0.2',
+    'conventional-changelog-cli': '^1.3.1',
+    'conventional-changelog-videojs': '^3.0.0',
     'karma': '^1.7.0',
     'karma-chrome-launcher': '^2.1.1',
     'karma-detect-browsers': '^2.2.5',
@@ -33,6 +35,7 @@ const DEFAULTS = {
     'rollup-plugin-node-resolve': '^3.0.0',
     'rollup-plugin-replace': '^1.1.1',
     'rollup-watch': '^3.2.2',
+    'semver': '^5.3.0',
     'sinon': '^2.2.0',
     'uglify-js': '^3.0.7',
     'videojs-standard': '^6.0.0'
@@ -177,6 +180,7 @@ const packageJSON = (current, context) => {
       'pretest': 'npm-run-all lint build',
       'test': 'karma start test/karma.conf.js',
       'preversion': 'npm test',
+      'version': 'node scripts/version.js',
       'watch': 'npm-run-all -p watch:*',
       'watch:js': 'rollup -c scripts/build.rollup.config.js -w',
       'watch:test': 'rollup -c scripts/test.rollup.config.js -w'

diff --git a/generators/app/templates/scripts/_version.js b/generators/app/templates/scripts/_version.js
@@ -0,0 +1,10 @@
+const execSync = require('child_process').execSync;
+const path = require('path');
+const semver = require('semver');
+const pkg = require('../package.json');
+
+if (!semver.prerelease(pkg.version)) {
+  process.chdir(path.resolve(__dirname, '..'));
+  execSync('conventional-changelog -p videojs -i CHANGELOG.md -s');
+  execSync('git add CHANGELOG.md');
+}
diff --git a/package.json b/package.json
@@ -1,11 +1,11 @@
 {
   "name": "generator-videojs-plugin",
   "version": "2.3.0",
-  "description": "A Yeoman generator for VideoJS plugins",
+  "description": "A Yeoman generator for Video.js plugins",
   "license": "Apache-2.0",
   "main": "generators/app/index.js",
   "engine": {
-    "node": ">=4.4.0"
+    "node": ">=4.8.0"
   },
   "bin": {
     "vjsgenclean": "bin/videojs-generator-cleanup.js"
@@ -29,7 +29,7 @@
     "prepush": "npm run lint -- --errors",
     "pretest": "npm run lint",
     "test": "mocha test/*.test.js",
-    "version": "conventional-changelog -p videojs -i CHANGELOG.md -s && git add CHANGELOG.md"
+    "version": "node scripts/version.js"
   },
   "keywords": [
     "yeoman-generator",

diff --git a/scripts/version.js b/scripts/version.js
@@ -0,0 +1,10 @@
+const execSync = require('child_process').execSync;
+const path = require('path');
+const semver = require('semver');
+const pkg = require('../package.json');
+
+if (!semver.prerelease(pkg.version)) {
+  process.chdir(path.resolve(__dirname, '..'));
+  execSync('conventional-changelog -p videojs -i CHANGELOG.md -s');
+  execSync('git add CHANGELOG.md');
+}
diff --git a/test/app.test.js b/test/app.test.js
@@ -19,7 +19,9 @@ describe('videojs-plugin:app', function() {
     'lint',
     'start',
     'test',
-    'preversion'
+    'preversion',
+    'version',
+    'watch'
   ];
 
   describe('defaults', function() {