@storm-software/workspace-tools 1.270.2 → 1.271.0

package/src/generators/browser-library/generator.ts

@@ -1,109 +0,0 @@
-import {
-  type Tree,
-  formatFiles,
-  generateFiles,
-  names,
-  offsetFromRoot
-} from "@nx/devkit";
-import { StormWorkspaceConfig } from "@storm-software/config";
-import { joinPaths } from "@storm-software/config-tools/utilities/correct-paths";
-import { withRunGenerator } from "../../base/base-generator";
-import {
-  normalizeOptions,
-  typeScriptLibraryGeneratorFn,
-  TypeScriptLibraryGeneratorOptions
-} from "../../base/typescript-library-generator";
-import type { BrowserLibraryGeneratorSchema } from "./schema.d";
-
-export async function browserLibraryGeneratorFn(
-  tree: Tree,
-  schema: BrowserLibraryGeneratorSchema,
-  config?: StormWorkspaceConfig
-) {
-  const filesDir = joinPaths(
-    __dirname,
-    "src",
-    "generators",
-    "browser-library",
-    "files"
-  );
-  const tsLibraryGeneratorOptions: TypeScriptLibraryGeneratorOptions = {
-    buildExecutor: "@storm-software/workspace-tools:unbuild",
-    platform: "browser",
-    devDependencies: {
-      "@types/react": "^18.3.6",
-      "@types/react-dom": "^18.3.0"
-    },
-    peerDependencies: {
-      react: "^18.3.0",
-      "react-dom": "^18.3.0",
-      "react-native": "*"
-    },
-    peerDependenciesMeta: {
-      "react-dom": {
-        optional: true
-      },
-      "react-native": {
-        optional: true
-      }
-    },
-    ...schema,
-    description: schema.description!,
-    directory: schema.directory
-  };
-
-  const options = await normalizeOptions(tree, tsLibraryGeneratorOptions);
-  const { className, name, propertyName } = names(
-    options.projectNames.projectFileName
-  );
-
-  generateFiles(tree, filesDir, options.projectRoot, {
-    ...schema,
-    dot: ".",
-    className,
-    name,
-    namespace: process.env.STORM_NAMESPACE ?? "storm-software",
-    description: schema.description ?? "",
-    propertyName,
-    js: !!options.js,
-    cliCommand: "nx",
-    strict: undefined,
-    tmpl: "",
-    offsetFromRoot: offsetFromRoot(options.projectRoot),
-    buildable: options.bundler && options.bundler !== "none",
-    hasUnitTestRunner: options.unitTestRunner !== "none",
-    tsConfigOptions: {
-      compilerOptions: {
-        jsx: "react",
-        types: [
-          "node",
-          "@nx/react/typings/cssmodule.d.ts",
-          "@nx/react/typings/image.d.ts"
-        ]
-      }
-    }
-  });
-
-  await typeScriptLibraryGeneratorFn(tree, tsLibraryGeneratorOptions, config);
-  await formatFiles(tree);
-
-  return null;
-}
-
-export default withRunGenerator<BrowserLibraryGeneratorSchema>(
-  "TypeScript Library Creator (Browser Platform)",
-  browserLibraryGeneratorFn,
-  {
-    hooks: {
-      applyDefaultOptions: (
-        options: BrowserLibraryGeneratorSchema
-      ): BrowserLibraryGeneratorSchema => {
-        options.description ??=
-          "A library used by Storm Software to support browser applications";
-        options.platform ??= "browser";
-
-        return options;
-      }
-    }
-  }
-);

package/src/generators/browser-library/untyped.ts

@@ -1,29 +0,0 @@
-import { defineUntypedSchema } from "untyped";
-import typescriptLibraryGeneratorSchema from "../../base/typescript-library-generator.untyped";
-
-export default defineUntypedSchema({
-  ...typescriptLibraryGeneratorSchema,
-  $schema: {
-    id: "BrowserLibraryGeneratorSchema",
-    title: "Browser Library Generator",
-    description: "A type definition for a browser library generator schema",
-    required: ["directory", "name"],
-  },
-  buildExecutor: {
-    $schema: {
-      title: "Build Executor",
-      type: "string",
-      description: "The executor to use for building the library",
-    },
-    $default: "@storm-software/workspace-tools:unbuild",
-  },
-  platform: {
-    $schema: {
-      title: "Platform",
-      type: "string",
-      description: "The platform to target with the library",
-      enum: ["browser", "neutral"],
-    },
-    $default: "browser",
-  },
-});

