refactor: replace shell scripts with JS for cross-platform support (#875)

Convert bin/ shell scripts to Node.js and npm scripts using shx and npm-run-all2. Remove unused build-icons.sh. Inlined simple scripts (build-docs-liquid, build-apidoc) as npm scripts.

Made-with: Cursor

bin/build-apidoc.sh

@@ -1,4 +0,0 @@
-#!/usr/bin/env bash
-
-rm -rf docs/source/api
-typedoc --plugin typedoc-plugin-missing-exports ./src --gitRevision master --out docs/source/api

bin/build-changelog.js

@@ -0,0 +1,24 @@
+const fs = require('fs')
+const path = require('path')
+
+const root = path.resolve(__dirname, '..')
+const src = path.join(root, 'CHANGELOG.md')
+
+let content = fs.readFileSync(src, 'utf8').replace(/\r\n/g, '\n')
+
+const lines = content.split('\n')
+lines[0] = lines[0]
+  .replace(/"/g, '"')
+  .replace(/</g, '&lt;')
+  .replace(/>/g, '&gt;')
+content = lines.join('\n')
+
+content = content
+  .replace(/{%/g, '{% raw %}{%{% endraw %}')
+  .replace(/\{\{/g, '{% raw %}{{{% endraw %}')
+
+const enFrontmatter = '---\ntitle: Changelog\nauto: true\n---\n\n'
+const zhFrontmatter = '---\ntitle: 更新日志\nauto: true\n---\n\n'
+
+fs.writeFileSync(path.join(root, 'docs/source/tutorials/changelog.md'), enFrontmatter + content)
+fs.writeFileSync(path.join(root, 'docs/source/zh-cn/tutorials/changelog.md'), zhFrontmatter + content)

bin/build-changelog.sh

@@ -1,15 +0,0 @@
-#!/usr/bin/env bash
-
-cd docs
-cp ../CHANGELOG.md source/tutorials/changelog.md
-sed -i \
-  -e 's/{%/{% raw %}{%{% endraw %}/g' \
-  -e 's/{{/{% raw %}{{{% endraw %}/g' \
-  -e '1 s/"/\"/g' \
-  -e '1 s/</\&lt;/g' \
-  -e '1 s/>/\&gt;/g' \
-  source/tutorials/changelog.md
-cp source/tutorials/changelog.md source/zh-cn/tutorials/changelog.md
-
-sed -i -e '1i\---\ntitle: Changelog\nauto: true\n---\n' source/tutorials/changelog.md
-sed -i -e '1i\---\ntitle: 更新日志\nauto: true\n---\n' source/zh-cn/tutorials/changelog.md

bin/build-contributors.js

@@ -0,0 +1,39 @@
+const fs = require('fs')
+const path = require('path')
+
+const root = path.resolve(__dirname, '..')
+const readme = fs.readFileSync(path.join(root, 'README.md'), 'utf8').replace(/\r\n/g, '\n')
+
+function extractSection (text, beginMarker, endMarker) {
+  const lines = text.split('\n')
+  let inside = false
+  const result = []
+  for (const line of lines) {
+    if (line.includes(endMarker)) inside = false
+    if (inside) result.push(line)
+    if (line.includes(beginMarker)) inside = true
+  }
+  return result.join('\n')
+}
+
+function transformContributors (html) {
+  return html
+    .replace(/<br \/>.*?<\/td>/g, '</a></td>')
+    .replace(/width="[^"]*"/g, '')
+    .replace(/\n/g, '')
+    .replace(/<\/tr>\s*<tr>/g, '')
+}
+
+function transformFinancial (html) {
+  return html
+    .replace(/<br \/>.*?<\/td>/g, '</a></td>')
+    .replace(/\n/g, '')
+    .replace(/<\/tr>\s*<tr>/g, '')
+}
+
+const allContributors = transformContributors(extractSection(readme, 'ALL-CONTRIBUTORS-LIST:START', 'ALL-CONTRIBUTORS-LIST:END'))
+const financialContributors = transformFinancial(extractSection(readme, 'FINANCIAL-CONTRIBUTORS-BEGIN', 'FINANCIAL-CONTRIBUTORS-END'))
+
+const outDir = path.join(root, 'docs/themes/navy/layout/partial')
+fs.writeFileSync(path.join(outDir, 'all-contributors.swig'), allContributors)
+fs.writeFileSync(path.join(outDir, 'financial-contributors.swig'), financialContributors)

bin/build-contributors.sh

@@ -1,25 +0,0 @@
-#!/usr/bin/env bash
-
-# Run `sed` in a way that's compatible with both macOS (BSD) and Linux (GNU)
-sedi() {
-  if [[ "$OSTYPE" == "darwin"* ]]; then
-    /usr/bin/sed -i '' "$@"
-  else
-    sed -i "$@"
-  fi
-}
-
-# create docs/themes/navy/layout/partial/all-contributors.swig
-awk '/ALL-CONTRIBUTORS-LIST:START/{flag=1;next}/ALL-CONTRIBUTORS-LIST:END/{flag=0}flag' README.md | \
-  sed 's/<br \/>.*<\/td>/<\/a><\/td>/g' | \
-  sed 's/width="[^"]*"//g' | \
-  tr -d '\n' | \
-  sed 's/<\/tr>\s*<tr>//g' \
-  > docs/themes/navy/layout/partial/all-contributors.swig
-
-# create docs/themes/navy/layout/partial/financial-contributors.swig
-awk '/FINANCIAL-CONTRIBUTORS-BEGIN/{flag=1;next}/FINANCIAL-CONTRIBUTORS-END/{flag=0}flag' README.md | \
-  sed 's/<br \/>.*<\/td>/<\/a><\/td>/g' | \
-  tr -d '\n' | \
-  sed 's/<\/tr>\s*<tr>//g' \
-  > docs/themes/navy/layout/partial/financial-contributors.swig

bin/build-docs-liquid.sh

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-
-BUNDLES=min npm run build
-mkdir -p docs/public/js/
-cp dist/liquid.browser.min.js docs/public/js/
-

bin/build-docs.sh

@@ -1,17 +0,0 @@
-#!/usr/bin/env bash
-
-set -ex
-
-./bin/build-docs-liquid.sh
-./bin/build-contributors.sh
-./bin/build-apidoc.sh
-./bin/build-changelog.sh
-
-cd docs
-npm ci
-npm run build
-cp CNAME public/
-
-if [ "$HEXO_ALGOLIA_INDEXING_KEY" != "" ]; then
-    npm run index
-fi

bin/build-icons.sh

@@ -1,36 +0,0 @@
-#!/usr/bin/env bash
-
-# Prerequisites:
-# 1.imagemagick. try brew install imagemagick
-# 2. logo.png in size 512x512
-# 3. this script should be run with cwd docs/source/icon/
-
-echo creating apple touch icons...
-apple=(57x57 60x60 72x72 76x76 114x114 120x120 144x144 152x152)
-for size in "${apple[@]}"; do
-    echo $size
-    convert logo.png -resize $size apple-touch-icon-$size.png
-done
-cp logo.png apple-touch-icon.png
-convert logo.png \
-     \( +clone -alpha extract \
-        -draw 'fill black polygon 0,0 0,80 80,0 fill white circle 80,80 80,0' \
-        \( +clone -flip \) -compose Multiply -composite \
-        \( +clone -flop \) -compose Multiply -composite \
-     \) -alpha off -compose CopyOpacity -composite apple-touch-icon-precomposed.png
-
-echo creating favicon...
-convert logo.png -resize 48x48 ../favicon.ico
-favicon=(16x16 32x32 96x96 160x160 196x196)
-for size in "${favicon[@]}"; do
-    echo $size
-    convert logo.png -resize $size favicon-$size.png
-done
-
-echo creating mstile icons...
-mstile=(70x70 144x144 150x150 310x310)
-for size in "${mstile[@]}"; do
-    echo $size
-    convert logo.png -resize $size mstile-$size.png
-done
-convert mstile-150x150.png -gravity center -background white -extent 310x150 mstile-310x150.png

bin/perf-diff.js

@@ -0,0 +1,17 @@
+const { execSync } = require('child_process')
+const fs = require('fs')
+const path = require('path')
+
+const root = path.resolve(__dirname, '..')
+const version = require(path.join(root, 'package.json')).version
+
+const fileLocal = path.join(root, 'dist/liquid.node.js')
+const fileLatest = path.join(root, `dist/liquid.node.${version}.js`)
+
+if (!fs.existsSync(fileLatest)) {
+  const url = `https://unpkg.com/liquidjs@${version}/dist/liquid.node.js`
+  console.log(`Downloading liquidjs@${version}...`)
+  execSync(`curl -sL -o "${fileLatest}" "${url}"`)
+}
+
+execSync(`node benchmark/diff.js "${fileLocal}" "${fileLatest}"`, { cwd: root, stdio: 'inherit' })

bin/perf-diff.sh

@@ -1,12 +0,0 @@
-#!/usr/bin/env bash
-
-VERSION_LATEST=$(cat package.json | grep '"version":' | head -1 | awk -F'"' '{print $4}')
-FILE_LOCAL=dist/liquid.node.js
-FILE_LATEST=dist/liquid.node.$VERSION_LATEST.js
-URL_LATEST=https://unpkg.com/liquidjs@$VERSION_LATEST/dist/liquid.node.js
-
-if [ ! -f "$FILE_LATEST" ]; then
-    curl $URL_LATEST > $FILE_LATEST
-fi
-
-exec node benchmark/diff.js $FILE_LOCAL $FILE_LATEST