@hkamran/utility-assets 1.0.0

package/.eslintignore

@@ -0,0 +1,8 @@
+node_modules/*
+.gitignore
+.dccache
+
+**/dist/*
+**/node_modules/*
+**/.gitignore
+**/.dccache

package/.eslintrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+    root: true,
+    env: { node: true },
+    parserOptions: {
+        ecmaVersion: "latest",
+        sourceType: "module",
+    },
+    extends: ["eslint:recommended", "prettier"],
+};

package/.prettierignore

@@ -0,0 +1,10 @@
+node_modules/*
+.gitignore
+.dccache
+*.md
+
+**/dist/*
+**/node_modules/*
+**/.gitignore
+**/.dccache
+**/*.md

package/README.md

@@ -0,0 +1,12 @@
+# `@hkamran/utility-assets`
+
+[![License: AGPL-3.0-or-later](https://img.shields.io/badge/License-AGPL3.0-green.svg)](../../LICENSE.md)
+[![npm version](https://badge.fury.io/js/%40hkamran%2Futility-assets.svg)](https://badge.fury.io/js/%40hkamran%2Futility-assets.svg)
+
+A quick way to set up an assets site
+
+## Usage
+
+```bash
+npm i @hkamran/utility-assets
+```

package/index.d.ts

@@ -0,0 +1,17 @@
+export function minifyJSON(
+    basePath: string,
+    outputDir: string,
+    excludeSchemas?: string,
+): Promise<void>;
+export function minifyCSS(basePath: string, outputDir: string): Promise<void>;
+export function moveFiles(
+    basePath: string,
+    outputDir: string,
+    ignoredFilenameContents?: string[],
+    ignoredFileExtensions?: string[],
+): Promise<void>;
+export function moveFolder(basePath: string, outputDir: string): Promise<void>;
+/** @type {string} */
+export const basePath: string;
+/** @type {string} */
+export const baseOutputPath: string;

package/index.js