package/src/generators/config-schema/generator.spec.ts

@@ -1,20 +0,0 @@
-import { Tree, readProjectConfiguration } from "@nx/devkit";
-import { createTreeWithEmptyWorkspace } from "@nx/devkit/testing";
-
-import { configSchemaGenerator } from "./generator";
-import { ConfigSchemaGeneratorSchema } from "./schema.d";
-
-describe("config-schema generator", () => {
-  let tree: Tree;
-  const options: ConfigSchemaGeneratorSchema = { name: "test" };
-
-  beforeEach(() => {
-    tree = createTreeWithEmptyWorkspace();
-  });
-
-  it("should run successfully", async () => {
-    await configSchemaGenerator(tree, options);
-    const config = readProjectConfiguration(tree, "test");
-    expect(config).toBeDefined();
-  });
-});

package/src/generators/config-schema/generator.ts

@@ -1,90 +0,0 @@
-import { formatFiles, type Tree, writeJson } from "@nx/devkit";
-import {
-  type StormWorkspaceConfig,
-  stormWorkspaceConfigSchema
-} from "@storm-software/config";
-import {
-  findWorkspaceRoot,
-  writeInfo,
-  writeSuccess,
-  writeTrace
-} from "@storm-software/config-tools";
-import * as z from "zod";
-import { JsonSchema7Type, zodToJsonSchema } from "zod-to-json-schema";
-import { withRunGenerator } from "../../base/base-generator";
-import type { ConfigSchemaGeneratorSchema } from "./schema.d";
-
-export type ModuleSchema = {
-  name: string;
-  schema: z.ZodObject<any>;
-};
-
-export async function configSchemaGeneratorFn(
-  tree: Tree,
-  options: ConfigSchemaGeneratorSchema,
-  config?: StormWorkspaceConfig
-) {
-  writeInfo(
-    "📦  Running Storm Workspace Configuration JSON Schema generator",
-    config
-  );
-
-  writeTrace(
-    `Determining the Storm Workspace Configuration JSON Schema...`,
-    config
-  );
-
-  const jsonSchema = zodToJsonSchema(stormWorkspaceConfigSchema, {
-    name: "StormWorkspaceConfiguration"
-  });
-  writeTrace(jsonSchema, config);
-
-  const outputPath = options
-    .outputFile!.replaceAll("{workspaceRoot}", "")
-    .replaceAll(
-      config?.workspaceRoot ?? findWorkspaceRoot(),
-      options.outputFile?.startsWith("./") ? "" : "./"
-    );
-
-  writeTrace(
-    `📝  Writing Storm Configuration JSON Schema to "${outputPath}"`,
-    config
-  );
-
-  writeJson<
-    JsonSchema7Type & {
-      $schema?: string | undefined;
-      definitions?:
-        | {
-            [key: string]: JsonSchema7Type;
-          }
-        | undefined;
-    }
-  >(tree, outputPath, jsonSchema, { spaces: 2 });
-  await formatFiles(tree);
-
-  writeSuccess(
-    "🚀  Storm Configuration JSON Schema creation has completed successfully!",
-    config
-  );
-
-  return {
-    success: true
-  };
-}
-
-export default withRunGenerator<ConfigSchemaGeneratorSchema>(
-  "Configuration Schema Creator",
-  configSchemaGeneratorFn,
-  {
-    hooks: {
-      applyDefaultOptions: (
-        options: ConfigSchemaGeneratorSchema
-      ): ConfigSchemaGeneratorSchema => {
-        options.outputFile ??= "{workspaceRoot}/storm-workspace.schema.json";
-
-        return options;
-      }
-    }
-  }
-);

package/src/generators/config-schema/untyped.ts

