Fixing build (#5)

Denis-Averin · web-flow · commit 58a01d3bc941 · 2025-10-07T22:49:36.000+07:00
* Change submodule to sparse-repo location

* Fix `npm test` command

* Fix npm test command on Windows

* Fix comment in .gitignore

* Fixing build scripts

* Fixing build scripts on macOS

* Fix makefile

* Adjusted .editorconfig
diff --git a/.editorconfig b/.editorconfig
@@ -13,6 +13,16 @@ insert_final_newline = true
 indent_size = 4
 indent_style = space
 
+[*.js]
+indent_size = 4
+indent_style = space
+end_of_line = crlf
+
+[*.html]
+indent_size = 4
+indent_style = space
+end_of_line = crlf
+
 [*.bash]
 indent_size = 2
 indent_style = space
diff --git a/Makefile b/Makefile
@@ -0,0 +1,22 @@
+SPARSE_REPO = ./sparse-repo/products.aspose.cloud
+
+.PHONY: init
+init: update-sparse-repo links
+
+.PHONY: links
+links: remove-broken-links
+	ln -sv "$(SPARSE_REPO)/archetypes" | true
+	ln -sv "$(SPARSE_REPO)/assets" | true
+	ln -sv "$(SPARSE_REPO)/themes" | true
+
+	ln -sv "$(SPARSE_REPO)/config-prod.toml" | true
+
+	ln -sv ".$(SPARSE_REPO)/content/_index.md" "./content/_index.md" | true
+
+.PHONY: update-sparse-repo
+update-sparse-repo:
+	./scripts/update-sparse-repo.bash
+
+.PHONY: remove-broken-links
+remove-broken-links:
+	find . -type l ! -exec test -e {} \; -exec rm {} \;
diff --git a/archetypes b/archetypes
@@ -1 +1 @@
-./submodules/products.aspose.cloud/archetypes
+./sparse-repo/products.aspose.cloud/archetypes
diff --git a/assets b/assets
@@ -1 +1 @@
-./submodules/products.aspose.cloud/assets
+./sparse-repo/products.aspose.cloud/assets
diff --git a/config-prod.toml b/config-prod.toml
@@ -1 +1 @@
-submodules/products.aspose.cloud/config-prod.toml
+./sparse-repo/products.aspose.cloud/config-prod.toml
diff --git a/content/_index.md b/content/_index.md
@@ -1 +1 @@
-../submodules/products.aspose.cloud/content/_index.md
+../sparse-repo/products.aspose.cloud/content/_index.md
diff --git a/data/.gitignore b/data/.gitignore
@@ -1,4 +1,4 @@
-# This /static/ dir will be created and updated with /scripts/update-theme.bash
-# from the submodule of large products.aspose.cloud
+# This /data/ dir will be created and updated with /scripts/update-sparse-repo.bash
+# from the sparse copy of large products.aspose.cloud
 *
 !.gitignore
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -5,11 +5,11 @@
   "homepage": "https://products.aspose.cloud/barcode/",
   "devDependencies": {
     "autoprefixer": "^10.4.21",
-    "npm-check-updates": "^18.3.0",
+    "npm-check-updates": "^19.0.0",
     "postcss-cli": "^11.0.1"
   },
   "scripts": {
-    "test": "node -e \"const fs=require('fs');const {execSync}=require('child_process');const required=fs.readFileSync('.hugo_version','utf8').trim();const installed=execSync('hugo version').toString().match(/v[\\d.]+/)[0].slice(1);if (required === installed) { console.log(`Installed Hugo version ${installed} is OK.`); } else throw new Error(`Installed Hugo version mismatch: required ${required}, but found ${installed}`);\"",
+    "test": "node ./scripts/check-hugo-version.js",
     "check-updates": "ncu -u --enginesNode"
   }
 }
diff --git a/public/.gitignore b/public/.gitignore
@@ -1,4 +1,4 @@
-# This /static/ dir will be created and updated with /scripts/update-theme.bash
-# from the submodule of large products.aspose.cloud
+# This /static/ dir will be created and updated with /scripts/update-sparse-repo.bash
+# from the sparse copy of large products.aspose.cloud
 *
 !.gitignore