@@ -0,0 +1,176 @@
+import {
+    constants,
+    copyFile,
+    mkdir,
+    readdir,
+    readFile,
+    writeFile,
+} from "fs/promises";
+import { join } from "path";
+
+/**
+ * Minify all JSON files
+ * @param {string} basePath The base path to use
+ * @param {string} [excludeSchemas=true] Exclude schemas from the final product (optional, defaults to `true`)
+ * @param {string} outputDir The output directory
+ */
+export const minifyJSON = async (
+    basePath,
+    outputDir,
+    excludeSchemas = true,
+) => {
+    const files = (await readdir(basePath, { withFileTypes: true }))
+        .filter((item) => item.isFile())
+        .map((item) => item.name)
+        .filter(
+            (filename) =>
+                !filename.startsWith(".") &&
+                !filename.startsWith("_") &&
+                (excludeSchemas ? !filename.includes("schema") : true) &&
+                filename.endsWith("json") &&
+                filename !== "package.json",
+        );
+
+    files.forEach(
+        async (filename) =>
+            await writeFile(
+                join(outputDir, filename),
+                JSON.stringify(
+                    JSON.parse(await readFile(join(basePath, filename))),
+                ),
+            ),
+    );
+};
+
+/**
+ * Minify all CSS files
+ *
+ * Minification code courtesy of [@derder56 on Dev.to](https://dev.to/derder56/how-to-build-a-css-minifier-with-8-lines-of-javascript-4bj3)
+ *
+ * @param {string} basePath The base path to use
+ * @param {string} outputDir The output directory
+ */
+export const minifyCSS = async (basePath, outputDir) => {
+    const files = (await readdir(basePath, { withFileTypes: true }))
+        .filter((item) => item.isFile())
+        .map((item) => item.name)
+        .filter(
+            (filename) =>
+                !filename.startsWith(".") &&
+                !filename.startsWith("_") &&
+                filename.endsWith("css"),
+        );
+
+    files.forEach(
+        async (filename) =>
+            await writeFile(
+                join(outputDir, filename),
+                await (
+                    await readFile(join(basePath, filename))
+                )
+                    .toString()
+                    .replace(/([^0-9a-zA-Z\.#])\s+/g, "$1")
+                    .replace(/\s([^0-9a-zA-Z\.#]+)/g, "$1")
+                    .replace(/;}/g, "}")
+                    .replace(/\/\*.*?\*\//g, ""),
+            ),
+    );
+};
+
+/**
+ * Check if a string contains any ignored contents
+ * @param {string} check The string to check
+ * @param {string[]} ignoredContents The contents to check against
+ * @returns {boolean} Whether the string contains any of the `ignoredContents`
+ */
+const checkIgnoredContents = (check, ignoredContents) => {
+    for (const ignoredContent of ignoredContents) {
+        if (check.includes(ignoredContent)) {
+            return true;
+        }
+    }
+
+    return false;
+};
+
+/**
+ * Check if a string ends with any ignored endings
+ * @param {string} check The string to check
+ * @param {string[]} ignoredEndings The endings to check against
+ * @returns {boolean} Whether the string ends with any of the `ignoredEndings`
+ */
+const checkIgnoredEndings = (check, ignoredEndings) => {
+    for (const ignoredEnding of ignoredEndings) {
+        if (check.endsWith(ignoredEnding)) {
+            return true;
+        }
+    }
+
+    return false;
+};
+
+/**
+ * Move files
+ * @param {string} basePath The base path to use
+ * @param {string[]} [ignoredFilenameContents=[schema]] Skip filenames if they include certain snippets (optional, defaults to `["schema"]`)
+ * @param {string[]} [ignoredFileExtensions=[json,css,toml,md]] Skip filenames if they have certain extensions (optional, defaults to `["json", "css", "toml", "md"]`)
+ * @param {string} outputDir The output directory (optional)
+ */
+export const moveFiles = async (
+    basePath,
+    outputDir,
+    ignoredFilenameContents = ["schema"],
+    ignoredFileExtensions = ["json", "css", "toml", "md"],
+) => {
+    (await readdir(basePath, { withFileTypes: true }))
+        .filter((item) => item.isFile())
+        .map((item) => item.name)
+        .filter(
+            (filename) =>
+                !filename.startsWith(".") &&
+                !checkIgnoredContents(filename, ignoredFilenameContents) &&
+                !checkIgnoredEndings(filename, ignoredFileExtensions),
+        )
+        .forEach(
+            async (filename) =>
+                await copyFile(
+                    join(basePath, filename),
+                    join(outputDir, filename),
+                    constants.COPYFILE_EXCL,
+                ),
+        );
+};
+
+/**
+ * Move a folder and its file
+ * @param {string} basePath The base path to use
+ * @param {string} outputDir The output directory (optional)
+ */
+export const moveFolder = async (basePath, outputDir) => {
+    if (outputDir) {
+        await mkdir(outputDir);
+    }
+
+    (await readdir(basePath, { withFileTypes: true })).forEach(async (item) => {
+        if (item.isFile()) {
+            await copyFile(
+                join(basePath, item.name),
+                join(outputDir, item.name),
+                constants.COPYFILE_EXCL,
+            );
+        } else if (item.isDirectory()) {
+            await moveFolder(
+                join(basePath, item.name),
+                join(outputDir, item.name),
+            );
+        }
+    });
+};
+
+/** @type {string} */
+export const basePath = process.cwd();
+
+/** @type {string} */
+export const baseOutputPath = join(basePath, "dist");
+
+await mkdir(baseOutputPath);

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@hkamran/utility-assets",
+  "version": "1.0.0",
+  "description": "A quick way to set up an assets site",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "type": "module",
+  "author": {
+    "name": "H. Kamran",
+    "email": "hkamran@hkamran.com",
+    "url": "https://hkamran.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hkamran80/utilities-js.git",
+    "directory": "packages/assets"
+  },
+  "keywords": [
+    "assets",
+    "site",
+    "website",
+    "move",
+    "files",
+    "filesystem",
+    "fs",
+    "folder",
+    "folders",
+    "json",
+    "css"
+  ],
+  "license": "AGPL-3.0-or-later",
+  "bugs": {
+    "url": "https://github.com/hkamran80/utilities-js/issues?q=is%3Aopen+label%3A%22utility%3A+assets%22+sort%3Aupdated-desc"
+  },
+  "homepage": "https://github.com/hkamran80/utilities-js/tree/main/packages/assets#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@hkamran/prettier-config": "^1.1.1",
+    "eslint": "^8.36.0",
+    "eslint-config-prettier": "^8.7.0",
+    "prettier": "^2.8.4",
+    "typescript": "^4.6.2"
+  },
+  "prettier": "@hkamran/prettier-config",
+  "scripts": {
+    "lint": "eslint --ext .js,.ts --fix",
+    "format": "prettier . --write",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}