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

template-compiler

v1.2.1

Published

Template Compiler Tools

Downloads

431

Readme

atc-前端模板预编译器

http://aui.github.io/atc

======================================

前言

随着 HTML5 时代到来,前端技术在不断的发展壮大,我们为此欣喜若狂。但作为一名前端开发者,我们也不无时无刻的感受到很多看似平常的技术在 js 中仍然难以实现,其中之一便是模板技术:

<!--template/index.html-->
<%include('./public/header')%>
<h3><%=title%></h3>
<ul>
    <% for (i = 0; i < list.length; i ++) { %>
       <li>
        	<a href="<%= list[i].url %>">
        		<%= list[i].title %>
        	</a>
       </li>
    <% } %>
</ul>
<%include('./public/footer')%>

虽然我们已经有了很多优秀的前端模板引擎可以选择,但前端模板技术与服务器模板技术却完全不是一个层面的东西。受浏览器限制,模板按文件与目录组织与 include 这些基本的特性几乎无法实现,我们的最佳实践方式是把模板全部通过<script type="text/html" ..标签写在页面里面。

随着应用越来越复杂、模板越来越多、模板各种依赖出现的时候,我们的页面也变得臃肿不堪、难以维护,以至于我们不得不拿出各种技巧进行所谓优化,如抽离到js中、按需加载等。回过头再来看这些最佳实践,我们不经意之间为了解决一个问题引发了更多的问题,如跨域部署、依赖管理、压缩、按需加载、请求合并等。

辛苦的忙碌后,这时候是不是会怀念服务端那种按目录、文件简单的模板组织方式呢?其实,前端模板完全可以做到!

关于 atc

atc 是一款前端模板预编译器,使用它可以让前端模版不再受浏览器的限制,支持如后端模版一样按文件放置、include语句等优秀的特性。

编译后的模板不再依赖模板引擎,模板可以通过 SeaJSRequireJS 等加载器进行异步加载,亦能利用它们成熟的打包合并工具进行上线前的优化。

使用入门

首先 下载 atc 并解压。

atc 包含两个版本,一个是 windows 批处理版本(compiler.cmd),还有一个 NodeJS 版本(compiler.js)。批处理版本无依赖其他环境,Windows下直接双击可运行;NodeJS版本可以跨平台运行,前提是安装 NodeJS

./demo/templates/ 目录的 html 文件是示例模板。

批处理版本使用比较简单,我们以它来运行演示例子:

双击打开 compiler.cmd,它会自动编译./demo/templates/中所有模板文件,生成对应的 js 文件。运行结束后你可以打开./demo/index.html调用页面,看其如何被加载。编译好的在线示例

一切就这么简单!

如果是 NodeJS 版本,使用 node compiler.js 运行。

模板语法

atc 是 artTemplate 的子项目,语法也与其保持一致,亦可通过它的插件简化模板语法。模板语法可参考其 文档

设置配置

右键可直接编辑编译工具的源码修改配置:

// 设置前端模板目录路径
var $path = './demo/templates/';

// 设置待处理的模版编码
var $charset = 'UTF-8';

// 设置辅助方法编译方式:为true则克隆到每个编译后的文件中,为false则单独输出到文件
var $cloneHelpers = false;

// 模板引擎路径
var template = require('../../template.js');

// js格式化工具路径
var js_beautify = require('./lib/beautify.js');

模板include语句规范

为了让编译工具能够进行静态分析,需要如下约定:

  1. 路径参数不能带后缀名
  2. 路径参数不能够进行动态拼装

错误的写法:

<%include('./index.html')%>	
<%include('./tmpl-' + type)%>
<%include(path)%>

======================================

© cdc.tencent.com