V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
vilic
V2EX  ›  分享创造

搞了一个通过模板注释维护文件内容的小工具

  •  
  •   vilic ·
    vilicvane · 2020-07-25 20:15:36 +08:00 · 1178 次点击
    这是一个创建于 1342 天前的主题,其中的信息可能已经有所发展或是发生改变。

    项目各种包越来越多,手动维护比较蛋疼,容易遗漏,所以搞了这么个工具。

    https://github.com/makeflow/inplate

    例子

    Dockerfile

    FROM node
    
    # @inplate
    # {{#each packageFilePaths}}
    # COPY {{value}}{{padding}}  /app/{{value}}
    # {{/each}}
    # @plate
    # @end
    

    Dockerfile.js

    const Glob = require('glob');
    
    module.exports = {
      data: {
        packageFilePaths: pad(
          Glob.sync('**/package.json', {
            ignore: '**/node_modules/**',
          }),
        ),
      },
    };
    
    function pad(values) {
      let maxLength = Math.max(...values.map(value => value.length));
    
      return values.map(value => {
        return {
          value,
          padding: value.padEnd(maxLength).slice(value.length),
        };
      });
    }
    

    执行 inplate Dockerfile 后,文件就会被更新为类似:

    FROM node
    
    # @inplate
    # {{#each packageFilePaths}}
    # COPY {{value}}{{padding}}  /app/{{value}}
    # {{/each}}
    # @plate
    COPY package.json               /app/package.json
    COPY packages/foo/package.json  /app/packages/foo/package.json
    COPY packages/bar/package.json  /app/packages/bar/package.json
    # @end
    

    CI 中可以执行 inplate Dockerfile --assert 来确保文件已经更新,当然也支持配置文件、通配符等。

    目前尚无回复
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   5452 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 31ms · UTC 01:33 · PVG 09:33 · LAX 18:33 · JFK 21:33
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.