docs: update documentation slugs (#150)

Author: EscapedGibbon

.github/workflows/nodejs.yml

@@ -16,3 +16,17 @@ jobs:
       node-version-matrix: '[24]'
       upload-coverage: false
       disable-test-package: true
+
+  check-filenames:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+
+      - name: Run filenames check
+        run: node checkFilenames.mjs

blog/releases/1.0.md

@@ -149,8 +149,8 @@ The new `blackRois` and `whiteRois` properties provide more intuitive access to
 
 For more information, please visit these tutorials:
 
-- [Image segmentation with `threshold()` and `fromMask()`](../../docs/Tutorials/Image%20segmentation%20with%20threshold)
-- [Image segmentation with `watershed()`](../../docs/Tutorials/Image%20segmentation%20with%20watershed)
+- [Image segmentation with `threshold()` and `fromMask()`](../../docs/tutorials/image-segmentation-with-threshold)
+- [Image segmentation with `watershed()`](../../docs/tutorials/image-segmentation-with-watershed)
 
 ### Sobel and Scharr filters
 
@@ -266,7 +266,7 @@ The following deprecated features have been removed:
 
 - `countAlphaPixel()` - Use custom pixel counting with [`getPixel()`](https://api.image-js.org/classes/index.Image.html#getpixel 'API link on getPixel').
 - `paintLabels()` and `roi.paint()` - Features have been removed due to dependency issues. We plan to add it back in future updates.
-- `warpingFourPoints()` - Use [`getPerspectiveWarpMatrix()`](../../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on getPerspectiveWarp') + [`transform()`](#transform) instead.
+- `warpingFourPoints()` - Use [`getPerspectiveWarpMatrix()`](../../docs/features/geometry/get-perspective-warp-matrix 'internal link on getPerspectiveWarp') + [`transform()`](#transform) instead.
 - 32-bit color depth support and `abs()` have been removed.
 - `CMYK` and `HSL` color models have been removed.
 - `paintMasks()` has been removed. Use [`paintMask()`](https://api.image-js.org/classes/index.Image.html#paintmask 'API link on paintMask')+ a `for` loop.
@@ -303,7 +303,7 @@ const matrix = getPerspectiveWarp(sourcePoints);
 const warped = img.transform(matrix);
 ```
 
-For more details, [visit our tutorial](../../docs/Tutorials/Applying%20transform%20function%20on%20images 'internal link on transform function tutorial') on how image transformations work how they can be used.
+For more details, [visit our tutorial](../../docs/tutorials/applying-transform-function-on-images 'internal link on transform function tutorial') on how image transformations work how they can be used.
 
 ### Bicubic interpolation
 
@@ -323,11 +323,11 @@ const resized = img.resize(800, 600, { interpolation: 'bicubic' });
 const prewitt = img.derivative({ filter: 'prewitt' });
 ```
 
-**Use cases**: Object detection, image segmentation, feature extraction. You can [learn more about it here](../../docs/Features/Morphology/Morphological%20Gradient 'internal link on morphological gradient').
+**Use cases**: Object detection, image segmentation, feature extraction. You can [learn more about it here](../../docs/features/morphology/morphological-gradient 'internal link on morphological gradient').
 
 ### Migration from deprecated methods
 
-`warpingFourPoints()` has been removed. Now you have [`getPerspectiveWarp()`](../../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on perspective warp') that returns a matrix that can be applied on the image of interest in a new `transform()`.
+`warpingFourPoints()` has been removed. Now you have [`getPerspectiveWarp()`](../../docs/features/geometry/get-perspective-warp-matrix 'internal link on perspective warp') that returns a matrix that can be applied on the image of interest in a new `transform()`.
 
 ```ts
 // Before
@@ -338,7 +338,7 @@ const matrix = getPerspectiveWarp(corners);
 const warped = img.transform(matrix);
 ```
 
-**Use cases**: Rectification of a perspective angle of an image. You can learn more about it [here](../../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on perspective warp').
+**Use cases**: Rectification of a perspective angle of an image. You can learn more about it [here](../../docs/features/geometry/get-perspective-warp-matrix 'internal link on perspective warp').
 
 ### `merge()`
 

checkFilenames.mjs

@@ -0,0 +1,53 @@
+import fs from 'fs';
+import path from 'path';
+
+const __dirname = import.meta.dirname;
+
+function getAllFiles(dirPath) {
+  let incorrectFormatFiles = [];
+  const entries = fs.readdirSync(dirPath, { withFileTypes: true });
+
+  const filenameFormat = /^[a-z0-9]+(?:[-.][a-z0-9]+)*$/;
+
+  for (const entry of entries) {
+    // Skip certain files/folders
+    if (
+      entry.name === '.DS_Store' ||
+      entry.name === 'images' ||
+      entry.name === 'demos' ||
+      entry.name === '_category_.json'
+    ) {
+      continue;
+    }
+
+    // Get the name without extension for files, or full name for directories
+    const nameToTest = entry.isFile()
+      ? path.parse(entry.name).name
+      : entry.name;
+
+    if (!filenameFormat.test(nameToTest)) {
+      incorrectFormatFiles.push(path.join(dirPath, entry.name));
+    }
+
+    // Recursively check subdirectories
+    if (entry.isDirectory()) {
+      const subDirResults = getAllFiles(path.join(dirPath, entry.name));
+      incorrectFormatFiles = incorrectFormatFiles.concat(subDirResults);
+    }
+  }
+
+  return incorrectFormatFiles;
+}
+
+const folders = ['docs', 'blog'];
+
+for (const folder of folders) {
+  const folderPath = path.join(__dirname, folder);
+  const incorrectFormatFiles = getAllFiles(folderPath);
+  if (incorrectFormatFiles.length !== 0) {
+    throw new Error(
+      `Files with incorrect filename format found:\n${incorrectFormatFiles.join('\n')}`,
+    );
+  }
+}
+console.log('All files have passed the check.');