@@ -1,19 +0,0 @@
-import { defineUntypedSchema } from "untyped";
-import baseGeneratorSchema from "../../base/base-generator.untyped";
-
-export default defineUntypedSchema({
-  ...baseGeneratorSchema,
-  $schema: {
-    id: "ConfigSchemaGeneratorSchema",
-    title: "Config Schema Generator",
-    description: "A type definition for a config schema generator schema",
-  },
-  outputFile: {
-    $schema: {
-      title: "Output File",
-      type: "string",
-      description: "The file to write the schema to",
-    },
-    $default: "{workspaceRoot}/storm-workspace.schema.json",
-  },
-});

package/src/generators/init/init.ts

@@ -1,32 +0,0 @@
-import {
-  addDependenciesToPackageJson,
-  formatFiles,
-  type Tree,
-} from "@nx/devkit";
-import type { InitGeneratorSchema } from "./schema.d";
-
-export async function initGenerator(tree: Tree, schema: InitGeneratorSchema) {
-  const task = addDependenciesToPackageJson(
-    tree,
-    {
-      nx: "^19.6.2",
-      "@nx/workspace": "^19.6.2",
-      "@nx/js": "^19.6.2",
-      "@storm-software/eslint": "latest",
-      "@storm-software/prettier": "latest",
-      "@storm-software/config-tools": "latest",
-      "@storm-software/testing-tools": "latest",
-      "@storm-software/git-tools": "latest",
-      "@storm-software/linting-tools": "latest",
-    },
-    {},
-  );
-
-  if (!schema.skipFormat) {
-    await formatFiles(tree);
-  }
-
-  return task;
-}
-
-export default initGenerator;

package/src/generators/init/untyped.ts

@@ -1,16 +0,0 @@
-import { defineUntypedSchema } from "untyped";
-
-export default defineUntypedSchema({
-  $schema: {
-    id: "InitGeneratorSchema",
-    title: "Init Generator",
-    description: "A type definition for an init generator schema",
-  },
-  skipFormat: {
-    $schema: {
-      title: "Skip Format",
-      type: "boolean",
-      description: "Skip formatting the generated files",
-    },
-  },
-});

package/src/generators/neutral-library/generator.spec.ts

@@ -1,20 +0,0 @@
-import { Tree, readProjectConfiguration } from "@nx/devkit";
-import { createTreeWithEmptyWorkspace } from "@nx/devkit/testing";
-
-import { neutralLibraryGenerator } from "./generator";
-import { NeutralLibraryGeneratorSchema } from "./schema.d";
-
-describe("neutral-library generator", () => {
-  let tree: Tree;
-  const options: NeutralLibraryGeneratorSchema = { name: "test" };
-
-  beforeEach(() => {
-    tree = createTreeWithEmptyWorkspace();
-  });
-
-  it("should run successfully", async () => {
-    await neutralLibraryGenerator(tree, options);
-    const config = readProjectConfiguration(tree, "test");
-    expect(config).toBeDefined();
-  });
-});

package/src/generators/neutral-library/generator.ts

@@ -1,81 +0,0 @@
-import {
-  formatFiles,
-  generateFiles,
-  names,
-  offsetFromRoot,
-  Tree
-} from "@nx/devkit";
-import { StormWorkspaceConfig } from "@storm-software/config";
-import { joinPaths } from "@storm-software/config-tools/utilities/correct-paths";
-import { withRunGenerator } from "../../base/base-generator";
-import {
-  normalizeOptions,
-  typeScriptLibraryGeneratorFn,
-  TypeScriptLibraryGeneratorOptions
-} from "../../base/typescript-library-generator";
-import { NeutralLibraryGeneratorSchema } from "./schema.d";
-
-export async function neutralLibraryGeneratorFn(
-  tree: Tree,
-  schema: NeutralLibraryGeneratorSchema,
-  config?: StormWorkspaceConfig
-) {
-  const filesDir = joinPaths(
-    __dirname,
-    "src",
-    "generators",
-    "neutral-library",
-    "files"
-  );
-  const tsLibraryGeneratorOptions = {
-    ...schema,
-    platform: "neutral",
-    devDependencies: {},
-    buildExecutor: "@storm-software/workspace-tools:unbuild"
-  } as TypeScriptLibraryGeneratorOptions;
-
-  const options = await normalizeOptions(tree, tsLibraryGeneratorOptions);
-  const { className, name, propertyName } = names(
-    options.projectNames.projectFileName
-  );
-
-  generateFiles(tree, filesDir, options.projectRoot, {
-    ...schema,
-    dot: ".",
-    className,
-    name,
-    namespace: process.env.STORM_NAMESPACE ?? "storm-software",
-    description: schema.description ?? "",
-    propertyName,
-    js: !!options.js,
-    cliCommand: "nx",
-    strict: undefined,
-    tmpl: "",
-    offsetFromRoot: offsetFromRoot(options.projectRoot),
-    buildable: options.bundler && options.bundler !== "none",
-    hasUnitTestRunner: options.unitTestRunner !== "none"
-  });
-
-  await typeScriptLibraryGeneratorFn(tree, tsLibraryGeneratorOptions, config);
-  await formatFiles(tree);
-
-  return null;
-}
-
-export default withRunGenerator<NeutralLibraryGeneratorSchema>(
-  "TypeScript Library Creator (Neutral Platform)",
-  neutralLibraryGeneratorFn,
-  {
-    hooks: {
-      applyDefaultOptions: (
-        options: NeutralLibraryGeneratorSchema
-      ): NeutralLibraryGeneratorSchema => {
-        options.description ??=
-          "A library used by Storm Software to support either browser or NodeJs applications";
-        options.platform = "neutral";
-
-        return options;
-      }
-    }
-  }
-);

