Как добавить HTML-комментарии в index.html при сборке в Vue CLI?

Обновление 1: исправлена ​​проблема с синтаксисом, которая вызывала мои первоначальные ошибки сборки.

Обновление 2: нашел собственное решение с помощью плагина Webpack. См. принятое решение.

Я хочу добавить некоторые пользовательские HTML-комментарии в public/index.html во время сборки. Я добавил что-то вроде этого:

<!--
My Application
Version: <%= VUE_APP_VERSION %>
Build date: <%= VUE_APP_BUILD_DATE %>
-->

В моем vue.config.js я установил VUE_APP_VERSION и VUE_APP_BUILD_DATE соответственно:

let today = new Date().toLocaleDateString(undefined, {
  year: 'numeric',
  month: '2-digit',
  day: '2-digit'
})

process.env.VUE_APP_VERSION = require('./package.json').version
process.env.VUE_APP_BUILD_DATE = today

Но когда я на самом деле строю (npm run build), комментарии удаляются полностью и все сводится к минимуму.

Как сохранить комментарии?

Стоит ли изучать PHP в 2023-2024 годах?
Стоит ли изучать PHP в 2023-2024 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Приемы CSS-макетирования - floats и Flexbox
Приемы CSS-макетирования - floats и Flexbox
Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
1
0
1 863
2
Перейти к ответу Данный вопрос помечен как решенный

Ответы 2

Я смог заставить это работать, используя синтаксис интерполяции с экранированием HTML.

  • <%= VALUE %> для неэкранированной интерполяции;
  • <%- VALUE %> для интерполяции с экранированием HTML; 👈🏻 этот
  • <% выражение %> для потоков управления JavaScript.

Обратите внимание и на другой закрывающий тег.

Таким образом, ваш index.html становится:

<!--
My Application
Version: <%- VUE_APP_VERSION %>
Build date: <%- VUE_APP_BUILD_DATE %>
-->

@camaluay Это работает для атрибутов в тегах HTML (например, <meta property = "build-date" value = "<%= VUE_APP_BUILD_DATE %>">). Но весь блок комментариев в index.html удаляется после npm run build.

Kevin 29.12.2020 18:39
Ответ принят как подходящий

Нашел решение с помощью плагинов HtmlWebpackPlugin и WebpackAutoInject в моем vue.config.js файле; отказ от использования переменной VUE_APP_* в моем index.html, поскольку это вызывало у меня ошибки сборки.

npm install html-webpack-plugin --save-dev
npm install webpack-auto-inject-version --save-dev

Моя новая vue.config.js:

const HtmlWebpackPlugin = require('html-webpack-plugin')
const WebpackAutoInject = require('webpack-auto-inject-version')

module.exports = {
  publicPath: process.env.NODE_ENV === 'production'
    ? process.env.VUE_APP_PUBLIC_PATH_EN
    : '/',

  configureWebpack: {
    plugins: [
      // index.html customization
      new HtmlWebpackPlugin({
        template: 'public/index.html',
        filename: 'index.html',
        inject: true,
        deploy: process.env.VUE_APP_DEPLOY,
        webtrends: '/webtrends/scripts/webtrends.load.js', // include webtrends script for OPS only
        minify: {
          removeComments: false
        }
      }),

      // Auto inject version
      new WebpackAutoInject({
        SILENT: true,
        // options
        components: {
          AutoIncreaseVersion: false,
          InjectAsComment: false
        },
        componentsOptions: {
          InjectByTag: {
            // https://www.npmjs.com/package/dateformat
            dateFormat: 'isoUtcDateTime'
          }
        }
      })
    ]
  }
}

Затем в моем index.html (с пользовательским скриптом для включения в сборку):

<!--
My application
Version: [AIV]{version}[/AIV]
Build date: [AIV]{date}[/AIV]
-->
<% if (htmlWebpackPlugin.options.deploy === 'ops') { %>
    <script src = "<%= htmlWebpackPlugin.options.webtrends %>"></script>
<% } %>

Другие вопросы по теме