chore: restructure build commands

- move dtslint (checkTypes) away from Gruntfile.js (as it disturbs debugging `grunt`) and call it directly as npm-script in travis-ci - re-group task definition in Gruntfile.js - use a multi-job travis build to run linting, format, dtslint and tests in parallel - run only "npm test" on appveyor - rename Grunt-tasks for be more descriptive - SAUCE_USERNAME is not a secret variable anymore it can be easily guessed anyway and the [secure] value messes up with a lot of the log output - linting on commit disable during transition
handlebars-lang · Dec 3, 2019 · e913dc5 · e913dc5
1 parent 1f61f21
commit e913dc5
Show file tree

Hide file tree

Showing 7 changed files with 310 additions and 62 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,28 +1,47 @@
 language: node_js
-before_install:
-- npm install -g grunt-cli
-script:
-- npm run lint
-- npm run check-format
-- grunt --stack travis
+
+jobs:
+  include:
+    - stage: test
+      name: "check javascript (eslint)"
+      node_js: lts/*
+      script: npm run lint
+
+    - stage: test
+      name: "check formatting (prettier)"
+      node_js: lts/*
+      script: npm run check-format
+
+    - stage: test
+      name: "check typescript definitions (dtslint)"
+      node_js: lts/*
+      script: npm run dtslint
+
+    - stage: test
+      name: "extensive tests and publish to aws"
+      script: npm run extensive-tests-and-publish-to-aws
+      env:
+        - S3_BUCKET_NAME=builds.handlebarsjs.com
+        - secure: ckyEe5dzjdFDjmZ6wIrhGm0CFBEnKq8c1dYptfgVV/Q5/nJFGzu8T0yTjouS/ERxzdT2H327/63VCxhFnLCRHrsh4rlW/rCy4XI3O/0TeMLgFPa4TXkO8359qZ4CB44TBb3NsJyQXNMYdJpPLTCVTMpuiqqkFFOr+6OeggR7ufA=
+        - secure: Nm4AgSfsgNB21kgKrF9Tl7qVZU8YYREhouQunFracTcZZh2NZ2XH5aHuSiXCj88B13Cr/jGbJKsZ4T3QS3wWYtz6lkyVOx3H3iI+TMtqhD9RM3a7A4O+4vVN8IioB2YjhEu0OKjwgX5gp+0uF+pLEi7Hpj6fupD3AbbL5uYcKg8=
+        - SAUCE_USERNAME=handlebars
+        - secure: yERYCf7AwL11D9uMtacly/THGV8BlzsMmrt+iQVvGA3GaY6QMmfYqf6P6cCH98sH5etd1Y+1e6YrPeMjqI6lyRllT7FptoyOdHulazQe86VQN4sc0EpqMlH088kB7gGjTut9Z+X9ViooT5XEh9WA5jXEI9pXhQJNoIHkWPuwGuY=
+      node_js: "10"
+
+    - stage: test
+      name: "test with latest nodejs-lts"
+      node_js: lts/*
+      script: npm run test
+
+    - stage: test
+      name: "test with active nodejs"
+      node_js: node
+      script: npm run test
+
+cache: npm
 email:
   on_failure: change
   on_success: never
-env:
-  global:
-  - S3_BUCKET_NAME=builds.handlebarsjs.com
-  - secure: ckyEe5dzjdFDjmZ6wIrhGm0CFBEnKq8c1dYptfgVV/Q5/nJFGzu8T0yTjouS/ERxzdT2H327/63VCxhFnLCRHrsh4rlW/rCy4XI3O/0TeMLgFPa4TXkO8359qZ4CB44TBb3NsJyQXNMYdJpPLTCVTMpuiqqkFFOr+6OeggR7ufA=
-  - secure: Nm4AgSfsgNB21kgKrF9Tl7qVZU8YYREhouQunFracTcZZh2NZ2XH5aHuSiXCj88B13Cr/jGbJKsZ4T3QS3wWYtz6lkyVOx3H3iI+TMtqhD9RM3a7A4O+4vVN8IioB2YjhEu0OKjwgX5gp+0uF+pLEi7Hpj6fupD3AbbL5uYcKg8=
-matrix:
-  include:
-  - node_js: '10'
-    env:
-    - PUBLISH=true
-    - secure: pLTzghtVll9yGKJI0AaB0uI8GypfWxLTaIB0ZL8//yN3nAEIKMhf/RRilYTsn/rKj2NUa7vt2edYILi3lttOUlCBOwTc9amiRms1W8Lwr/3IdWPeBLvLuH1zNJRm2lBAwU4LBSqaOwhGaxOQr6KHTnWudhNhgOucxpZfvfI/dFw=
-    - secure: yERYCf7AwL11D9uMtacly/THGV8BlzsMmrt+iQVvGA3GaY6QMmfYqf6P6cCH98sH5etd1Y+1e6YrPeMjqI6lyRllT7FptoyOdHulazQe86VQN4sc0EpqMlH088kB7gGjTut9Z+X9ViooT5XEh9WA5jXEI9pXhQJNoIHkWPuwGuY=
-cache:
-  directories:
-  - node_modules
 
 git:
   depth: 100
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -12,15 +12,16 @@ Documentation issues on the handlebarsjs.com site should be reported on [handleb
 
 ## Branches
 
-* The branch `4.x` contains the currently released version. Bugfixes should be made in this branch.
-* The branch `master` contains the next version. A release date is not yet specified. Maintainers
+- The branch `4.x` contains the currently released version. Bugfixes should be made in this branch.
+- The branch `master` contains the next version. A release date is not yet specified. Maintainers
   should merge the branch `4.x` into the master branch regularly.
 
 ## Pull Requests
 
 We also accept [pull requests][pull-request]!
 
 Generally we like to see pull requests that
+
 - Maintain the existing code style
 - Are focused on a single change (i.e. avoid large refactoring or style adjustments in untouched code if not the primary goal of the pull request)
 - Have [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
@@ -31,8 +32,8 @@ Generally we like to see pull requests that
 
 To build Handlebars.js you'll need a few things installed.
 
-* Node.js
-* [Grunt](http://gruntjs.com/getting-started)
+- Node.js
+- [Grunt](http://gruntjs.com/getting-started)
 
 Before building, you need to make sure that the Git submodule `spec/mustache` is included (i.e. the directory `spec/mustache` should not be empty). To include it, if using Git version 1.6.5 or newer, use `git clone --recursive` rather than `git clone`. Or, if you already cloned without `--recursive`, use `git submodule update --init`.
 
@@ -51,22 +52,43 @@ If you notice any problems, please report them to the GitHub issue tracker at
 ##Running Tests
 
 To run tests locally, first install all dependencies.
+
 ```sh
 npm install
 ```
 
 Clone the mustache specs into the spec/mustache folder.
+
 ```sh
 cd spec
 rm -r mustache
 git clone https://github.com/mustache/spec.git mustache
 ```
 
 From the root directory, run the tests.
+
 ```sh
 npm test
 ```
 
+## Linting and Formatting
+
+Handlebars uses `eslint` to enforce best-practices and `prettier` to auto-format files.
+We do linting and formatting in two phases:
+
+- Committed files are linted and formatted in a pre-commit hook. In this stage eslint-errors are forbidden,
+  while warnings are allowed.
+- The travis-ci job also lints all files and checks if they are formatted correctly. In this stage, warnings
+  are forbidden.
+
+You can use the following scripts to make sure that the travis-job does not fail:
+
+- **npm run lint** will run `eslint` and fail on warnings
+- **npm run format** will run `prettier` on all files
+- **npm run check-before-pull-request** will perform all most checks that travis does in its build-job, excluding the "integration-test".
+- **npm run integration-test** will run integration tests (using old NodeJS versions and integrations with webpack, babel and so on)
+  These tests only work on a Linux-machine with `nvm` installed (for running tests in multiple versions of NodeJS).
+
 ## Ember testing
 
 The current ember distribution should be tested as part of the handlebars release process. This requires building the `handlebars-source` gem locally and then executing the ember test script.
@@ -83,7 +105,7 @@ npm test
 
 ## Releasing the latest version
 
-*When releasing a previous version of Handlebars, please look into the CONTRIBUNG.md in the corresponding branch.*
+_When releasing a previous version of Handlebars, please look into the CONTRIBUNG.md in the corresponding branch._
 
 Handlebars utilizes the [release yeoman generator][generator-release] to perform most release tasks.
 
@@ -103,10 +125,10 @@ gem push handlebars-source-*.gem
 After the release, you should check that all places have really been updated. Especially verify that the `latest`-tags
 in those places still point to the latest version
 
-* [The npm-package](https://www.npmjs.com/package/handlebars) (check latest-tag)
-* [The bower package](https://github.com/components/handlebars.js) (check the package.json)
-* [The AWS S3 Bucket](https://s3.amazonaws.com/builds.handlebarsjs.com) (check latest-tag)
-* [RubyGems](https://rubygems.org/gems/handlebars-source)
+- [The npm-package](https://www.npmjs.com/package/handlebars) (check latest-tag)
+- [The bower package](https://github.com/components/handlebars.js) (check the package.json)
+- [The AWS S3 Bucket](https://s3.amazonaws.com/builds.handlebarsjs.com) (check latest-tag)
+- [RubyGems](https://rubygems.org/gems/handlebars-source)
 
 When everything is OK, the handlebars site needs to be updated to point to the new version numbers. The jsfiddle link should be updated to point to the most recent distribution for all instances in our documentation.
 

diff --git a/Gruntfile.js b/Gruntfile.js
@@ -175,11 +175,6 @@ module.exports = function(grunt) {
     },
 
     bgShell: {
-      checkTypes: {
-        cmd: 'npm run checkTypes',
-        bg: false,
-        fail: true
-      },
       integrationTests: {
         cmd: './integration-testing/run-integration-tests.sh',
         bg: false,
@@ -195,25 +190,11 @@ module.exports = function(grunt) {
         },
 
         files: ['src/*', 'lib/**/*.js', 'spec/**/*.js'],
