资讯专栏INFORMATION COLUMN

构建工具是如何用 node 操作 html/js/css/md 文件的

PingCAP / 306人阅读

摘要:构建工具是如何用操作文件的从本质上来说,源代码文件都是文本文件,文本文件的内容都是字符串,对文本文件的操作其实就是对字符串的操作。在第二种方式中,一般也是将文本解析成一棵抽象语法树,然后进行操作。

构建工具是如何用 node 操作 html/js/css/md 文件的

从本质上来说,html/js/css/md ... 源代码文件都是文本文件,文本文件的内容都是字符串,对文本文件的操作其实就是对字符串的操作。

操作源代码的方式又主要分成两种:

当作字符串,进行增、删、改等操作

按照某种语法、规则,把字符串读取成一个对象,然后对这个对象进行操作,最后导出新的字符串

1. 操作 html 文件

html 的语法比较简单,并且一般操作 html 都是插入、替换、模板引擎渲染等在字符串上的操作,所以使用第一种方式的比较多。

比如:

html-loader

html-webpack-plugin

html-minifier

handlebars 模板引擎

pug 模板引擎

ejs 模板引擎

一般以第二种方式来操作 html 的都是将 html 文本解析成 dom 树对象,然后进行 dom 操作,最后再导出成新的代码文本。

比如:

cheerio

jsdom

parse5

cheerio 为例,操作 html 文本:

cheerio 能够加载一个 html 文本,实例化一个类 jQuery 对象,然后使用 jQueryapi 像操作 dom 一样操作这段文本,最后导出新的 html 文本。