package/src/generators/neutral-library/untyped.ts

@@ -1,29 +0,0 @@
-import { defineUntypedSchema } from "untyped";
-import typescriptLibraryGeneratorSchema from "../../base/typescript-library-generator.untyped";
-
-export default defineUntypedSchema({
-  ...typescriptLibraryGeneratorSchema,
-  $schema: {
-    id: "NeutralLibrarySchema",
-    title: "Neutral Library Generator",
-    description: "A type definition for a neutral library generator schema",
-    required: ["directory", "name"],
-  },
-  buildExecutor: {
-    $schema: {
-      title: "Build Executor",
-      type: "string",
-      description: "The executor to use for building the library",
-    },
-    $default: "@storm-software/workspace-tools:unbuild",
-  },
-  platform: {
-    $schema: {
-      title: "Platform",
-      type: "string",
-      description: "The platform to target with the library",
-      enum: ["neutral"],
-    },
-    $default: "neutral",
-  },
-});

package/src/generators/node-library/generator.spec.ts

@@ -1,20 +0,0 @@
-import { Tree, readProjectConfiguration } from "@nx/devkit";
-import { createTreeWithEmptyWorkspace } from "@nx/devkit/testing";
-
-import { nodeLibraryGenerator } from "./generator";
-import { NodeLibraryGeneratorSchema } from "./schema.d";
-
-describe("node-library generator", () => {
-  let tree: Tree;
-  const options: NodeLibraryGeneratorSchema = { name: "test" };
-
-  beforeEach(() => {
-    tree = createTreeWithEmptyWorkspace();
-  });
-
-  it("should run successfully", async () => {
-    await nodeLibraryGenerator(tree, options);
-    const config = readProjectConfiguration(tree, "test");
-    expect(config).toBeDefined();
-  });
-});

package/src/generators/node-library/generator.ts

