json-to-fs-structure 1.3.0 → 2.0.0

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "json-to-fs-structure",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "A simple module that takes a simple JSON file and produces the properties as a file structure in the same directory or given directory.",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "test": "jest",
+    "build": "tsc",
+    "pretest": "yarn build",
+    "prepublishOnly": "yarn build",
+    "test": "jest dist/test/index.test.js",
     "format": "yarn eslint . --fix"
   },
   "keywords": [
@@ -15,12 +22,15 @@
   "author": "eldavojohn",
   "license": "MIT",
   "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^26.0.0",
     "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.5",
     "jest": "^30.2.0",
     "mocha": "^11.7.5",
-    "prettier": "^3.8.1"
+    "prettier": "^3.8.1",
+    "typescript": "^6.0.3"
   },
   "resolutions": {
     "**/**/cryptiles": "^4.1.2",
@@ -39,5 +49,8 @@
     "mem": "^10.0.0",
     "minimist": "^1.2.3",
     "npm": "^11.8.0"
+  },
+  "publishConfig": {
+    "access": "public"
   }
-}
+}

package/.github/workflows/npm-publish.yml

@@ -1,33 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - run: npm ci
-      - run: npm test
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/eslint.config.mjs

@@ -1,35 +0,0 @@
-import { defineConfig } from "eslint/config";
-import prettier from "eslint-plugin-prettier";
-import globals from "globals";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import js from "@eslint/js";
-import { FlatCompat } from "@eslint/eslintrc";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const compat = new FlatCompat({
-  baseDirectory: __dirname,
-  recommendedConfig: js.configs.recommended,
-  allConfig: js.configs.all,
-});
-
-export default defineConfig([
-  {
-    extends: compat.extends("plugin:prettier/recommended"),
-
-    plugins: {
-      prettier,
-    },
-
-    languageOptions: {
-      globals: {
-        ...globals.node,
-      },
-    },
-
-    rules: {
-      "prettier/prettier": "error",
-    },
-  },
-]);

package/index.js

@@ -1,216 +0,0 @@
-const fs = require("fs");
-const { sep } = require("path");
-
-const isLeaf = (testNode) =>
-  testNode.constructor === Object && Object.keys(testNode).length === 0;
-
-const isEqualOrIsInArray = (property, stopWord) =>
-  stopWord &&
-  (property === stopWord ||
-    (Array.isArray(stopWord) && stopWord.indexOf(property) > -1));
-
-const levelPropertiesToDirectories = (
-  obj,
-  filePath,
-  stopWord,
-  ignoredWords,
-  spaceReplace,
-  executorObject = {},
-) => {
-  if (obj && (typeof obj === "string" || obj instanceof String)) {
-    return;
-  }
-  const { leafProcedure, nonLeafProcedure, procedure } = executorObject;
-  let { accumulator } = executorObject;
-  let promiseArray = [];
-  let fields = [];
-  if (obj && obj instanceof Array) {
-    obj.forEach((arrayObject) => {
-      promiseArray = promiseArray.concat(
-        levelPropertiesToDirectories(
-          arrayObject,
-          filePath,
-          stopWord,
-          ignoredWords,
-          spaceReplace,
-          {
-            leafProcedure,
-            nonLeafProcedure,
-            procedure,
-            accumulator,
-          },
-        ),
-      );
-    });
-  } else if (obj) {
-    fields = Object.keys(obj) || [];
-  }
-  fields.forEach((property) => {
-    if (
-      !isEqualOrIsInArray(property, stopWord) &&
-      ignoredWords.indexOf(property) === -1
-    ) {
-      const newPath = spaceReplace
-        ? `${filePath}${sep}${property.replace(/ /g, spaceReplace)}`
-        : `${filePath}${sep}${property}`;
-      let accumulatorCopy = Object.assign({}, accumulator);
-      try {
-        fs.mkdirSync(newPath);
-      } catch (e) {}
-      if (obj[`${property}`] && Object.keys(obj[`${property}`]).length > 0) {
-        if (nonLeafProcedure) {
-          accumulatorCopy = nonLeafProcedure(
-            newPath,
-            accumulator,
-            obj[`${property}`],
-            property,
-          );
-        }
-        if (procedure) {
-          accumulatorCopy = procedure(
-            newPath,
-            accumulator,
-            obj[`${property}`],
-            property,
-          );
-        }
-        promiseArray = promiseArray.concat(
-          levelPropertiesToDirectories(
-            obj[`${property}`],
-            newPath,
-            stopWord,
-            ignoredWords,
-            spaceReplace,
-            {
-              leafProcedure,
-              nonLeafProcedure,
-              procedure,
-              accumulator: accumulatorCopy,
-            },
-          ),
-        );
-      } else {
-        if (leafProcedure && isLeaf(obj[`${property}`])) {
-          leafProcedure(
-            newPath,
-            Object.assign({}, accumulator),
-            obj[`${property}`],
-            property,
-          );
-        }
-        if (procedure && isLeaf(obj[`${property}`])) {
-          procedure(
-            newPath,
-            Object.assign({}, accumulator),
-            obj[`${property}`],
-            property,
-          );
-        }
-      }
-    } else if (ignoredWords.indexOf(property) === -1) {
-      if (leafProcedure) {
-        leafProcedure(
-          `${filePath}${sep}`,
-          Object.assign({}, accumulator),
-          obj[`${property}`],
-          property,
-        );
-      }
-    }
-  });
-  return promiseArray;
-};
-
-exports.jsonToFsStructure = function ({
-  jsonObject,
-  filePath = ".",
-  callback = () => {},
-  stopWord,
-  spaceReplace,
-  ignoredWords = [],
-}) {
-  return Promise.all(
-    levelPropertiesToDirectories(
-      jsonObject,
-      filePath,
-      stopWord,
-      ignoredWords,
-      spaceReplace,
-    ),
-  ).then(callback);
-};
-
-exports.jsonToFsWithLeafFunction = function ({
-  jsonObject,
-  leafProcedure = () => {},
-  context = {},
-  filePath = ".",
-  callback = () => {},
-  stopWord,
-  spaceReplace,
-  ignoredWords = [],
-}) {
-  return Promise.all(
-    levelPropertiesToDirectories(
-      jsonObject,
-      filePath,
-      stopWord,
-      ignoredWords,
-      spaceReplace,
-      {
-        leafProcedure,
-        accumulator: context,
-      },
-    ),
-  ).then(callback);
-};
-
-exports.jsonToFsWithNonLeafFunction = function ({
-  jsonObject,
-  nonLeafProcedure = () => {},
-  context = {},
-  filePath = ".",
-  callback = () => {},
-  stopWord,
-  spaceReplace,
-  ignoredWords = [],
-}) {
-  return Promise.all(
-    levelPropertiesToDirectories(
-      jsonObject,
-      filePath,
-      stopWord,
-      ignoredWords,
-      spaceReplace,
-      {
-        nonLeafProcedure,
-        accumulator: context,
-      },
-    ),
-  ).then(callback);
-};
-
-exports.jsonToFsWithFunction = function ({
-  jsonObject,
-  procedure = () => {},
-  context = {},
-  filePath = ".",
-  callback = () => {},
-  stopWord,
-  spaceReplace,
-  ignoredWords = [],
-}) {
-  return Promise.all(
-    levelPropertiesToDirectories(
-      jsonObject,
-      filePath,
-      stopWord,
-      ignoredWords,
-      spaceReplace,
-      {
-        procedure,
-        accumulator: context,
-      },
-    ),
-  ).then(callback);
-};