const cheerio = require("cheerio");
const $ = cheerio.load("

Hello world

"); // 加载一个 html 文本 $("h2.title").text("Hello there!"); $("h2").addClass("welcome"); $.html(); // 导出新的 html 文本 //=>

Hello there!

jsdom 为例,操作 html 文本:

jsdom 是用 js 将一个 html 文本解析为一个 dom 对象,并实现了一系列 web 标准,特别是 WHATWG 组织制定的 DOMHTML 标准。

const jsdom = require("jsdom");
const { JSDOM } = jsdom;

const dom = new JSDOM(`

Hello world

`); console.log(dom.window.document.querySelector("p").textContent); // "Hello world"
2. 操作 js 文件

因为 js 语法比较复杂,仅仅是如字符串一样进行增删改,只能做一些小的操作,意义不大。所以,一般操作 js 文件都是采用的第二种方式。

在第二种方式中,一般是工具将 js 文本解析成抽象语法树(AST,Abstract Syntax Tree,抽象语法树),然后对这棵语法树以面向对象的方式做增删改等操作,最后再导出成新的代码文本。

生成抽象语法树的工具主要有:

Acorn: 比如 webpack、rollup、UglifyJS 等工具底层都是使用的 acorn 抽象语法树解析器

babel-parser: babel 转码工具底层使用的抽象语法树解析器

acorn 为例,将 1 + 1 片段进行解析:
const acorn = require("acorn");

const tree = acorn.parse("1 + 1");
// tree 的 json 化表示
{
  type: "Program",
  start: 0,
  end: 5,
  body: [{
    type: "ExpressionStatement",
    start: 0,
    end: 5,
    expression: {
      type: "BinaryExpression",
      start: 0,
      end: 5,
      left: { type: "Literal", start: 0, end: 1, value: 1, raw: "1" },
      operator: "+",
      right: { type: "Literal", start: 4, end: 5, value: 1, raw: "1" } 
    }
  }],
  sourceType: "script" 
}
babel-parser 为例,将 1 + 1 片段进行解析:
const parser = require("@babel/parser");

const tree = parser.parse("1 + 1");
// tree 的 json 化表示
{
  type: "File",
  start: 0,
  end: 5,
  loc: {
    start: { line: 1, column: 0 },
    end: { line: 1, column: 5 } 
  },
  program: {
    type: "Program",
    start: 0,
    end: 5,
    loc: {
      start: { line: 1, column: 0 },
      end: { line: 1, column: 5 } 
    },
    sourceType: "script",
    interpreter: null,
    body: [{
      type: "ExpressionStatement",
      start: 0,
      end: 5,
      loc: {
        start: { line: 1, column: 0 },
        end: { line: 1, column: 5 } 
      },
      expression: {
        type: "BinaryExpression",
        start: 0,
        end: 5,
        loc: {
          start: { line: 1, column: 0 },
          end: { line: 1, column: 5 } 
        },
        left: {
          type: "NumericLiteral",
          start: 0,
          end: 1,
          loc: {
            start: { line: 1, column: 0 },
            end: { line: 1, column: 5 } 
          },
          extra: { rawValue: 1, raw: "1" },
          value: 1        
        },
        operator: "+",
        right: {
          type: "NumericLiteral",
          start: 4,
          end: 5,
          loc: {
            start: { line: 1, column: 0 },
            end: { line: 1, column: 5 } 
          },
          extra: { rawValue: 1, raw: "1" },
          value: 1 
        } 
      } 
    }],
    directives: [] 
  },
  comments: [] 
}
3. 操作 css 文件

css 的语法比 html 要复杂一些,一些简单的操作如插入、替换,可以用直接以字符串的方式操作,但如果是压缩、auto prefix、css-modules 等复杂的功能时,就需要用第二种方式操作 css 了。

在第二种方式中,一般也是将 css 文本解析成一棵抽象语法树,然后进行操作。

比如:

postcss: 比如 css-loader、autoprefixer、cssnano 等的底层都是使用的 postcss 来解析

rework、reworkcss: 抽象语法树解析器

csstree: 比如 csso 的底层就是使用 csstree 来解析

postcss 为例,操作 css 文本:
const autoprefixer = require("autoprefixer");
const postcss = require("postcss");
const precss = require("precss");

const css = `
.hello {
  display: flex;
  color: red;
  backgroundColor: #ffffff;
}
`;

postcss([precss, autoprefixer({browsers: ["last 2 versions", "> 5%"]})])
  .process(css)
  .then(result => {
    console.log(result.css);
  });

输出的文本:

.hello {
  display: -webkit-box;
  display: -ms-flexbox;
  display: flex;
  color: red;
  backgroundColor: #ffffff;
}
rework 为例,操作 css 文本:
const css = require("css");
const ast = css.parse("body { font-size: 12px; }");

console.log(css.stringify(ast));

输出的文本:

body {
  font-size: 12px;
}
4. 操作 markdown/md 文件

一般来说,操作 markdown 文本的目的有两个:

作为编辑器编辑 markdown 文本,或作为渲染器渲染 markdown 文本为 html 文本

markdown 文本中读取信息、校验嵌入的源代码、优化格式等

所以,尽管 markdown 的语法也很简单,但一般并不会直接去使用字符串的方式去操作 markdown 文本,一般都是使用的第二种方式。

比如:

markdown-it: 作为编辑器或渲染器的好手

remark: 构建抽象语法树进行操作的好手

markdown-it 为例,操作 markdown 文本:
const md = require("markdown-it")();
const result = md.render("# markdown-it rulezz!");

console.log(result);

输出的文本:

markdown-it rulezz!

remark 为例,操作 markdown 文本:
const remark = require("remark")
const recommended = require("remark-preset-lint-recommended")
const html = require("remark-html")
const report = require("vfile-reporter")

remark()
  .use(recommended)
  .use(html)
  .process("## Hello world!", function(err, file) {
    console.error(report(err || file))
    console.log(String(file))
  })

校验错误提示:

1:1  warning  Missing newline character at end of file  final-newline  remark-lint

⚠ 1 warning

输出的文本:

Hello world!

后续

更多博客,查看 https://github.com/senntyou/blogs

作者:深予之 (@senntyou)

版权声明:自由转载-非商用-非衍生-保持署名(创意共享3.0许可证)

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/114147.html

相关文章

  • 构建工具是如何用 node 操作 html/js/css/md 文件

    摘要:构建工具是如何用操作文件的从本质上来说,源代码文件都是文本文件,文本文件的内容都是字符串,对文本文件的操作其实就是对字符串的操作。在第二种方式中,一般也是将文本解析成一棵抽象语法树,然后进行操作。 构建工具是如何用 node 操作 html/js/css/md 文件的 从本质上来说,html/js/css/md ... 源代码文件都是文本文件,文本文件的内容都是字符串,对文本文件的操作...

    AZmake 评论0 收藏0
  • 个数是如何用大数据做行为预测

    摘要:个数通过可视化埋点技术及大数据分析能力从用户属性渠道质量行业对比等维度对进行全面的统计分析。总的来说,在大数据行为预测的帮助下,运营者能够更及时更全面地了解用户,从而达到精细化运营的目的。 个数是个推旗下面向 APP 开发者提供数据统计分析的产品。个数通过可视化埋点技术及大数据分析能力从用户属性、渠道质量、行业对比等维度对 APP 进行全面的统计分析。 个数不仅可以及时统计用户的活跃、...

    rollback 评论0 收藏0
  • 个数是如何用大数据做行为预测

    摘要:个数通过可视化埋点技术及大数据分析能力从用户属性渠道质量行业对比等维度对进行全面的统计分析。总的来说,在大数据行为预测的帮助下,运营者能够更及时更全面地了解用户,从而达到精细化运营的目的。 个数是个推旗下面向 APP 开发者提供数据统计分析的产品。个数通过可视化埋点技术及大数据分析能力从用户属性、渠道质量、行业对比等维度对 APP 进行全面的统计分析。 个数不仅可以及时统计用户的活跃、...

    张率功 评论0 收藏0
  • 是如何用Madpecker去管理bug

    摘要:现在国内外的工具很多,今天我要说的是我们团队现在用的一款功能强大操作方便的管理工具,我们平时提做测试敏捷开发什么的都是用的这个。 现在国内外的bug工具很多,今天我要说的是我们团队现在用的一款功能强大操作方便的bug管理工具---MadPecker,我们平时提BUG、做测试、敏捷开发什么的都是用的这个。 1.登录他们的官网 https://www.madpecker.com/homes...

    mozillazg 评论0 收藏0
  • 是如何用Madpecker去管理bug

    摘要:现在国内外的工具很多,今天我要说的是我们团队现在用的一款功能强大操作方便的管理工具,我们平时提做测试敏捷开发什么的都是用的这个。 现在国内外的bug工具很多,今天我要说的是我们团队现在用的一款功能强大操作方便的bug管理工具---MadPecker,我们平时提BUG、做测试、敏捷开发什么的都是用的这个。 1.登录他们的官网 https://www.madpecker.com/homes...

    Aceyclee 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<