npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gm3

v1.1.3

Published

constructing your world by snippets

Downloads

2

Readme

GM3

一个公共的html代码模板工具。可以借助模板引擎,将一些变动的元素以json数据的形式加以抽象,然后渲染到模板中,生成目标文件。让模板成为真正的模板。(模板引擎采用EJS)

Getting Started

可以使用gm3全局安装npm包,直接执行 gm3 生成对应内容

环境基础

1.需要node环境,参考Installing Node.js via package manager

2.安装gm3

  • 通过代码调用: require('gm3')
npm install gm3 
  • 全局使用 gm3
npm install -g gm3       # or [url of this repository]

开发指南

资源结构(举例)

├── demo3.html              #主要html源文件,文件名,通过gm.json配置。
├── demo3.json              #主要json源文件,文件名,通过gm.json配置。
├── gm.html                 #由gm生成的html,默认目标生成文件
├── gm.json                 #gm.json是读取配置的入口文件,每个包下都必须有
└── gm_components           #gm安装的依赖模板包
    ├── [email protected]
    │   ├── demo1.html
    │   ├── demo1.json
    │   └── gm.json
    └── [email protected]
        ├── demo2.html
        ├── demo2.json
        └── gm.json

架构解释

  • 资源至少包含gm.json,以及配置的html/json两个文件
[email protected]
├── demo3.html
├── demo3.json
└── gm.json
  • gm.json

主体框架下,gm.json会配置源文件的文件名称(不带后缀),以及依赖关系。

{
  "name": "demo3",              #project name && gm publish name
  "main": "demo3",              #main source file
  "input": {                    #if defineded,take this instead of 'main'
    "template": "./demo3.html",
    "data": "demo3.json"
  },
  "output": "gm.html",          #target file for building, 'gm.html' as defult
  "dependencies": {             #the templates that used in this project
    "demo1": "@1.0.0",
    "demo2": "@1.0.0"
  }
}

输入数据的指定 maininput 都是用来指定输入源的。优先级: input > main。

`main` 无需后缀。默认 ${main}.html 和 ${main}.js(或 ${main}.json)  
`input` 包含template和data,值为文件相对路径。

输出数据的指定 output 配置输出路径。(默认gm.html)

  • demo3.html

partOne,partTwo,partThree都是html文本。采用<%-%>,语法参考 EJS

<div id="demo3">
  <div class="part1">
    <%-partOne%>
  </div>
  <div class="part2">
    <%-partTwo%>
  </div>
  <div class="part3">
    <%-partThree%>
  </div>
</div>
  • demo3.json
{
    "partOne": {
        "$template": "[email protected]"
    },
    "partTwo": {
        "$template": "[email protected]",
        "$data": {
            "content1": {
                "$template": "[email protected]",
                "$data": {
                    "placeholder": "hello by demo3"
                }
            },
            "listContent": ["text1", {
                "$template": "[email protected]",
                "$data": {
                    "placeholder": "hello by demo3"
                }
            }, "text3"]
        }
    },
    "partThree": "第三部分"
}

template语法

  • 如果是一般数据,会直接渲染到html。
  • 如果是依赖于template生成,则数据结构可以是:
{
    "$template": "[email protected]",
    "$data": {
        "placeholder": "hello by demo3"
    }
}

模板 [email protected] 如下:

//demo1.html
<input type="text" placeholder="<%-placeholder%>" />

//demo1.json
{
    "placeholder": "请输入文本"
}

其中,templatedata 是固定的属性。
template 由包名和版本号组成。固定格式引用。
data 填充该template的json数据,会覆盖模板的默认数据。可以为空,为空则用默认数据。

指令 -- gm3

Usage: gm3 [options]
default: gm3 = gm3 -b

Gm help.


 Options:
  -d, --directory[=DIR]       The directory to be builded, default is current
                                directory
  -o, --output[=PATH]         Write the builded content to the target file
  -m, --main[=PATH]           defind the entry file
  -a, --append-array          Appends intead of replaces an array
  -b, --build                 Compile && build file
  -i, --install[=MODULES]     Install templates
  -v, --version               Output version information and exit

Report bugs to <[email protected]>.

举例

  • gm3 -h 打印help信息。
  • gm3 --install ../demo1 会生成gm_components文件夹,并安装demo1。
  • gm3 [--build] 通过数据依赖继承关系,生成gm.html。
  • gm3 -o test.html 生成到test.html,此时忽略gm.json中的output值。
  • gm3 -m main_file_name -o dist_file_name 设定file_name为入口文件,并build。

类库使用

安装

npm install gm3

使用

  • 规则

$template 指定模板路径 template 指定模板内容 $data 指定数据路径 data 指定数据内容

demo

  • 使用数据文件路径
const gm3 = require('gm3');
let gm3Str = gm3.build({
  dir: 'path_to_template_dir',
  "input": {
    "$template": "template.js",
    "$data": 'template.json'
  }
});
console.log(gm3Str);
  • 使用数据对象
const gm3 = require('gm3');
let gm3Str = gm3.build({
  dir: 'path_to_template_dir',
  "input": {
    "$template": "template.js",
    "data": {}
  }
});
console.log(gm3Str);
  • 使用模板数据+模板路径(注意,如果要使用include指令必须设置模板路径,可以通过main或input.$template设置)
const gm3 = require('gm3');
let gm3Str = gm3.build({
  dir: 'path_to_template_dir',
  "input": {
    "template": "<%-data1%>",
    "data": {data1:'example'}
  },
  "main": "path_to_template_file"
});
console.log(gm3Str);

相关项目

  • EJS: https://github.com/mde/ejs

TODO

cli support completely

  -d, --directory[=DIR]       The directory to be builded, default is current
                                directory
  -o, --output[=PATH]         Write the builded content to the target file
  -m, --main[=PATH]           defind the entry file
  -a, --append-array          Appends intead of replaces an array
  -b, --build                 Compile && build file
  -i, --install[=MODULES]     Install templates
  -A, --auth[=USER:PASS]      User auth by name and password
  -s, --search[=key1:key2:...]  
                              Search by keys
  -p, --publish               Publish package
  -I, --info                  Show local infos
  -V, --verbose               Makes output more verbose
  -h, --help                  Display this help message and exit
  -v, --version               Output version information and exit