{"id":19218617,"url":"https://github.com/shepherdwind/plum","last_synced_at":"2025-06-24T04:05:24.764Z","repository":{"id":3168073,"uuid":"4199054","full_name":"shepherdwind/plum","owner":"shepherdwind","description":"Demo server environment by node","archived":false,"fork":false,"pushed_at":"2014-05-25T04:33:53.000Z","size":1770,"stargazers_count":19,"open_issues_count":9,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-13T00:32:33.952Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://git.shepherdwind.com/plum/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shepherdwind.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-05-02T03:06:06.000Z","updated_at":"2016-07-18T14:54:19.000Z","dependencies_parsed_at":"2022-09-05T00:50:24.734Z","dependency_job_id":null,"html_url":"https://github.com/shepherdwind/plum","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/shepherdwind/plum","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shepherdwind%2Fplum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shepherdwind%2Fplum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shepherdwind%2Fplum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shepherdwind%2Fplum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shepherdwind","download_url":"https://codeload.github.com/shepherdwind/plum/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shepherdwind%2Fplum/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261601478,"owners_count":23183092,"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":[],"created_at":"2024-11-09T14:27:28.213Z","updated_at":"2025-06-24T04:05:24.742Z","avatar_url":"https://github.com/shepherdwind.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"#Plum\n\n基于node的Demo服务器。Node作为http请求控制中心，通过`server.json`配置，根据请求\n域名，找到所请求的文件，同时根据服务器配置的`hook`，对文件执行解析分发。\n\n[doc](http://git.shepherdwind.com/plum/)\n\n##Use\n  \n      sudo npm install plum -g\n      sudo plum\n\n依赖php cli和node的less模块，请首先安装。\n\n##config\n\n配置文件: `server.json`。配置方式和Apache基本一直，不过没有那么复杂。\n\n- *port*: 端口，默认80\n- *dirIndex*: 目录中默认查找文件\n- *servers*: 虚拟主机相关配置，包括域名对应的base路径和特定hooks\n- *hooks*: 全局hook，比如.php: php，所有的php文件都会通过`hooks/php.js`执行\n\n##hooks\n\n[文档](https://github.com/shepherdwind/plum/blob/master/hooks/README.md)。\nserver.js是入口文件，完成请求分发工作。主要解析过程由hooks目录下的js执行。\n\n- webx [from 0.4.2]\n  \n  webx规则，使用规则请看[issue 11](https://github.com/shepherdwind/plum/issues/11) 。\n\n- *velocity* [from 0.4.1]， 使用velocity模板解析。\n  \n- *agent* 请求转发到另外域名，配置如下\n\n```json\n    \"tms.taobao.com\": {\n      \"customs\": {\"host\": \"110.75.19.81\", \"port\": 80},\n      \"hooks\" : { \"*\" : [\"agent\"] }\n    }\n```\n\n- *origin*\n\n  origin首先判断请求为文件还是目录，如果是目录，生成目录列表。如果是文件，根据文\n  件后缀，初始化相对于的hook，并且接受hook发送数据请求事件。控制文件输出到客户端\n  的属性，和错误情况的处理。同时，在没有hook的情况下，完成静态文件读取的功能。\n\n- *hook*和*hook-simple*\n\n  这两个是hook规范事例，并没有具体实现，是扩展hook的规范\n\n- *less*\n\n  less完成less解析工作，初始化时，判断文件相对应的less文件是否存在，如果存在执行\n  less编译，返回结果，如果不存在，退出，交给origin处理。\n  \n- *proxyAll* 对所有的文件都转发到服务器端取文件，淘宝静态资源代理规则。\n\n- *proxy*\n\n  淘宝cdn代理实现。初始化时候，首先判断文件在本地是否存在(文件查找规则由请求url\n  和 server.json配置的path决定)，如果不存在，从cdn服务器获取数据。如果存在，则退\n  出，origin处理自动。\n  \n- *php/proxy* 启动php自带的server，需要php v5.4.x，完整支持post、get请求\n\n- *php/cli*\n\n  通过php cli解析php文件，现在还不支持post和get请求，作为demo环境基本够用，执行\n  效率和由php 自身性能决定，和转发者是node还是apache无关。\n\n- *php/tms*\n\n  模拟tms函数，生成demo。判断规则是：文件是php，并且含有.tms，tms规则支持tms文件\n  引用，不过要求，每次只引用一个文件(`\u003c?php include 'a.tms.php';?\u003e`)，而且文件名\n  中含有.tms。demo的数据根据请求的文件名，把后缀改为json，比如访问a.tms.php，demo\n  数据源为a.tms.json，运行时，每个函数通过name来定位数据。\n\n##change log\n\n- version 0.3.10\n  - 修复两个斜杠开头时代理错误的bug\n- [2012-11-14 11:40:24] version 0.3.9\n  - 简化log判断，改为两条log输出规则，log和debug，log使用支持通配符`*`，匹配需要\n    输出log信息的url。debug打开所有的log信息\n  - 修复bug [#9](https://github.com/shepherdwind/plum/issues/9)\n  - 增加`agent`钩子，用于完全代理任意域名\n\n- [2012-08-09 08:44:24] version 0.3.1\n  - 增加log信息过滤配置，logFiles配置可显示log信息的文件，logHooks配置hook日志,\n    logBasic显示基本信息，显示所有请求文件和请求执行时间. debug所有细节都log到\n    控制台。\n    \n```\n  \"logFiles\":[\n    {\n      \"path\":\"tmse/5137/assets\",\n      \"ext\":[\".css\", \".js\"]\n    }\n  ],\n  \"logHooks\":[\"less\"],\n  \"logBasic\":false,\n  \"debug\":false\n```\n  - 增加执行时配置，使用[config](http://127.0.0.1/config)进行执行时配置，无需重启\n  服务器。\n  - 修改hook `php/proxy`，使用php5.4启动php内置服务器，请求转发到php自带服务器，\n  支持post，get请求。需要php版本\u003e=5.4\n  - 增加hook `proxyAll`和`statics`，proxyAll对所有请求都从a.tbcdn.cn上取数据，\n  statics为静态文件hook，本来和origin.js和在一起，现在拆分开。\n  - 增加子规则maps配置，用于设置域名下路径映射和hook规则\n   \n```\n  \"maps\":{\n    \"/tmse/5137/assets/\":{\n      \"path\":\"/Users/eward/Sites/dev/nongye/sdk/assets/\",\n      \"hooks\":{\n        \".css\":[\"less\"],\n        \"statics\":[\"statics\"]\n      }\n    }\n  }\n```\n\n- [2012-06-12 15:44:03] \n  - 增加`proxy=pre`作为使用预发assets的接口\n  - tms规则下，build时，生成文件名对应的html文件，用于fed上预览\n  - 去除tms规则下，引用模块文件名必须以`.tms.php`结尾的规则\n  - tms规则下，自动生成.json文件，方便修改\n  - 增加自动更新提示\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshepherdwind%2Fplum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshepherdwind%2Fplum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshepherdwind%2Fplum/lists"}