mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-28 09:20:52 +01:00
352 lines
9.1 KiB
JavaScript
Executable File
352 lines
9.1 KiB
JavaScript
Executable File
/*
|
|
* Copyright (c) 2016-2017 Martin Donath <martin.donath@squidfunk.com>
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to
|
|
* deal in the Software without restriction, including without limitation the
|
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
* sell copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
* IN THE SOFTWARE.
|
|
*/
|
|
|
|
import gulp from "gulp"
|
|
import notifier from "node-notifier"
|
|
import plumber from "gulp-plumber"
|
|
import util from "gulp-util"
|
|
import yargs from "yargs"
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Configuration and arguments
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
const config = {
|
|
assets: {
|
|
src: "src/assets", /* Source directory for assets */
|
|
build: "material/assets" /* Target directory for assets */
|
|
},
|
|
lib: "lib", /* Libraries */
|
|
views: {
|
|
src: "src", /* Source directory for views */
|
|
build: "material" /* Target directory for views */
|
|
}
|
|
}
|
|
|
|
const args = yargs
|
|
.default("clean", false) /* Clean before build */
|
|
.default("karma", true) /* Karma watchdog */
|
|
.default("lint", true) /* Lint sources */
|
|
.default("mkdocs", true) /* MkDocs watchdog */
|
|
.default("optimize", false) /* Optimize sources */
|
|
.default("revision", false) /* Revision assets */
|
|
.default("sourcemaps", false) /* Create sourcemaps */
|
|
.argv
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Overrides and helpers
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/*
|
|
* Override gulp.src() for nicer error handling.
|
|
*/
|
|
const src = gulp.src
|
|
gulp.src = (...glob) => {
|
|
return src.apply(gulp, glob)
|
|
.pipe(
|
|
plumber(function(error) {
|
|
util.log(util.colors.red(
|
|
`Error (${error.plugin}): ${error.message}`
|
|
))
|
|
|
|
/* Extract file where error happened, if existent */
|
|
const file = error.relativePath
|
|
? error.relativePath.split("/").pop()
|
|
: ""
|
|
|
|
/* Dispatch system-level notification */
|
|
notifier.notify({
|
|
title: `Error (${error.plugin}): ${file}`,
|
|
message: error.messageOriginal
|
|
})
|
|
|
|
// eslint-disable-next-line no-invalid-this
|
|
this.emit("end")
|
|
|
|
/* Throw error and abort, if not in watch mode */
|
|
if (args._[0] !== "watch")
|
|
throw error
|
|
}))
|
|
}
|
|
|
|
/*
|
|
* Helper function to load a task
|
|
*
|
|
* This function returns a callback that will require the task with the given
|
|
* name and execute the function that is returned by this task. It omits the
|
|
* need to load all tasks upfront, speeding up the build a gazillion times.
|
|
*/
|
|
const load = task => {
|
|
return done => {
|
|
return require(`./${config.lib}/tasks/${task}`)
|
|
.call(gulp, gulp, config, args)(done)
|
|
}
|
|
}
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Images
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/*
|
|
* Copy favicon
|
|
*/
|
|
gulp.task("assets:images:build:ico", [
|
|
args.clean ? "assets:images:clean" : null
|
|
].filter(t => t),
|
|
load("assets/images/build/ico"))
|
|
|
|
/*
|
|
* Copy and minify vector graphics
|
|
*/
|
|
gulp.task("assets:images:build:svg", [
|
|
args.clean ? "assets:images:clean" : null
|
|
].filter(t => t),
|
|
load("assets/images/build/svg"))
|
|
|
|
/*
|
|
* Copy images
|
|
*/
|
|
gulp.task("assets:images:build", [
|
|
"assets:images:build:ico",
|
|
"assets:images:build:svg"
|
|
])
|
|
|
|
/*
|
|
* Clean images generated by build
|
|
*/
|
|
gulp.task("assets:images:clean",
|
|
load("assets/images/clean"))
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* JavaScript
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/*
|
|
* Build application logic
|
|
*/
|
|
|
|
gulp.task("assets:javascripts:build:application", [
|
|
args.clean ? "assets:javascripts:clean" : null,
|
|
args.lint ? "assets:javascripts:lint" : null
|
|
].filter(t => t),
|
|
load("assets/javascripts/build/application"))
|
|
|
|
/*
|
|
* Build custom modernizr
|
|
*/
|
|
gulp.task("assets:javascripts:build:modernizr", [
|
|
"assets:stylesheets:build",
|
|
args.clean ? "assets:javascripts:clean" : null,
|
|
args.lint ? "assets:javascripts:lint" : null
|
|
].filter(t => t),
|
|
load("assets/javascripts/build/modernizr"))
|
|
|
|
/*
|
|
* Build application logic and modernizr
|
|
*/
|
|
gulp.task("assets:javascripts:build", [
|
|
"assets:javascripts:build:application",
|
|
"assets:javascripts:build:modernizr"
|
|
])
|
|
|
|
/*
|
|
* Clean JavaScript generated by build
|
|
*/
|
|
gulp.task("assets:javascripts:clean",
|
|
load("assets/javascripts/clean"))
|
|
|
|
/*
|
|
* Lint JavaScript
|
|
*/
|
|
gulp.task("assets:javascripts:lint",
|
|
load("assets/javascripts/lint"))
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Stylesheets
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/*
|
|
* Build stylesheets from SASS source
|
|
*/
|
|
gulp.task("assets:stylesheets:build", [
|
|
args.clean ? "assets:stylesheets:clean" : null,
|
|
args.lint ? "assets:stylesheets:lint" : null
|
|
].filter(t => t),
|
|
load("assets/stylesheets/build"))
|
|
|
|
/*
|
|
* Clean stylesheets generated by build
|
|
*/
|
|
gulp.task("assets:stylesheets:clean",
|
|
load("assets/stylesheets/clean"))
|
|
|
|
/*
|
|
* Lint SASS sources
|
|
*/
|
|
gulp.task("assets:stylesheets:lint",
|
|
load("assets/stylesheets/lint"))
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Assets
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/*
|
|
* Build assets
|
|
*/
|
|
gulp.task("assets:build", [
|
|
"assets:images:build",
|
|
"assets:javascripts:build",
|
|
"assets:stylesheets:build"
|
|
])
|
|
|
|
/*
|
|
* Clean files generated by build
|
|
*/
|
|
gulp.task("assets:clean", [
|
|
"assets:images:clean",
|
|
"assets:javascripts:clean",
|
|
"assets:stylesheets:clean"
|
|
])
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Views
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/*
|
|
* Minify views
|
|
*/
|
|
|
|
gulp.task("views:build", [
|
|
args.revision ? "assets:images:build" : null,
|
|
args.revision ? "assets:stylesheets:build" : null,
|
|
args.revision ? "assets:javascripts:build" : null,
|
|
args.clean ? "views:clean" : null
|
|
].filter(t => t),
|
|
load("views/build"))
|
|
|
|
/*
|
|
* Clean views
|
|
*/
|
|
gulp.task("views:clean",
|
|
load("views/clean"))
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* MkDocs
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/*
|
|
* Build documentation
|
|
*/
|
|
gulp.task("mkdocs:build", [
|
|
"assets:build",
|
|
"views:build",
|
|
"mkdocs:clean"
|
|
],
|
|
load("mkdocs/build"))
|
|
|
|
/*
|
|
* Clean documentation build
|
|
*/
|
|
gulp.task("mkdocs:clean",
|
|
load("mkdocs/clean"))
|
|
|
|
/*
|
|
* Restart MkDocs server
|
|
*/
|
|
gulp.task("mkdocs:serve",
|
|
load("mkdocs/serve"))
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Tests
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/*
|
|
* Start karma test runner
|
|
*/
|
|
gulp.task("tests:unit:watch",
|
|
load("tests/unit/watch"))
|
|
|
|
/* ----------------------------------------------------------------------------
|
|
* Interface
|
|
* ------------------------------------------------------------------------- */
|
|
|
|
/*
|
|
* Build assets and documentation
|
|
*/
|
|
gulp.task("build", [
|
|
"assets:build",
|
|
"views:build",
|
|
args.mkdocs ? "mkdocs:build" : null
|
|
].filter(f => f))
|
|
|
|
/*
|
|
* Clean assets and documentation
|
|
*/
|
|
gulp.task("clean", [
|
|
"assets:clean",
|
|
"views:clean",
|
|
"mkdocs:clean"
|
|
])
|
|
|
|
/*
|
|
* Watch for changes and rebuild assets on the fly
|
|
*/
|
|
gulp.task("watch", [
|
|
"assets:build",
|
|
"views:build"
|
|
], () => {
|
|
process.env.WATCH = true
|
|
|
|
/* Start MkDocs server */
|
|
if (args.mkdocs)
|
|
gulp.start("mkdocs:serve")
|
|
|
|
/* Start karma test runner */
|
|
// if (args.karma)
|
|
// gulp.start("tests:unit:watch")
|
|
|
|
/* Rebuild stylesheets */
|
|
gulp.watch([
|
|
`${config.assets.src}/stylesheets/**/*.scss`
|
|
], ["assets:stylesheets:build"])
|
|
|
|
/* Rebuild JavaScript */
|
|
gulp.watch([
|
|
`${config.assets.src}/javascripts/**/*.{js,jsx}`
|
|
], ["assets:javascripts:build:application"])
|
|
|
|
/* Copy images */
|
|
gulp.watch([
|
|
`${config.assets.src}/images/**/*`
|
|
], ["assets:images:build"])
|
|
|
|
/* Minify views */
|
|
gulp.watch([
|
|
`${config.views.src}/**/*.html`
|
|
], ["views:build"])
|
|
})
|
|
|
|
/*
|
|
* Build assets by default
|
|
*/
|
|
gulp.task("default", ["build"])
|