gruntfile.js

// eslint-disable-next-line no-undef
var doccoNext = require('docco-next');

// eslint-disable-next-line strict, no-undef
module.exports = function (grunt) {
  // eslint-disable-next-line no-undef
  require('jit-grunt')(grunt, {
    'bump-only': 'grunt-bump',
    'bump-commit': 'grunt-bump'
  });

  grunt.initConfig({
    pkg: grunt.file.readJSON('package.json'),
    banner:
      '/*!\n' +
      '* <%= pkg.title || pkg.name %> - v<%= pkg.version %> - <%= grunt.template.today("yyyy-mm-dd") %>\n' +
      '<%= pkg.homepage ? "* " + pkg.homepage + "\\n" : "" %>' +
      '* Copyright (c) 2011 - <%= grunt.template.today("yyyy") %> <%= pkg.author.name %>\n' +
      '* License: <%= pkg.license %>\n' +
      '*/\n',
    clean: {
      files: ['dist', 'build']
    },
    concat: {
      jquery: {
        src: [
          'src/jqueryextensions.js',
          'src/core.js',
          'src/graphics.js',
          'src/mapimage.js',
          'src/mapdata.js',
          'src/areadata.js',
          'src/areacorners.js',
          'src/scale.js',
          'src/tooltip.js'
        ],
        dest: 'build/jquery.<%= pkg.name %>.jquery.js'
      },
      zepto: {
        src: ['src/zepto.js', '<%= concat.jquery.src %>'],
        dest: 'build/jquery.<%= pkg.name %>.zepto.js'
      },
      jquerydist: {
        options: {
          banner: '<%= banner %>',
          process: true
        },
        src: '<%= umd.jquery.options.dest %>',
        dest: 'dist/jquery.<%= pkg.name %>.js'
      },
      jqueryesmdist: {
        options: {
          banner: '<%= banner %>',
          process: true
        },
        src: '<%= umd.jqueryesm.options.dest %>',
        dest: 'dist/jquery.<%= pkg.name %>.mjs'
      },
      zeptodist: {
        options: {
          banner: '<%= banner %>',
          process: true
        },
        src: '<%= umd.zepto.options.dest %>',
        dest: 'dist/jquery.<%= pkg.name %>.zepto.js'
      }
    },
    uglify: {
      options: {
        banner: '<%= banner %>',
        sourceMap: true,
        sourceMapIncludeSources: true,
        report: 'gzip'
      },
      jquery: {
        src: '<%= concat.jquerydist.dest %>',
        dest: 'dist/jquery.<%= pkg.name %>.min.js'
      },
      jqueryesm: {
        src: '<%= concat.jqueryesmdist.dest %>',
        dest: 'dist/jquery.<%= pkg.name %>.min.mjs'
      },
      zepto: {
        src: '<%= concat.zeptodist.dest %>',
        dest: 'dist/jquery.<%= pkg.name %>.zepto.min.js'
      }
    },
    umd: {
      jquery: {
        options: {
          src: '<%= concat.jquery.dest %>',
          dest: 'build/jquery.<%= pkg.name %>.jquery.umd.js',
          template: 'jqueryplugin.hbs'
        }
      },
      jqueryesm: {
        options: {
          src: '<%= concat.jquery.dest %>',
          dest: 'build/jquery.<%= pkg.name %>.jquery.esm.js',
          template: 'jqueryplugin.esm.hbs'
        }
      },
      zepto: {
        options: {
          src: '<%= concat.zepto.dest %>',
          dest: 'build/jquery.<%= pkg.name %>.zepto.umd.js',
          template: 'zeptoplugin.hbs'
        }
      }
    },
    connect: {
      options: {
        livereload: 9100,
        open: true,
        hostname: 'localhost',
        useAvailablePort: true,
        base: '.'
      },
      tests: {
        options: {
          port: 9101,
          open: 'http://<%= connect.options.hostname %>:<%= connect.tests.options.port %>/tests/imagemapster-test-runner.html'
        }
      },
      examples: {
        options: {
          port: 9102,
          open: 'http://<%= connect.options.hostname %>:<%= connect.examples.options.port %>/examples/index.html'
        }
      }
    },
    watch: {
      gruntfile: {
        files: 'gruntfile.js'
      },
      src: {
        files: ['src/**/*.js'],
        tasks: ['build'],
        options: {
          livereload: '<%= connect.options.livereload %>'
        }
      },
      examples: {
        files: ['examples/**/*.html', 'examples/**/*.css'],
        options: {
          livereload: '<%= connect.options.livereload %>'
        }
      },
      tests: {
        files: ['tests/**/*.js', 'tests/**/*.html'],
        options: {
          livereload: '<%= connect.options.livereload %>'
        }
      }
    },
    docco: {
      source: {
        src: ['src/**/*.js'],
        options: {
          output: 'docs'
        }
      }
    },
    bump: {
      options: {
        files: ['package.json', 'package-lock.json', 'bower.json'],
        updateConfigs: ['pkg'],
        commit: true,
        commitMessage: 'Release v%VERSION%',
        commitFiles: ['-a'], // '-a' for all tracked files
        createTag: true,
        tagName: 'v%VERSION%',
        tagMessage: 'Version %VERSION%',
        push: true,
        pushTo: 'origin',
        prereleaseName: 'beta',
        gitDescribeOptions: '--tags --always --abbrev=1 --dirty=-d' // options to use with '$ git describe'
      }
    },
    shell: {
      options: {
        stdout: true,
        stderr: true,
        failOnError: true
      },
      npmpublish: {
        command: 'npm publish'
      },
      npmpublishpre: {
        command: 'npm publish --tag next'
      },
      npmversion: {
        command:
          'npm version --no-git-tag-version --allow-same-version <%= pkg.version %>'
      },
      formatcheck: {
        command: 'prettier . --check'
      },
      formatfix: {
        command: 'prettier . --write'
      },
      checklinks: {
        // Except for links within MDX blocks, will check all links including heading links to other files
        // see comments in .remarkrc.js
        command:
          'remark --ext md,mdx --no-config --use remark-validate-links --use remark-lint-no-dead-urls .'
      }
    },
    eslint: {
      options: {
        failOnError: true,
        extensions: [
          '.js',
          '.jsx',
          '.cjs',
          '.mjs',
          '.html',
          '.yml',
          '.yaml',
          '.md',
          '.mdx',
          '.json',
          '.jsonc',
          '.ts',
          '.tsx',
          '.astro'
        ]
      },
      check: {
        src: ['.']
      },
      fix: {
        options: {
          fix: true
        },
        src: ['.']
      }
    },
    env: {
      dist: {
        CHECK_LINKS: 'true'
      }
    }
  });

  grunt.registerTask('default', ['clean', 'lint', 'build']);
  grunt.registerTask('build', [
    'concat:jquery',
    'concat:zepto',
    'umd:jquery',
    'umd:jqueryesm',
    'umd:zepto',
    'concat:jquerydist',
    'concat:jqueryesmdist',
    'concat:zeptodist'
  ]);
  grunt.registerTask('dist', ['env:dist', 'clean', 'lint', 'build', 'uglify']);
  grunt.registerTask('dev', ['build', 'connect', 'watch']);
  grunt.registerTask('example', [
    'clean',
    'lint',
    'build',
    'connect:examples',
    'watch'
  ]);
  grunt.registerTask('test', [
    'clean',
    'lint',
    'build',
    'connect:tests',
    'watch'
  ]);
  grunt.registerTask('lint', ['eslint:check']);
  grunt.registerTask('lint:fix', ['eslint:fix']);
  grunt.registerTask('format', ['shell:formatcheck']);
  grunt.registerTask('format:fix', ['shell:formatfix']);
  grunt.registerTask('postBump', ['dist', 'bump-commit', 'shell:npmpublish']);
  grunt.registerTask('postBumpPre', [
    'dist',
    'bump-commit',
    'shell:npmpublishpre'
  ]);
  grunt.registerTask('preBump', ['clean', 'dist']);
  grunt.registerTask('patch', [
    'preBump',
    'bump-only:patch',
    'shell:npmversion',
    'postBump'
  ]);
  grunt.registerTask('minor', [
    'preBump',
    'bump-only:minor',
    'shell:npmversion',
    'postBump'
  ]);
  grunt.registerTask('major', [
    'preBump',
    'bump-only:major',
    'shell:npmversion',
    'postBump'
  ]);
  grunt.registerTask('prerelease', [
    'preBump',
    'bump-only:prerelease',
    'postBumpPre'
  ]);
  grunt.registerTask('prepatch', [
    'preBump',
    'bump-only:prepatch',
    'shell:npmversion',
    'postBumpPre'
  ]);
  grunt.registerTask('preminor', [
    'preBump',
    'bump-only:preminor',
    'shell:npmversion',
    'postBumpPre'
  ]);
  grunt.registerTask('premajor', [
    'preBump',
    'bump-only:premajor',
    'shell:npmversion',
    'postBumpPre'
  ]);
  grunt.registerMultiTask('docco', 'Docco-next processor.', function () {
    var done = this.async(),
      // docco-next documentation is lacking when it comes to using the API
      // the following is based on what the CLI does with arguments passed in
      // https://github.com/mobily-enterprises/docco-next/blob/master/docco.js#L186
      config = this.options({
        plugin: this.options.plugin || {}, // docco-next expects at least empty object
        outputExtension: this.options.outputExtension || 'html', // docco-next expects a value
        sources: this.filesSrc
      });
    doccoNext
      .documentAll(config)
      .then(done)
      .catch(function (e) {
        done(e);
      });
  });
  grunt.registerTask('checklinks', ['shell:checklinks']);
};