@@ -1,84 +0,0 @@
-import {
-  formatFiles,
-  generateFiles,
-  names,
-  offsetFromRoot,
-  type Tree
-} from "@nx/devkit";
-import { StormWorkspaceConfig } from "@storm-software/config";
-import { joinPaths } from "@storm-software/config-tools/utilities/correct-paths";
-import { withRunGenerator } from "../../base/base-generator";
-import {
-  normalizeOptions,
-  typeScriptLibraryGeneratorFn,
-  TypeScriptLibraryGeneratorOptions
-} from "../../base/typescript-library-generator";
-import { typesNodeVersion } from "../../utils/versions";
-import type { NodeLibraryGeneratorSchema } from "./schema.d";
-
-export async function nodeLibraryGeneratorFn(
-  tree: Tree,
-  schema: NodeLibraryGeneratorSchema,
-  config?: StormWorkspaceConfig
-) {
-  const filesDir = joinPaths(
-    __dirname,
-    "src",
-    "generators",
-    "node-library",
-    "files"
-  );
-  const tsLibraryGeneratorOptions: TypeScriptLibraryGeneratorOptions = {
-    platform: "node",
-    devDependencies: {
-      "@types/node": typesNodeVersion
-    },
-    buildExecutor: "@storm-software/workspace-tools:unbuild",
-    ...schema,
-    directory: schema.directory,
-    description: schema.description!
-  };
-
-  const options = await normalizeOptions(tree, tsLibraryGeneratorOptions);
-  const { className, name, propertyName } = names(options.name);
-
-  generateFiles(tree, filesDir, options.projectRoot, {
-    ...schema,
-    dot: ".",
-    className,
-    name,
-    namespace: process.env.STORM_NAMESPACE ?? "storm-software",
-    description: schema.description ?? "",
-    propertyName,
-    js: !!options.js,
-    cliCommand: "nx",
-    strict: undefined,
-    tmpl: "",
-    offsetFromRoot: offsetFromRoot(options.projectRoot),
-    buildable: options.bundler && options.bundler !== "none",
-    hasUnitTestRunner: options.unitTestRunner !== "none"
-  });
-
-  await typeScriptLibraryGeneratorFn(tree, tsLibraryGeneratorOptions, config);
-  await formatFiles(tree);
-
-  return null;
-}
-
-export default withRunGenerator<NodeLibraryGeneratorSchema>(
-  "TypeScript Library Creator (NodeJs Platform)",
-  nodeLibraryGeneratorFn,
-  {
-    hooks: {
-      applyDefaultOptions: (
-        options: NodeLibraryGeneratorSchema
-      ): NodeLibraryGeneratorSchema => {
-        options.description ??=
-          "A library used by Storm Software to support NodeJs applications";
-        options.platform ??= "node";
-
-        return options;
-      }
-    }
-  }
-);

package/src/generators/node-library/untyped.ts

@@ -1,29 +0,0 @@
-import { defineUntypedSchema } from "untyped";
-import typescriptLibraryGeneratorSchema from "../../base/typescript-library-generator.untyped";
-
-export default defineUntypedSchema({
-  ...typescriptLibraryGeneratorSchema,
-  $schema: {
-    id: "NodeLibrarySchema",
-    title: "Node Library Generator",
-    description: "A type definition for a NodeJs library generator schema",
-    required: ["directory", "name"],
-  },
-  buildExecutor: {
-    $schema: {
-      title: "Build Executor",
-      type: "string",
-      description: "The executor to use for building the library",
-    },
-    $default: "@storm-software/workspace-tools:unbuild",
-  },
-  platform: {
-    $schema: {
-      title: "Platform",
-      type: "string",
-      description: "The platform to target with the library",
-      enum: ["node", "neutral"],
-    },
-    $default: "node",
-  },
-});

package/src/generators/preset/files/.all-contributorsrc.template

@@ -1,48 +0,0 @@
-{
-  "projectName": "<%= name %>",
-  "projectOwner": "storm-software",
-  "repoType": "github",
-  "repoHost": "https://github.com",
-  "files": [
-    "README.md"
-  ],
-  "imageSize": 100,
-  "contributorsPerLine": 5,
-  "linkToUsage": true,
-  "commitType": "docs",
-  "commit": true,
-  "commitConvention": "angular",
-  "contributors": [
-    {
-      "login": "sullivanpj",
-      "name": "Patrick Sullivan",
-      "avatar_url": "https://avatars.githubusercontent.com/u/99053093?v=4",
-      "profile": "http://www.sullypat.com/",
-      "contributions": [
-        "design",
-        "code",
-        "tool",
-        "doc",
-        "test"
-      ]
-    },
-    {
-      "login": "tbenning",
-      "name": "Tyler Benning",
-      "avatar_url": "https://avatars.githubusercontent.com/u/7265547?v=4",
-      "profile": "https://tylerbenning.com/",
-      "contributions": [
-        "design"
-      ]
-    },
-    {
-      "login": "stormie-bot",
-      "name": "Stormie",
-      "avatar_url": "https://avatars.githubusercontent.com/u/149802440?v=4",
-      "profile": "http://stormsoftware.com",
-      "contributions": [
-        "maintenance"
-      ]
-    }
-  ]
-}