diff --git a/scripts/change-barcode-urls.bash b/scripts/change-barcode-urls.bash
@@ -0,0 +1,11 @@
+#!/bin/bash
+set -euo pipefail
+
+# Go to project root directory
+pushd "$(dirname "$0")/.."
+
+BARCODE_DIR="./barcode/"
+
+echo "Find and Replace: url: -> url_ignore: in all *_index.md files in ${BARCODE_DIR}"
+find "${BARCODE_DIR}" -type f -name "_index.md" -exec sed -i 's/^url:/url_ignore:/g' {} +
+echo "URLs were replaced"
diff --git a/scripts/change-urls.bash b/scripts/change-urls.bash
diff --git a/scripts/check-hugo-version.js b/scripts/check-hugo-version.js
@@ -0,0 +1,12 @@
+const fs = require("fs");
+const { execSync } = require("child_process");
+const required = fs.readFileSync(".hugo_version", "utf8").trim();
+const hugo_full_version = execSync("hugo version").toString();
+
+const installed = hugo_full_version.match(/v[\d.]+/)[0].slice(1);
+if (required === installed) {
+  console.log(`Installed Hugo version ${installed} is OK.`);
+} else
+  throw new Error(
+    `Installed Hugo version mismatch: required ${required}, but found ${installed}`
+  );
diff --git a/scripts/hugo-server.bash b/scripts/hugo-server.bash
@@ -3,20 +3,18 @@ set -euo pipefail
 
 HUGO_CONTENT_DIR="content"
 
-# HUGO_CONFIG="./submodules/products.aspose.cloud/config-prod.toml"
 HUGO_CONFIG="./config-prod.toml"
-# HUGO_THEMES_DIR="./submodules/products.aspose.cloud/themes/"
 HUGO_THEMES_DIR="./themes/"
 
 # HUGO_BASE_URL="https://aspose.test"
 HUGO_BASE_URL="https://products.aspose.cloud"
-FILE_TO_CHECK="public/barcode/index.html"
+FILE_TO_CHECK="./public/barcode/index.html"
 
-# Go to content directory
+# Go to project root directory
 pushd "$(dirname "$0")/.."
 
 # See https://github.com/aspose-cloud/products.aspose.cloud-workflows/blob/main/.github/workflows/barcode-production.yml
-./scripts/change-urls.bash "${HUGO_CONTENT_DIR}"
+./scripts/change-barcode-urls.bash
 
 echo "Building site with Hugo..."
 hugo \
diff --git a/scripts/install-hugo.bash b/scripts/install-hugo.bash
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
-# Go to content directory
+# Go to project root directory
 pushd "$(dirname "$0")/.."
 
 # Extended build (for SCSS/SASS)
diff --git a/scripts/update-sparse-repo.bash b/scripts/update-sparse-repo.bash
@@ -1,14 +1,16 @@
 #!/bin/bash
 set -euo pipefail
 
-# Go to submodules directory
-pushd "$(dirname "$0")/../submodules/"
+SPARSE_REPO_NAME="products.aspose.cloud"
+
+# Go to sparse-repo directory
+pushd "$(dirname "$0")/../sparse-repo/"
 
 # Check if the repository already exists
-if [ ! -d "products.aspose.cloud" ]; then
+if [ ! -d "${SPARSE_REPO_NAME}" ]; then
   echo "Cloning sparse repository..."
-  git clone --depth 1 --filter=blob:none --sparse git@github.com:aspose-cloud/products.aspose.cloud.git
-  pushd "products.aspose.cloud"
+  git clone --depth 1 --filter=blob:none --sparse git@github.com:aspose-cloud/products.aspose.cloud.git "${SPARSE_REPO_NAME}"
+  pushd "${SPARSE_REPO_NAME}"
   # Switch sparse-checkout to non-cone mode (needed for single files)
   git sparse-checkout init --no-cone
   # Enable sparse checkout for all except heavy dir with /content/
@@ -18,18 +20,20 @@ if [ ! -d "products.aspose.cloud" ]; then
     content/barcode/ \
     content/_index.md
 else
