{"id":26905188,"url":"https://github.com/jimdo/grunt-jquery-toolbox","last_synced_at":"2025-04-01T10:56:25.823Z","repository":{"id":30375323,"uuid":"33927931","full_name":"Jimdo/grunt-jquery-toolbox","owner":"Jimdo","description":"Collection of grunt tasks and optional opinionated configuration","archived":false,"fork":false,"pushed_at":"2023-04-29T09:19:32.000Z","size":191,"stargazers_count":1,"open_issues_count":1,"forks_count":2,"subscribers_count":105,"default_branch":"master","last_synced_at":"2024-04-14T06:07:20.914Z","etag":null,"topics":["owner-team-creator"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jimdo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-04-14T11:30:47.000Z","updated_at":"2024-04-14T06:07:20.915Z","dependencies_parsed_at":"2024-11-15T07:47:55.174Z","dependency_job_id":"8b4c0169-92ff-44d9-9d4c-48589030f90a","html_url":"https://github.com/Jimdo/grunt-jquery-toolbox","commit_stats":{"total_commits":232,"total_committers":9,"mean_commits":25.77777777777778,"dds":"0.39655172413793105","last_synced_commit":"50d81eff143c2aaf995528d52755657cfbadbf46"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jimdo%2Fgrunt-jquery-toolbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jimdo%2Fgrunt-jquery-toolbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jimdo%2Fgrunt-jquery-toolbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jimdo%2Fgrunt-jquery-toolbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jimdo","download_url":"https://codeload.github.com/Jimdo/grunt-jquery-toolbox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246628251,"owners_count":20808106,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["owner-team-creator"],"created_at":"2025-04-01T10:56:25.175Z","updated_at":"2025-04-01T10:56:25.813Z","avatar_url":"https://github.com/Jimdo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"grunt-jquery-toolbox\n=====================\n\n[![Build Status](https://travis-ci.org/Jimdo/grunt-jquery-toolbox.svg?branch=master)](https://travis-ci.org/Jimdo/grunt-jquery-toolbox)\n[![Dependency Status](https://david-dm.org/Jimdo/grunt-jquery-toolbox.svg)](https://david-dm.org/Jimdo/grunt-jquery-toolbox)\n\nCollection of grunt tasks and optional opinionated configuration\nfor development of jquery plugins.\n\n\nInstall\n-------\n\n```sh\nnpm install grunt grunt-cli --save-dev\nnpm install grunt-jquery-toolbox --save-dev\n```\n\nUse\n---\n\n```js\n// Gruntfile.js\nmodule.exports = function(grunt) {\n  'use strict';\n\n  grunt.initConfig({\n    pkg: grunt.file.readJSON('package.json'),\n    jqueryToolbox: { /* see config */ }\n    /* project specific configuration here */\n  });\n\n  /* load jquery-toolbox collection\n     see Included 3rd party tasks */\n  grunt.loadNpmTasks('grunt-jquery-toolbox');\n\n  /* custom tasks and hooks */\n  grunt.registerTask('default', ['test']);\n  grunt.registerTask('build:after', function() {\n    grunt.log.ok('work complete!');\n  });\n};\n```\n\n\nTasks\n-----\n\nDepending on the tasks added by [addTasks](#use) these grunts are available\nin the project.\n\n```sh\n#see this list by using\ngrunt --help\n```\n\n### $ `grunt test`\n\nRun the tests.\n\n__Environment Variables__:\n - `KARMA_BROWSERS` overwrite browsers for unit tests (default: PhantomJs,Chrome,Firefox)\n - `KARMA_REPORTERS` overwrite reporters for unit tests (default: progress)\n\n__Options__:\n - `--browsers` change browsers for current suite(s)\n - `--reporters` change reporters for current suite(s)\n - `--no-coverage` disable coverage reports and instrumentation (useful for debugging)\n - `--no-jshint` disable jshint (useful for debugging)\n - `--watch` tdd style\n\n### $ `grunt demo`\nServe demo application\n\n__Environment Variables__:\n - `DEMO_PORT` change port                  (default: 8000)\n - `LIVERELOAD_PORT` change livereload port (default: 35729)\n\n__Options__:\n - `--port` change port of current task\n - `--livereload-port` change livereload port\n\n### $ `grunt coverage`\nServe coverage report, requires `grunt test:unit` to have been run once.\n\n__Environment Variables__:\n - `COVERAGE_PORT` change port              (default: 7000)\n - `LIVERELOAD_PORT` change livereload port (default: 35729)\n\n__Options__:\n - `--port` change port\n - `--livereload-port` change livereload port\n\n### $ `grunt build[:watch]`\nConcatenate, annotate and minify JavaScript and less files\nOptionally watch the `src` files and rebuild on change\n\n### $ `grunt release[:level]`\nRun tests, (if successful) bump version build project, commit changes and push to origin\n\n\nDefault project structure\n-------------------------\n\n```\n ┌ demo/\n │ └ index.html\n ├ dist/\n ├ src/\n │ ├ js/\n │ │ ├ *.js (project related js files)\n │ ├ less/\n │ │ └ *.less (project related less files)\n │ └ partials/\n │   └ *.html (views for directives)\n ├ test/\n │ └ unit/\n │   ├ SpecHelper.js|coffee (test setup stuff)\n │   └ *Spec.js|coffee (unit test files)\n ├ .jshintrc (optional)\n ├ bower.json (optional)\n ├ package.json\n └ Gruntfile.js|coffee\n```\n\nThis is customizable via the [config](#config)\n\n\nConfig\n------\n\nValues are defaults or explanations.\n\n```js\n// Gruntfile.js\nmodule.exports = function(grunt) {\n  'use strict';\n\n  grunt.initConfig({\n    jqueryToolbox: {\n        /* specify the preconfigured tasks that\n         should be used in the project */\n      tasks: [\n        'build',\n        'coverage',\n        'coveralls',\n        'demo',\n        'release',\n        'tdd',\n        'test'\n      ],\n\n      // whether or not the author in package.json should be set to the\n      // contributor with the most commits\n      dynamicAuthor: false,\n\n      // customize the demo/test environment files\n      envFilter: function(env) { return env; },\n\n      // customize project structure\n      files: {\n        src: {\n          js: [\n            'src/js/helper.module.js'\n          ],\n          less: [\n            'src/less/**/*.less'\n          ]\n        },\n        // additional vendor files for tests and demos that\n        // won't be shipped within dist\n        vendor: {\n          js: {\n            top: [],\n            jqueryPlugins: [],\n            bottom: []\n          },\n          css: [],\n        },\n        test: {\n          unit: [\n            'test/unit/SpecHelper.+(js|coffee)',\n            'test/unit/**/*Spec.+(js|coffee)'\n          ]\n        },\n        demoEnvFolder: 'demo/',\n        distFolder: 'dist/'\n      },\n\n      // custom path for your jshintrc\n      jshintrc: '.jshintrc',\n\n      // how much commits make a maintainer?\n      maintainersThreshold: 15,\n\n      // custom middleware for demo server\n      // can also be an array of middleware\n      middleware: {\n        demo: function(req, res, next) { next(); }\n      },\n\n      // banners an wraps for generated dist files (can be paths or strings)\n      template: {\n        banner: 'lib/templates/banner.tpl',\n        bannerMin: 'lib/templates/bannerMin.tpl',\n        wrapTop: 'lib/templates/wrapTop.tpl',\n        wrapBottom: 'lib/templates/wrapBottom.tpl'\n      }\n    }\n\n    /* additional configuration ... */\n  });\n\n  /* rest of gruntfile ... */\n};\n```\n\n\nCustom tasks and hooks\n----------------------\n\nRegister custom tasks and or setup before the added tasks run.\n\n```js\n// Gruntfile.js\nmodule.exports = function(grunt) {\n  'use strict';\n\n  grunt.initConfig({ /* ... */ });\n\n  /* initiation of tasks ... */\n\n  /* add any custom tasks */\n  grunt.registerTask('sayYolo', function() {\n    console.log('YOLO!');\n  });\n\n  /* hook it into tooling tasks ones.\n     this will be called before all other release tasks */\n  grunt.registerTask('release:before', ['sayYolo']);\n};\n```\n\n### Hooks\n\n - test:before\n - test:unit:before\n - test:after\n - test:unit:after\n - tdd:before\n - tdd:unit:before\n - demo:before\n - coverage:before\n - build:before\n - build:after\n - release:before\n - release:after\n\n\nIncluded 3rd party tasks\n------------------------\n\n - [grunt-bump](https://github.com/vojtajina/grunt-bump)\n - [grunt-concurrent](https://github.com/sindresorhus/grunt-concurrent)\n - [grunt-contrib-concat](https://github.com/gruntjs/grunt-contrib-concat)\n - [grunt-contrib-connect](https://github.com/gruntjs/grunt-contrib-connect)\n - [grunt-contrib-jshint](https://github.com/gruntjs/grunt-contrib-jshint)\n - [grunt-contrib-less](https://github.com/gruntjs/grunt-contrib-less)\n - [grunt-contrib-uglify](https://github.com/gruntjs/grunt-contrib-uglify)\n - [grunt-contrib-watch](https://github.com/gruntjs/grunt-contrib-watch)\n - [grunt-coveralls](https://github.com/pimterry/grunt-coveralls)\n - [grunt-istanbul](https://github.com/taichi/grunt-istanbul)\n - [grunt-karma](https://github.com/karma-runner/grunt-karma)\n - [grunt-npm](https://github.com/Xiphe/grunt-npm/)\n - [grunt-shell](https://github.com/sindresorhus/grunt-shell)\n\n\nLICENSE\n-------\n\n\u003e The MIT License\n\u003e\n\u003e Copyright (c) 2014 Jimdo GmbH http://jimdo.com\n\u003e\n\u003e Permission is hereby granted, free of charge, to any person obtaining a copy\n\u003e of this software and associated documentation files (the \"Software\"), to deal\n\u003e in the Software without restriction, including without limitation the rights\n\u003e to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n\u003e copies of the Software, and to permit persons to whom the Software is\n\u003e furnished to do so, subject to the following conditions:\n\u003e\n\u003e The above copyright notice and this permission notice shall be included in\n\u003e all copies or substantial portions of the Software.\n\u003e\n\u003e THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n\u003e IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n\u003e FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n\u003e AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n\u003e LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n\u003e OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n\u003e THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimdo%2Fgrunt-jquery-toolbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjimdo%2Fgrunt-jquery-toolbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimdo%2Fgrunt-jquery-toolbox/lists"}