grunt插件之connect

启动一个web服务器连接

启动任务

使用grunt connect命令运行此任务。

请注意,只有grunt正在运行,该服务器才会运行。一旦grunt的任务完成,Web服务器就停止。可以通过keepalive选项来设置,并且可以通过运行任务来临时启用 grunt connect:keepalive

此任务旨在与随后运行的另一个任务一起使用,如grunt-contrib-qunit插件qunit任务。

Options参数

port

类型: Integer(整数)
默认值:8000

网络服务器将响应的端口。如果指定的端口已经在使用中,则该任务将失败(除非设置了useAvailablePort)。您可以使用特殊值0'?'使用系统分配的端口。

protocol

类型:String
默认值:'http'

网络通信协议,可以是'http', 'http2''https'.

hostname

类型:String
默认值:0.0.0.0

可以访问网络服务器的主机名.
将其设置为'*',像“ 0.0.0.0”,将使服务器可以从任何本地局域网 的IPv4地址访问 '127.0.0.1',并将IP分配给以太网或无线接口如'192.168.0.x'或'10.0.0.x'。

如果open设置为true,该hostname设置将用于生成浏览器打开的URL,默认为localhost指定通配符主机名。

base

类型:String or Array or Object
默认值:.

  • String 提供文件的基本路径(或根目录),默认为 Gruntfile.js 所在的目录
  • Array 多个被映射到网站虚拟根目录的物理路径
  • Object 包含pathoptions参数,options 会传递给 serve-state 模块处理。
directory

类型:String
默认值:null

设置到希望能够浏览的目录 用于覆盖base选项的可浏览目录。

keepalive

类型:Boolean
默认值:false

让服务器持续运行。请注意,如果启用此选项,则此任务之后指定的任何任务将永远不会运行。默认情况下,一旦grunt的任务完成,Web服务器停止。此选项会更改该行为。

此选项也可以通过运行任务进行临时启用 grunt nnect:targetname:keepalive

debug

类型:Boolean
默认值:false

将debug选项设置为true以启用日志记录,而不是使用--debug标志。

livereload

类型:BooleanNumber
默认值:false

设置true或端口号,以使用connect-livereload将实时重新加载脚本的标记注入到页面中。

这不执行实时重新加载。它旨在与grunt-contrib-watch或另一个任务一起使用,在文件更改时将触发实时重新加载服务器。

open

类型: BooleanStringObject
默认值:false

在默认浏览器中打开提供的页面。

这可以是以下之一:

  • 指定true打开默认服务器URL(从protocolhostname
    port
    设置生成)

  • 指定URL会打开该URL

  • 使用以下键指定一个对象,直接配置为open

{
  target : ' http:// localhost:8000 ',// target url打开 
  appName : ' open ',//打开应用程序的名称,即:open,start,xdg-open 
  callback : function(){} / /当应用程序打开时调用 
}
useAvailablePort

类型:Boolean
默认值:false

如果true任务将在set port选项之后查找下一个可用端口。

onCreateServer

类型:FunctionArray
默认值:null

创建服务器对象后要调用的函数,以允许集成需要访问的库来连接服务器对象。一个Socket.IO示例:

grunt.initConfig({
  connect: {
    server: {
      options: {
        port: 8000,
        hostname: '*',
        onCreateServer: function(server, connect, options) {
          var io = require('socket.io').listen(server);
          io.sockets.on('connection', function(socket) {
            // do something with socket
          });
        }
      }
    }
  }
});
middleware

类型:FunctionArray
默认值:使用 options.base 处理静态文件和目录浏览的数组

如果提供了一个数组的话,就会取代默认的服务器处理,直接采用自定义的中间件进行处理,这需要我们完全定义服务器中的处理。

grunt.initConfig({
  connect: {
    server: {
      options: {
        middleware: [
          function myMiddleware(req, res, next) {
            res.end('Hello, world!');
          }
        ],
      },
    },
  },
});

如果是函数的话,会自动添加默认的静态文件处理中间件,再执行自定义的中间件函数。

grunt.initConfig({
  connect: {
    server: {
      options: {
        middleware: function(connect, options, middlewares) {
          // inject a custom middleware into the array of default middlewares
          middlewares.unshift(function(req, res, next) {
            if (req.url !== '/hello/world') return next();

            res.end('Hello, world from port #' + options.port + '!');
          });

          return middlewares;
        },
      },
    },
  },
});

用法示例

基本使用

在这个例子中,grunt connect(或更详细地grunt connect:server)将启动一个静态Web服务器http://localhost:9001/,其基本路径设置为www-root相对于gruntfile的目录,任何随后运行的任务将能够访问它。

// Project configuration.
grunt.initConfig({
  connect: {
    server: {
      options: {
        port: 9001,
        base: 'www-root'
      }
    }
  }
});

如果您希望Web服务器使用默认选项,只需省略options对象即可。您仍然需要指定目标(在此示例中是uses_defaults),目标的配置对象可以为空或不存在。在这个例子中,grunt connect(或更详细地grunt connect:uses_defaults)将使用默认选项启动一个静态Web服务器。

// Project configuration.
grunt.initConfig({
  connect: {
    uses_defaults: {}
  }
});
多个服务器

您可以通过为每个服务器创建目标来指定要独立运行或同时运行的多个服务器。在这个例子中,运行grunt connect:site1grunt connect:site2将启动相应的Web服务器,但运行grunt connect将运行两个。请注意,指定了keepalive选项的任何服务器将阻止任何任务或目标运行。

// Project configuration.
grunt.initConfig({
  connect: {
    site1: {
      options: {
        port: 9000,
        base: 'www-roots/site1'
      }
    },
    site2: {
      options: {
        port: 9001,
        base: 'www-roots/site2'
      }
    }
  }
});
静态选项

静态服务器模块的选项.详见serve-static:

grunt.initConfig({
  connect: {
    server: {
      options: {
        port: 8000,
        base: {
          path: 'www-root',
          options: {
            index: 'somedoc.html',
            maxAge: 300000
          }
        }
      }
    }
  }
});
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,045评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,114评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,120评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,902评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,828评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,132评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,590评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,258评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,408评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,335评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,385评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,068评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,660评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,747评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,967评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,406评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,970评论 2 341

推荐阅读更多精彩内容