-  echo "products.aspose.cloud repository already exists."
-  pushd "products.aspose.cloud"
+  echo "${SPARSE_REPO_NAME} repository already exists."
+  pushd "${SPARSE_REPO_NAME}"
   echo "Pulling latest changes..."
   git pull
 fi
 # echo "Sparse checkout includes:"
 # git sparse-checkout list
 # You are in a sparse checkout with 1% of tracked files present.
 
-# Copy static and data content from submodule to main site
+# Copy /static/ and /data/ content from sparse repo to main site
 # Hugo does not support symlinks for this
+echo "copying to /static/ ..."
 cp -r static/* ../../static/
+echo "copying to /data/ ..."
 cp -r data/* ../../data/
 
 popd
diff --git a/scripts/verify-symlinks.bash b/scripts/verify-symlinks.bash
@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Go to project root directory
+pushd "$(dirname "$0")/.."
+
+# Flag to track broken symlinks
+exit_code=0
+
+# Find and verify
+while IFS= read -r -d '' link; do
+    target=$(readlink -f "$link" 2>/dev/null || true)
+    if [[ ! -e "$target" ]]; then
+        echo "❌ BROKEN: $link → $(readlink "$link")"
+        exit_code=1
+    fi
+done < <(find . -type l -print0)
+
+# Summary
+if [[ $exit_code -eq 0 ]]; then
+    echo "✅ All symlinks are valid."
+else
+    echo "⚠️ broken symlinks found."
+fi
+
+popd
+
+exit $exit_code
diff --git a/sparse-repo/.gitignore b/sparse-repo/.gitignore
@@ -0,0 +1,3 @@
+# This dir will be created with /scripts/update-sparse-repo.bash
+*
+!.gitignore
diff --git a/static/.gitignore b/static/.gitignore
@@ -1,4 +1,4 @@
-# This /static/ dir will be created and updated with /scripts/update-theme.bash
-# from the submodule of large products.aspose.cloud
+# This /static/ dir will be created and updated with /scripts/update-sparse-repo.bash
+# from the sparse copy of large products.aspose.cloud
 *
 !.gitignore
diff --git a/submodules/.gitignore b/submodules/.gitignore
diff --git a/themes b/themes
@@ -1 +1 @@
-submodules/products.aspose.cloud/themes
+./sparse-repo/products.aspose.cloud/themes

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-./submodules/products.aspose.cloud/archetypes`
	`1`	`+./sparse-repo/products.aspose.cloud/archetypes`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-./submodules/products.aspose.cloud/assets`
	`1`	`+./sparse-repo/products.aspose.cloud/assets`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-submodules/products.aspose.cloud/config-prod.toml`
	`1`	`+./sparse-repo/products.aspose.cloud/config-prod.toml`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-../submodules/products.aspose.cloud/content/_index.md`
	`1`	`+../sparse-repo/products.aspose.cloud/content/_index.md`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# This /static/ dir will be created and updated with /scripts/update-theme.bash`
`2`		`-# from the submodule of large products.aspose.cloud`
	`1`	`+# This /data/ dir will be created and updated with /scripts/update-sparse-repo.bash`
	`2`	`+# from the sparse copy of large products.aspose.cloud`
`3`	`3`	`*`
`4`	`4`	`!.gitignore`
Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,11 @@`
`5`	`5`	`"homepage": "https://products.aspose.cloud/barcode/",`
`6`	`6`	`"devDependencies": {`
`7`	`7`	`"autoprefixer": "^10.4.21",`
`8`		`- "npm-check-updates": "^18.3.0",`
	`8`	`+ "npm-check-updates": "^19.0.0",`
`9`	`9`	`"postcss-cli": "^11.0.1"`
`10`	`10`	`},`
`11`	`11`	`"scripts": {`
`12`		- "test": "node -e \"const fs=require('fs');const {execSync}=require('child_process');const required=fs.readFileSync('.hugo_version','utf8').trim();const installed=execSync('hugo version').toString().match(/v[\\d.]+/)[0].slice(1);if (required === installed) { console.log(`Installed Hugo version ${installed} is OK.`); } else throw new Error(`Installed Hugo version mismatch: required ${required}, but found ${installed}`);\"",
	`12`	`+ "test": "node ./scripts/check-hugo-version.js",`
`13`	`13`	`"check-updates": "ncu -u --enginesNode"`
`14`	`14`	`}`
`15`	`15`	`}`