@storm-software/workspace-tools 1.228.1 → 1.229.1

package/dist/src/executors/clean-package/executor.mjs

@@ -0,0 +1,303 @@
+import {
+  withRunExecutor
+} from "../../../chunk-6267MSX4.mjs";
+import "../../../chunk-FFBZYD6R.mjs";
+import "../../../chunk-NDDXQD7R.mjs";
+import {
+  writeInfo
+} from "../../../chunk-WJ5TU6JU.mjs";
+import "../../../chunk-DMUTOQCB.mjs";
+import {
+  joinPaths
+} from "../../../chunk-PVTEDLBL.mjs";
+import {
+  __name
+} from "../../../chunk-XUV4U54K.mjs";
+
+// src/executors/clean-package/executor.ts
+import { joinPathFragments } from "@nx/devkit";
+import { copy, mkdir, pathExists, readFile, readJson, remove, writeFile, writeJson } from "fs-extra";
+import { Glob as Glob2 } from "glob";
+
+// src/executors/clean-package/constants.ts
+var IGNORE_FILES = [
+  ".circleci",
+  ".DS_Store",
+  ".editorconfig",
+  ".eslintignore",
+  ".flowconfig",
+  ".git",
+  ".github",
+  ".travis.yml",
+  ".vscode",
+  ".watchmanconfig",
+  ".yarnrc",
+  "appveyor.yml",
+  "karma.conf.js",
+  "node_modules",
+  "package-lock.json",
+  "pnpm-debug.log",
+  "pnpm-lock.yaml",
+  ".devcontainer.json",
+  "test",
+  "yarn-error.log",
+  "yarn.lock",
+  /^(babel|commitlint|jest|vitest)\.config\.[cm]?(j|t)s$/,
+  /^\.?nano-staged\.(c|m)?js(on)?$/,
+  /^\.?simple-git-hooks.js(on)?$/,
+  /^\.?simple-pre-commit.js(on)?$/,
+  /^\.babelrc/,
+  /^\.clean-publish/,
+  /^\.commitlintrc/,
+  /^\.eslintrc/,
+  /^\.jsconfig/,
+  /^\.jsdocrc/,
+  /^\.lintstagedrc/,
+  /^\.nanostagedrc/,
+  /^\.prettierrc/,
+  /^\.remarkrc/,
+  /^\.renovaterc/,
+  /^\.size-limit/,
+  /^\.yaspellerrc/,
+  /^changelog/i,
+  /eslint.config.(c|m)?js/,
+  /README\.[\w-]+\.md/
+];
+var IGNORE_FIELDS = [
+  "babel",
+  "browserslist",
+  "c8",
+  "clean-publish",
+  "commitlint",
+  "devDependencies",
+  "eslintConfig",
+  "eslintIgnore",
+  "husky",
+  "jest",
+  "lint-staged",
+  "nano-staged",
+  "pre-commit",
+  "prettier",
+  "pwmetrics",
+  "remarkConfig",
+  "renovate",
+  "resolutions",
+  "sharec",
+  "simple-git-hooks",
+  "simple-pre-commit",
+  "size-limit",
+  "typeCoverage",
+  "yaspeller"
+];
+var NPM_SCRIPTS = [
+  "postinstall",
+  "postpack",
+  "postpublish",
+  "postversion",
+  "prepublish",
+  "publish",
+  "uninstall",
+  "version"
+];
+var PUBLISH_CONFIG_FIELDS = [
+  "bin",
+  "main",
+  "exports",
+  "types",
+  "typings",
+  "module",
+  "browser",
+  "esnext",
+  "es2015",
+  "unpkg",
+  "umd:main",
+  "typesVersions",
+  "cpu",
+  "os"
+];
+
+// src/executors/clean-package/utils.ts
+import { Glob, hasMagic } from "glob";
+import micromatch from "micromatch";
+import { basename } from "node:path";
+function isObject(object) {
+  return Boolean(object) && typeof object === "object";
+}
+__name(isObject, "isObject");
+function filterObjectByKey(object, filterByKey = (key) => true, deep = false) {
+  const result = {};
+  let changed = false;
+  for (const key in object) {
+    if (filterByKey(key)) {
+      if (deep && isObject(object[key])) {
+        result[key] = filterObjectByKey(object[key], filterByKey, deep);
+        if (result[key] !== object[key]) {
+          changed = true;
+        }
+      } else {
+        result[key] = object[key];
+      }
+    } else {
+      changed = true;
+    }
+  }
+  return changed ? result : object;
+}
+__name(filterObjectByKey, "filterObjectByKey");
+function createIgnoreMatcher(ignorePattern = "**/*") {
+  if (ignorePattern instanceof RegExp) {
+    return (filename) => !ignorePattern.test(filename);
+  }
+  if (hasMagic(ignorePattern, {
+    magicalBraces: true
+  })) {
+    const isMatch = micromatch.matcher(ignorePattern);
+    return (_filename, path) => !isMatch(path);
+  }
+  return (filename) => filename !== ignorePattern;
+}
+__name(createIgnoreMatcher, "createIgnoreMatcher");
+async function createFilesFilter(ignoreFiles = "", cwd) {
+  let ignoreFilesList = [];
+  if (ignoreFiles) {
+    const glob = new Glob(ignoreFiles, {
+      cwd
+    });
+    ignoreFilesList = await glob.walk();
+  }
+  const ignorePatterns = ignoreFilesList.length > 0 ? IGNORE_FILES.concat(...ignoreFilesList).filter(Boolean) : IGNORE_FILES;
+  const filter = ignorePatterns.reduce((next, ignorePattern) => {
+    const ignoreMatcher = createIgnoreMatcher(ignorePattern);
+    if (!next) {
+      return ignoreMatcher;
+    }
+    return (filename, path) => ignoreMatcher(filename, path) && next && next(filename, path);
+  }, null);
+  return (path) => {
+    const filename = basename(path);
+    return filter?.(filename, path);
+  };
+}
+__name(createFilesFilter, "createFilesFilter");
+
+// src/executors/clean-package/executor.ts
+async function cleanPackageExecutorFn(options, context, config) {
+  const tempDirectoryName = joinPathFragments(config.workspaceRoot, "tmp", context.root);
+  const exists = await pathExists(tempDirectoryName);
+  if (exists) {
+    writeInfo(`\u{1F9F9} Cleaning temporary directory path: ${tempDirectoryName}`, config);
+    await remove(tempDirectoryName);
+  }
+  await mkdir(tempDirectoryName);
+  writeInfo(`Created temporary directory: ${tempDirectoryName}`, config);
+  const packageJson = await readJson(options.packageJsonPath);
+  await copy(options.outputPath, tempDirectoryName, {
+    filter: createFilesFilter(options.ignoredFiles, options.outputPath)
+  });
+  if (options.cleanReadMe) {
+    await cleanReadMe(tempDirectoryName, packageJson.repository, packageJson.homepage);
+  }
+  if (options.cleanComments) {
+    await cleanComments(tempDirectoryName);
+  }
+  const tempPackageJson = clearPackageJSON(packageJson, options.fields);
+  writeJson(joinPathFragments(tempDirectoryName, "package.json"), tempPackageJson);
+  await copy(tempDirectoryName, options.outputPath, {
+    override: true,
+    preserveTimestamps: true
+  });
+  await remove(tempDirectoryName);
+  return {
+    success: true
+  };
+}
+__name(cleanPackageExecutorFn, "cleanPackageExecutorFn");
+function getReadmeUrlFromRepository(repository) {
+  const repoUrl = typeof repository === "object" ? repository.url : repository;
+  if (repoUrl) {
+    const name = repoUrl.match(/[^/:]+\/[^/:]+$/)?.[0]?.replace(/\.git$/, "");
+    return `https://github.com/${name}#README.md`;
+  }
+  return null;
+}
+__name(getReadmeUrlFromRepository, "getReadmeUrlFromRepository");
+async function cleanReadMe(directoryName, repository, homepage) {
+  const readmePath = joinPathFragments(directoryName, "README.md");
+  const readme = await readFile(readmePath);
+  const readmeUrl = getReadmeUrlFromRepository(repository);
+  if (homepage || readmeUrl) {
+    const cleaned = readme.toString().split(/\n##\s*\w/m)[0] + `
+## Documentation
+Read full docs **[here](${homepage || readmeUrl})**.
+`;
+    await writeFile(readmePath, cleaned);
+  }
+}
+__name(cleanReadMe, "cleanReadMe");
+async function cleanComments(directoryName) {
+  const glob = new Glob2([
+    "**/*.js"
+  ], {
+    cwd: directoryName
+  });
+  const files = await glob.walk();
+  await Promise.all(files.map(async (i) => {
+    const file = joinPathFragments(directoryName, i);
+    const content = await readFile(file);
+    const cleaned = content.toString().replace(/\s*\/\/.*\n/gm, "\n").replace(/\s*\/\*[^/]+\*\/\n?/gm, "\n").replace(/\n+/gm, "\n").replace(/^\n+/gm, "");
+    await writeFile(file, cleaned);
+  }));
+}
+__name(cleanComments, "cleanComments");
+function clearPackageJSON(packageJson, inputIgnoreFields) {
+  const ignoreFields = inputIgnoreFields ? IGNORE_FIELDS.concat(inputIgnoreFields) : IGNORE_FIELDS;
+  if (!packageJson.publishConfig) {
+    return packageJson;
+  }
+  const publishConfig = {
+    ...packageJson.publishConfig
+  };
+  PUBLISH_CONFIG_FIELDS.forEach((field) => {
+    if (publishConfig[field]) {
+      packageJson[field] = publishConfig[field];
+      delete publishConfig[field];
+    }
+  });
+  if (!Object.keys(publishConfig).length) {
+    const { publishConfig: _, ...pkg } = packageJson;
+    return pkg;
+  }
+  const cleanPackageJSON = filterObjectByKey({
+    ...packageJson,
+    publishConfig
+  }, (key) => !!(key && !ignoreFields.includes(key) && key !== "scripts"));
+  if (packageJson.scripts && !ignoreFields.includes("scripts")) {
+    cleanPackageJSON.scripts = filterObjectByKey(packageJson.scripts, (script) => !!(script && NPM_SCRIPTS.includes(script)));
+    if (cleanPackageJSON.scripts.publish && /^clean-publish( |$)/.test(cleanPackageJSON.scripts.publish)) {
+      delete cleanPackageJSON.scripts.publish;
+    }
+  }
+  for (const i in cleanPackageJSON) {
+    if (isObject(cleanPackageJSON[i]) && Object.keys(cleanPackageJSON[i]).length === 0) {
+      delete cleanPackageJSON[i];
+    }
+  }
+  return cleanPackageJSON;
+}
+__name(clearPackageJSON, "clearPackageJSON");
+var executor_default = withRunExecutor("Storm Clean-Package executor", cleanPackageExecutorFn, {
+  skipReadingConfig: false,
+  hooks: {
+    applyDefaultOptions: /* @__PURE__ */ __name((options) => {
+      options.outputPath ??= "dist/{projectRoot}";
+      options.packageJsonPath ??= joinPaths(options.outputPath, "package.json");
+      options.cleanReadMe ??= true;
+      options.cleanComments ??= true;
+      return options;
+    }, "applyDefaultOptions")
+  }
+});
+export {
+  cleanPackageExecutorFn,
+  executor_default as default
+};

package/dist/src/executors/clean-package/schema.d.ts

@@ -0,0 +1,60 @@
+
+// Generated by @storm-software/untyped
+// Do not edit this file directly
+
+export interface CleanPackageExecutorSchema {
+ /**
+  * Output Path
+  * 
+  * The path to the output
+  * 
+  * @default "dist/{projectRoot}"
+ */
+ outputPath?: string,
+
+ /**
+  * Package JSON Path
+  * 
+  * The path to the package.json that will be modified
+  * 
+  * @default "{outputPath}/package.json"
+  * 
+  * @format path
+ */
+ packageJsonPath?: string,
+
+ /**
+  * Ignored Files
+  * 
+  * The files to ignore
+  * 
+ */
+ ignoredFiles?: string,
+
+ /**
+  * Fields
+  * 
+  * The fields to include
+  * 
+ */
+ fields?: string,
+
+ /**
+  * Clean Read Me
+  * 
+  * Clean the read me
+  * 
+  * @default true
+ */
+ cleanReadMe?: boolean,
+
+ /**
+  * Clean Comments
+  * 
+  * Clean the comments
+  * 
+  * @default true
+ */
+ cleanComments?: boolean,
+}
+

package/dist/src/executors/clean-package/schema.json

@@ -0,0 +1,57 @@
+{
+  "id": "#",
+  "title": "Clean Package Executor",
+  "description": "The clean package executor is responsible for removing unnecessary files and fields from a distributable package to make it as light as possible (for scenarios like edge computing, limited memory environments, etc.)",
+  "properties": {
+    "outputPath": {
+      "title": "Output Path",
+      "type": "string",
+      "description": "The path to the output",
+      "id": "#outputPath",
+      "default": "dist/{projectRoot}"
+    },
+    "packageJsonPath": {
+      "title": "Package JSON Path",
+      "type": "string",
+      "format": "path",
+      "description": "The path to the package.json that will be modified",
+      "id": "#packageJsonPath",
+      "default": "{outputPath}/package.json"
+    },
+    "ignoredFiles": {
+      "title": "Ignored Files",
+      "type": "string",
+      "description": "The files to ignore",
+      "id": "#ignoredFiles"
+    },
+    "fields": {
+      "title": "Fields",
+      "type": "string",
+      "description": "The fields to include",
+      "id": "#fields",
+      "default": []
+    },
+    "cleanReadMe": {
+      "title": "Clean Read Me",
+      "type": "boolean",
+      "description": "Clean the read me",
+      "id": "#cleanReadMe",
+      "default": true
+    },
+    "cleanComments": {
+      "title": "Clean Comments",
+      "type": "boolean",
+      "description": "Clean the comments",
+      "id": "#cleanComments",
+      "default": true
+    }
+  },
+  "type": "object",
+  "default": {
+    "outputPath": "dist/{projectRoot}",
+    "packageJsonPath": "{outputPath}/package.json",
+    "fields": [],
+    "cleanReadMe": true,
+    "cleanComments": true
+  }
+}

package/dist/src/executors/clean-package/schema.md

@@ -0,0 +1,65 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Clean Package Executor
+
+## `outputPath`
+- **Type**: `string`
+- **Default**: `"dist/{projectRoot}"`
+
+> Output Path
+
+
+The path to the output
+
+
+## `packageJsonPath`
+- **Type**: `string`
+- **Default**: `"{outputPath}/package.json"`
+
+> Package JSON Path
+
+
+The path to the package.json that will be modified
+
+
+## `ignoredFiles`
+- **Type**: `string`
+
+> Ignored Files
+
+
+The files to ignore
+
+
+## `fields`
+- **Type**: `string`
+- **Default**: `[]`
+
+> Fields
+
+
+The fields to include
+
+
+## `cleanReadMe`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Clean Read Me
+
+
+Clean the read me
+
+
+## `cleanComments`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Clean Comments
+
+
+Clean the comments
+
+

package/dist/src/executors/clean-package/untyped.d.mts

@@ -0,0 +1,5 @@
+import * as untyped from 'untyped';
+
+declare const _default: untyped.SchemaDefinition;
+
+export { _default as default };

package/dist/src/executors/clean-package/untyped.d.ts

@@ -0,0 +1,5 @@
+import * as untyped from 'untyped';
+
+declare const _default: untyped.SchemaDefinition;
+
+export { _default as default };

package/dist/src/executors/clean-package/untyped.js

@@ -0,0 +1,68 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkI734UVDTjs = require('../../../chunk-I734UVDT.js');
+
+
+var _chunk3GQAWCBQjs = require('../../../chunk-3GQAWCBQ.js');
+
+// src/executors/clean-package/untyped.ts
+var _untyped = require('untyped');
+var untyped_default = _untyped.defineUntypedSchema.call(void 0, {
+  ..._chunkI734UVDTjs.base_executor_untyped_default,
+  $schema: {
+    id: "CleanPackageExecutorSchema",
+    title: "Clean Package Executor",
+    description: "The clean package executor is responsible for removing unnecessary files and fields from a distributable package to make it as light as possible (for scenarios like edge computing, limited memory environments, etc.)"
+  },
+  outputPath: {
+    $schema: {
+      title: "Output Path",
+      type: "string",
+      description: "The path to the output"
+    },
+    $default: "dist/{projectRoot}"
+  },
+  packageJsonPath: {
+    $schema: {
+      title: "Package JSON Path",
+      type: "string",
+      format: "path",
+      description: "The path to the package.json that will be modified"
+    },
+    $default: "{outputPath}/package.json"
+  },
+  ignoredFiles: {
+    $schema: {
+      title: "Ignored Files",
+      type: "string",
+      description: "The files to ignore"
+    }
+  },
+  fields: {
+    $schema: {
+      title: "Fields",
+      type: "string",
+      description: "The fields to include"
+    },
+    $resolve: /* @__PURE__ */ _chunk3GQAWCBQjs.__name.call(void 0, (val = []) => [].concat(val), "$resolve")
+  },
+  cleanReadMe: {
+    $schema: {
+      title: "Clean Read Me",
+      type: "boolean",
+      description: "Clean the read me"
+    },
+    $default: true
+  },
+  cleanComments: {
+    $schema: {
+      title: "Clean Comments",
+      type: "boolean",
+      description: "Clean the comments"
+    },
+    $default: true
+  }
+});
+
+
+exports.default = untyped_default;

package/dist/src/executors/clean-package/untyped.mjs

@@ -0,0 +1,68 @@
+import {
+  base_executor_untyped_default
+} from "../../../chunk-DGC5L3Z7.mjs";
+import {
+  __name
+} from "../../../chunk-XUV4U54K.mjs";
+
+// src/executors/clean-package/untyped.ts
+import { defineUntypedSchema } from "untyped";
+var untyped_default = defineUntypedSchema({
+  ...base_executor_untyped_default,
+  $schema: {
+    id: "CleanPackageExecutorSchema",
+    title: "Clean Package Executor",
+    description: "The clean package executor is responsible for removing unnecessary files and fields from a distributable package to make it as light as possible (for scenarios like edge computing, limited memory environments, etc.)"
+  },
+  outputPath: {
+    $schema: {
+      title: "Output Path",
+      type: "string",
+      description: "The path to the output"
+    },
+    $default: "dist/{projectRoot}"
+  },
+  packageJsonPath: {
+    $schema: {
+      title: "Package JSON Path",
+      type: "string",
+      format: "path",
+      description: "The path to the package.json that will be modified"
+    },
+    $default: "{outputPath}/package.json"
+  },
+  ignoredFiles: {
+    $schema: {
+      title: "Ignored Files",
+      type: "string",
+      description: "The files to ignore"
+    }
+  },
+  fields: {
+    $schema: {
+      title: "Fields",
+      type: "string",
+      description: "The fields to include"
+    },
+    $resolve: /* @__PURE__ */ __name((val = []) => [].concat(val), "$resolve")
+  },
+  cleanReadMe: {
+    $schema: {
+      title: "Clean Read Me",
+      type: "boolean",
+      description: "Clean the read me"
+    },
+    $default: true
+  },
+  cleanComments: {
+    $schema: {
+      title: "Clean Comments",
+      type: "boolean",
+      description: "Clean the comments"
+    },
+    $default: true
+  }
+});
+export {
+  untyped_default as default
+};

package/dist/src/executors/esbuild/executor.d.mts

@@ -0,0 +1,4 @@
+import '@nx/devkit';
+import '../../../types-D9vU63tt.mjs';
+export { _ as default, e as esbuildExecutorFn } from '../../../executor-B8unq_QL.mjs';
+import 'zod';

package/dist/src/executors/esbuild/executor.d.ts

@@ -0,0 +1,4 @@
+import '@nx/devkit';
+import '../../../types-D9vU63tt.js';
+export { _ as default, e as esbuildExecutorFn } from '../../../executor-sYaxQf5n.js';
+import 'zod';

package/dist/src/executors/esbuild/executor.js

@@ -0,0 +1,16 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkDIODSFGHjs = require('../../../chunk-DIODSFGH.js');
+require('../../../chunk-CT7IVPJY.js');
+require('../../../chunk-MSENNRAY.js');
+require('../../../chunk-BWFTYFWM.js');
+require('../../../chunk-5CPYNJT2.js');
+require('../../../chunk-36FMHXUD.js');
+require('../../../chunk-5MKQX2FE.js');
+require('../../../chunk-XCSSYTCU.js');
+require('../../../chunk-3GQAWCBQ.js');
+
+
+
+exports.default = _chunkDIODSFGHjs.executor_default; exports.esbuildExecutorFn = _chunkDIODSFGHjs.esbuildExecutorFn;

package/dist/src/executors/esbuild/executor.mjs

@@ -0,0 +1,16 @@
+import {
+  esbuildExecutorFn,
+  executor_default
+} from "../../../chunk-DLO5NZQI.mjs";
+import "../../../chunk-UDAQKEJS.mjs";
+import "../../../chunk-6267MSX4.mjs";
+import "../../../chunk-FFBZYD6R.mjs";
+import "../../../chunk-NDDXQD7R.mjs";
+import "../../../chunk-WJ5TU6JU.mjs";
+import "../../../chunk-DMUTOQCB.mjs";
+import "../../../chunk-PVTEDLBL.mjs";
+import "../../../chunk-XUV4U54K.mjs";
+export {
+  executor_default as default,
+  esbuildExecutorFn
+};