-        tasks: ['build', 'amd', 'tests', 'test']
+        tasks: ['on-file-change']
       }
     }
   });
 
-  // Build a new version of the library
-  this.registerTask('build', 'Builds a distributable version of the current project', [
-                    'bgShell:checkTypes',
-                    'parser',
-                    'node',
-                    'globals']);
-
-  this.registerTask('amd', ['babel:amd', 'requirejs']);
-  this.registerTask('node', ['babel:cjs']);
-  this.registerTask('globals', ['webpack']);
-  this.registerTask('tests', ['concat:tests']);
-
-  this.registerTask('release', 'Build final packages', ['amd', 'uglify', 'test:min', 'copy:dist', 'copy:components', 'copy:cdnjs']);
-
   // Load tasks from npm
   grunt.loadNpmTasks('grunt-contrib-clean');
   grunt.loadNpmTasks('grunt-contrib-concat');
@@ -229,11 +210,33 @@ module.exports = function(grunt) {
 
   grunt.task.loadTasks('tasks');
 
+  this.registerTask(
+      'build',
+      'Builds a distributable version of the current project',
+      ['parser', 'node', 'globals']
+  );
+
+  this.registerTask('node', ['babel:cjs']);
+  this.registerTask('globals', ['webpack']);
+
+  this.registerTask('release', 'Build final packages', [
+    'amd',
+    'uglify',
+    'test:min',
+    'copy:dist',
+    'copy:components',
+    'copy:cdnjs'
+  ]);
+
+  this.registerTask('amd', ['babel:amd', 'requirejs']);
+
   grunt.registerTask('bench', ['metrics']);
   grunt.registerTask('sauce', process.env.SAUCE_USERNAME ? ['tests', 'connect', 'saucelabs-mocha'] : []);
+  // Requires secret properties (saucelabs-credentials etc.) from .travis.yaml
+  grunt.registerTask('extensive-tests-and-publish-to-aws', ['default', 'bgShell:integrationTests', 'sauce', 'metrics', 'publish:latest']);
+  grunt.registerTask('on-file-change', ['build', 'amd', 'concat:tests', 'test']);
 
-  grunt.registerTask('travis', process.env.PUBLISH ? ['default', 'bgShell:integrationTests', 'sauce', 'metrics', 'publish:latest'] : ['default']);
-
+  // === Primary tasks ===
   grunt.registerTask('dev', ['clean', 'connect', 'watch']);
   grunt.registerTask('default', ['clean', 'build', 'test', 'release']);
   grunt.registerTask('integration-tests', ['default', 'bgShell:integrationTests']);

diff --git a/appveyor.yml b/appveyor.yml
@@ -13,8 +13,7 @@ install:
   # Clone submodules (mustache spec)
   - cmd: git submodule update --init --recursive
   # Install modules
-  - cmd: npm install
-  - cmd: npm install -g grunt-cli
+  - cmd: npm ci
 
 
 # Post-install test scripts
@@ -23,7 +22,7 @@ test_script:
   - cmd: node --version
   - cmd: npm --version
   # Run tests
-  - cmd: grunt --stack travis
+  - cmd: npm run test
 
 # Don't actually build
 build: off
@@ -34,4 +33,4 @@ on_failure:
 
 
 # Set build version format here instead of in the admin panel
-version: "{build}"
+version: "{build}"
diff --git a/integration-testing/multi-nodejs-test/test.sh b/integration-testing/multi-nodejs-test/test.sh
@@ -12,7 +12,8 @@ cd "$( dirname "$( readlink -f "$0" )" )" || exit 1
 # It does (almost) not test for correctness, because that is already done in the mocha-tests.
 # And it does not use any NodeJS based testing framwork to make this part independent of the Node version.
 
-# A list of NodeJS versions is expected as cli-args
+unset npm_config_prefix
+
 echo "Handlebars should be able to run in various versions of NodeJS"
 for i in  0.10 0.12 4 5 6 7 8 9 10 11 ; do
     rm target node_modules package-lock.json -rf
@@ -23,4 +24,4 @@ for i in  0.10 0.12 4 5 6 7 8 9 10 11 ; do
     nvm exec "$i" npm run test-precompile || exit 1
 
     echo Success
-done
+done