浏览代码

Merge pull request #735 from HugoDF/replace-readme-version

Replace pinned version in readme on build
Caleb Porzio 4 年之前
父节点
当前提交
0f2079c46c
共有 7 个文件被更改,包括 22 次插入13 次删除
  1. 3 4
      README.ja.md
  2. 2 2
      README.md
  3. 2 2
      README.pt.md
  4. 2 2
      README.ru.md
  5. 2 2
      README.zh-TW.md
  6. 10 0
      inject-version-readme.js
  7. 1 1
      package.json

+ 3 - 4
README.ja.md

@@ -14,7 +14,7 @@ DOM を保持し、適切な動作を施すことができます。
 
 **CDNより:** `<head>` セクションの最後に次のスクリプトを追加します。
 ```html
-<script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v1.10.1/dist/alpine.js" defer></script>
+<script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.6.0/dist/alpine.js" defer></script>
 ```
 
 それだけです。初期は自身で行われます。
@@ -31,9 +31,8 @@ import 'alpinejs'
 
 IE11 では、ポリフィルを提供する必要があります。次のスクリプトを上記の Alpine スクリプトの前にロードしてください。
 ```html
-<script src="https://polyfill.io/v3/polyfill.min.js?features=MutationObserver%2CArray.from%2CArray.prototype.forEach%2CMap%2CSet%2CArray.prototype.includes%2CString.prototype.includes%2CPromise%2CNodeList.prototype.forEach%2CObject.values%2CReflect%2CReflect.set"></script>
-
-<script src="https://cdn.jsdelivr.net/npm/proxy-polyfill@0.3.0/proxy.min.js"></script>
+<script type="module" src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.x.x/dist/alpine.min.js"></script>
+<script nomodule src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.x.x/dist/alpine-ie11.min.js" defer></script>
 ```
 
 ## 使う

+ 2 - 2
README.md

@@ -31,9 +31,9 @@ Think of it like [Tailwind](https://tailwindcss.com/) for JavaScript.
 That's it. It will initialize itself.
 
 For production environments, it's recommended to pin a specific version number in the link to avoid unexpected breakage from newer versions.
-For example, to use version `2.3.5`:
+For example, to use version `2.6.0` (latest):
 ```html
-<script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.3.5/dist/alpine.min.js" defer></script>
+<script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.6.0/dist/alpine.min.js" defer></script>
 ```
 
 **From NPM:** Install the package from NPM.

+ 2 - 2
README.pt.md

@@ -23,10 +23,10 @@ Pensem nisso como o [Tailwind](https://tailwindcss.com/) para JavaScript.
 E é isso. Ele vai se inicializar.
 
 Para ambiente de produção, é recomendado fixar o número da versão específico no link para evitar problemas inesperadas das versões mais recentes.
-Por exemplo, para usar a versão `2.3.5`:
+Por exemplo, para usar a versão `2.6.0`:
 
 ```html
-<script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.3.5/dist/alpine.min.js" defer></script>
+<script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.6.0/dist/alpine.min.js" defer></script>
 ```
 
 **Via NPM:** Instale o pacote pelo NPM.

+ 2 - 2
README.ru.md

@@ -22,9 +22,9 @@ Alpine.js предлагает вам реактивность и деклара
 Вот и всё. Он инициализируется самостоятельно.
 
 Для продакшн-окружения, рекомедуется использовать ссылку с конкретным номером версии, чтобы избежать неожиданных поломок после выпуска новых версий.
-Например, чтобы использовать версию `2.3.5`:
+Например, чтобы использовать версию `2.6.0`:
 ```html
-<script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.3.5/dist/alpine.min.js" defer></script>
+<script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.6.0/dist/alpine.min.js" defer></script>
 ```
 
 **С помощью NPM:** Установите пакет из NPM.

+ 2 - 2
README.zh-TW.md

@@ -22,9 +22,9 @@ Alpine.js 提供了 Vue 與 React 等大框架的互動式與宣告式的功能
 就這樣。Alpine.js 會自行初始化。
 
 在正式環境中,建議在連結中固定特定版本,以避免新版本使功能無法使用。
-如,要使用 `2.3.5` 版則可以這樣寫:
+如,要使用 `2.6.0` 版則可以這樣寫:
 ```html
-<script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.3.5/dist/alpine.min.js" defer></script>
+<script src="https://cdn.jsdelivr.net/gh/alpinejs/alpine@v2.6.0/dist/alpine.min.js" defer></script>
 ```
 
 **使用 NPM:** 從 NPM 安裝套件。

+ 10 - 0
inject-version-readme.js

@@ -0,0 +1,10 @@
+// Replace pinned version in README to latest (per package.json version field)
+const fs = require('fs');
+const pkg = require('./package.json');
+
+const readmeTranslations = fs.readdirSync('.').filter((name) => name.includes('README'))
+readmeTranslations.forEach((readmeName) => {
+    const original = fs.readFileSync(readmeName, 'utf8')
+    const updated = original.replace(/[0-9]+\.[0-9]+\.[0-9]+/gi, pkg.version)
+    fs.writeFileSync(readmeName, updated, 'utf8')
+})

+ 1 - 1
package.json

@@ -8,7 +8,7 @@
     },
     "scripts": {
         "watch": "rollup -c -w",
-        "build": "concurrently \"rollup -c\" \"npx rollup -c rollup-ie11.config.js\"",
+        "build": "concurrently \"rollup -c\" \"npx rollup -c rollup-ie11.config.js\" \"node inject-version-readme\"",
         "test": "npx jest",
         "test:debug": "node --inspect node_modules/.bin/jest --runInBand"
     },