@storm-software/workspace-tools 1.0.1 → 1.2.0

package/src/executors/tsup/schema.json

@@ -0,0 +1,127 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "version": 2,
+  "title": "Build executor",
+  "description": "",
+  "type": "object",
+  "properties": {
+    "properties": {
+      "main": {
+        "type": "string",
+        "description": "The path to the entry file, relative to project.",
+        "alias": "entryFile",
+        "x-completion-type": "file",
+        "x-completion-glob": "**/*@(.js|.ts)",
+        "x-priority": "important",
+        "default": "{sourceRoot}/**/*@(.js|.jsx|.ts|.tsx)"
+      },
+      "outputPath": {
+        "type": "string",
+        "description": "The output path of the generated files.",
+        "x-completion-type": "directory",
+        "x-priority": "important",
+        "default": "dist/{projectRoot}"
+      },
+      "tsConfig": {
+        "type": "string",
+        "description": "The path to tsconfig file.",
+        "x-completion-type": "file",
+        "x-completion-glob": "tsconfig.*.json",
+        "x-priority": "important",
+        "default": "tsconfig.lib.json"
+      },
+      "additionalEntryPoints": {
+        "type": "array",
+        "description": "List of additional entry points.",
+        "items": {
+          "type": "string"
+        },
+        "default": []
+      },
+      "external": {
+        "type": "array",
+        "description": "Mark one or more module as external. Can use * wildcards, such as '*.png'.",
+        "items": {
+          "type": "string"
+        }
+      },
+      "bundle": {
+        "type": "boolean",
+        "description": "Whether to bundle the main entry point and additional entry points. Set to false to keep individual output files.",
+        "default": true
+      },
+      "watch": {
+        "type": "boolean",
+        "description": "Enable re-building when files change.",
+        "default": false
+      },
+      "assets": {
+        "type": "array",
+        "description": "List of static assets.",
+        "default": [],
+        "items": {
+          "$ref": "#/definitions/assetPattern"
+        }
+      },
+      "clean": {
+        "type": "boolean",
+        "description": "Remove previous output before build.",
+        "alias": "deleteOutputPath",
+        "default": true
+      },
+      "minify": {
+        "type": "boolean",
+        "description": "Minifies outputs.",
+        "default": true
+      },
+      "platform": {
+        "type": "string",
+        "description": "Platform target for outputs.",
+        "enum": ["browser", "node", "neutral"],
+        "default": "node"
+      },
+      "options": {
+        "type": "object",
+        "description": "Additional options to pass to tsup. See https://paka.dev/npm/tsup@7.2.0/api#d35d54aca71eb26e.",
+        "additionalProperties": true,
+        "x-priority": "important"
+      }
+    },
+    "required": ["tsConfig", "main"],
+    "definitions": {
+      "assetPattern": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "glob": {
+                "type": "string",
+                "description": "The pattern to match."
+              },
+              "input": {
+                "type": "string",
+                "description": "The input directory path in which to apply `glob`. Defaults to the project root."
+              },
+              "output": {
+                "type": "string",
+                "description": "Relative path within the output folder."
+              },
+              "ignore": {
+                "description": "An array of globs to ignore.",
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "additionalProperties": false,
+            "required": ["glob", "input", "output"]
+          },
+          {
+            "type": "string"
+          }
+        ]
+      }
+    }
+  }
+}

package/src/generators/init/init.d.ts

@@ -0,0 +1,4 @@
+import { Tree } from "@nx/devkit";
+import { Schema } from "./schema";
+export declare function stormInitGenerator(tree: Tree, schema: Schema): Promise<import("@nx/devkit").GeneratorCallback>;
+export default stormInitGenerator;

package/src/generators/init/init.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stormInitGenerator = void 0;
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nx/devkit");
+const versions_1 = require("../../utils/versions");
+function stormInitGenerator(tree, schema) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const task = (0, devkit_1.addDependenciesToPackageJson)(tree, {
+            "nx": versions_1.nxVersion,
+            "@nx/workspace": versions_1.nxVersion
+        }, {});
+        if (!schema.skipFormat) {
+            yield (0, devkit_1.formatFiles)(tree);
+        }
+        return task;
+    });
+}
+exports.stormInitGenerator = stormInitGenerator;
+exports.default = stormInitGenerator;
+//# sourceMappingURL=init.js.map

package/src/generators/init/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../../../../packages/workspace-tools/src/generators/init/init.ts"],"names":[],"mappings":";;;;AAAA,uCAA6E;AAC7E,mDAAiD;AAGjD,SAAsB,kBAAkB,CAAC,IAAU,EAAE,MAAc;;QACjE,MAAM,IAAI,GAAG,IAAA,qCAA4B,EACvC,IAAI,EACJ;YACE,IAAI,EAAE,oBAAS;YACf,eAAe,EAAE,oBAAS;SAC3B,EACD,EAAE,CACH,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;YACtB,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;SACzB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CAAA;AAfD,gDAeC;AAED,kBAAe,kBAAkB,CAAC"}

package/src/generators/init/schema.d.ts

@@ -0,0 +1,3 @@
+export interface Schema {
+  skipFormat?: boolean;
+}

package/src/generators/init/schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "StormWorkspaceInit",
+  "cli": "nx",
+  "title": "Init Storm Workspace Plugin",
+  "description": "Init Storm Workspace Plugin.",
+  "type": "object",
+  "properties": {
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "required": []
+}

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

@@ -1,6 +1,6 @@
 {
   "projectName": "<%= name %>",
-  "projectOwner": "sullivanpj",
+  "projectOwner": "storm-software",
   "repoType": "github",
   "repoHost": "https://github.com",
   "files": [
@@ -14,9 +14,13 @@
       "login": "sullivanpj",
       "name": "Patrick Sullivan",
       "avatar_url": "https://avatars.githubusercontent.com/u/99053093?v=4",
-      "profile": "http://www.patsullivan.dev/",
+      "profile": "http://www.sullypat.com/",
       "contributions": [
-        "tool"
+        "design",
+        "code",
+        "tool",
+        "doc",
+        "test"
       ]
     },
     {
@@ -27,8 +31,18 @@
       "contributions": [
         "design"
       ]
+    },
+    {
+      "login": "stormie-bot",
+      "name": "Stormie",
+      "avatar_url": "https://avatars.githubusercontent.com/u/149802440?v=4",
+      "profile": "http://stormsoftware.org",
+      "contributions": [
+        "maintenance"
+      ]
     }
   ],
   "contributorsPerLine": 7,
-  "linkToUsage": true
+  "linkToUsage": true,
+  "commitType": "docs"
 }

package/src/generators/preset/files/.env.template

@@ -1,58 +1,38 @@
-CI=true
-TYPESENSE_API_KEY=xyz
+TYPESENSE_API_KEY="xyz"
 NODE_OPTIONS="--trace-warnings --heapsnapshot-near-heap-limit=3 --heapsnapshot-signal=SIGTERM"
 
-ROOT_HOST=192.168.1.18
-HOST_SERVER=host.docker.internal
 AKKA_STREAMS_KAFKA_TEST_FILE_LOGGING=true
-RUST_BACKTRACE=full
+RUST_BACKTRACE="full"
 # PUPPETEER_SKIP_DOWNLOAD=true
 
-HS_SERVICE_NAME="@<%= name %>/monorepo"
-# HS_DEBUG=true
+HS_SERVICE_NAME="@<%= organization %>/<%= name %>"
 
-SENTRY_ORGANIZATION="storm-software"
+SENTRY_ORGANIZATION="stormstack"
 SENTRY_PROPERTIES="apps/web/shell"
 
 DEFAULT_LOCALE="en_US"
 DEFAULT_TIMEZONE="America/New_York"
 
-CI_REPO_OWNER="sullivanpj"
-CI_REPO_WORKER="🤖 Storm Bot"
-CI_REPO_NAME="<%= name %>"
-CI_REPO_URL="https://github.com/storm-software/<%= name %>"
-CI_BRANCH="main"
-CI_PRE_MAJOR=true
-
-# OAUTH_GOOGLE_CLIENT_ID=
-# OAUTH_GOOGLE_CLIENT_SECRET=
-# OAUTH_GOOGLE_AUTHORIZATION_ENDPOINT=
-# OAUTH_GOOGLE_TOKEN_ENDPOINT=
-
-VIRUS_TOTAL_API_URL="https://www.virustotal.com"
-# VIRUS_TOTAL_API_KEY=
-
-UPSTASH_KAFKA_REST_URL="https://fitting-dassie-7031-us1-rest-kafka.upstash.io"
-# UPSTASH_KAFKA_REST_USERNAME=
-# UPSTASH_KAFKA_REST_PASSWORD=
-
-PRISMA_GENERATE_DATAPROXY=true
-FORECAST_RUNTIME_MODULE="node_modules/.storm"
-
-NO_D1_WARNING=true
+STORM_REPO_ROOT=
+STORM_REPO_OWNER="sullivanpj"
+STORM_REPO_WORKER="stormie-bot"
+STORM_REPO_ORG="<%= organization %>"
+STORM_REPO_NAME="<%= name %>"
+STORM_REPO_URL="https://github.com/<%= organization %>/<%= name %>"
+STORM_BRANCH="main"
+STORM_PRE_MAJOR=false
 
 INFISICAL_ENVIRONMENT="prod"
 
 READINESS_CHECK_PATH="/readiness"
 HEALTH_CHECK_PATH="/healthcheck"
 
-LOG_LEVEL="debug"
+LOG_LEVEL="info"
 # LOG_PATH="C:\\Development\\stormstack\\logs"
 
-PNPM_VERSION="8.7.4"
+PNPM_VERSION="8.10.2"
 
 DEV_EDITOR_ID="vscode"
-DEV_REPO_ROOT="C:\\Development\\<%= name %>"
 
 THEME_PRIMARY_COLOR="#1fb2a6"
 THEME_BACKGROUND_COLOR="#1d232a"
@@ -61,4 +41,3 @@ THEME_INFO_COLOR="#0ea5e9"
 THEME_WARNING_COLOR="#fcc419"
 THEME_ERROR_COLOR="#7d1a1a"
 
-# NODE_ENV=production

package/src/generators/preset/files/.gitattributes

@@ -41,3 +41,12 @@
 
 # Other
 *.exe filter=lfs diff=lfs merge=lfs -text
+
+###############################
+# GitHub linguist             #
+###############################
+
+apps/**/.next/** -text linguist-vendored
+
+# Make dist folder indexable for github search
+dist/** linguist-generated=false

package/src/generators/preset/files/.github/CONTRIBUTING.md.template

@@ -4,7 +4,7 @@
 
 If you want to make a small change, go ahead and raise a pull request, otherwise follow these steps:
 
-1. View the [Issues](https://github.com/storm-software/<%= name %>/issues) page to see a To-Do list of things to be implemented.
+1. View the [Issues](https://github.com/<%= organization %>/<%= name %>/issues) page to see a To-Do list of things to be implemented.
 2. Raise an issue or comment on an existing issue with what you want to contribute if one does not already exist.
 3. When you get the go ahead, follow the coding guidelines and raise a pull request.
 4. Include a link to the issue in your pull request.

package/src/generators/preset/files/.github/ISSUE_TEMPLATE/bug-report.yml.template

@@ -16,7 +16,7 @@ body:
       description: How can we get in touch with you if we need more info?
       placeholder: ex. email@example.com
     validations:
-      required: false
+      required: true
   - type: textarea
     id: actual-results
     attributes:
@@ -35,20 +35,51 @@ body:
       value: "What behavior are you expecting to experience?"
     validations:
       required: true
+  - type: dropdown
+    id: package
+    attributes:
+      label: Package Name
+      description: Which package are you experiencing this error with?
+      multiple: true
+      options:
+        - create-storm-workspace
+        - Linting Tools
+        - Git Tools
+        - Workspace Tools
+    validations:
+      required: true
   - type: dropdown
     id: version
     attributes:
       label: Version
       description: What version of our software are you running?
       options:
-        - 1.0.2 (Default)
-        - 1.0.3 (Edge)
+        - 1.0.0
     validations:
-      required: true
+      required: false
+  - type: dropdown
+    id: operating-system
+    attributes:
+      label: What platform(s) are you seeing the problem in?
+      multiple: true
+      options:
+        - Microsoft Windows
+        - MacOS
+        - ChromeOS
+        - iOS
+        - Android
+        - Ubuntu
+        - Debian
+        - Fedora
+        - CentOS
+        - Linux (General)
+        - Other
+    validations:
+      required: false
   - type: dropdown
     id: browsers
     attributes:
-      label: What browsers are you seeing the problem on?
+      label: What browsers are you seeing the problem on (if applicable)?
       multiple: true
       options:
         - Firefox
@@ -62,10 +93,10 @@ body:
       description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
       render: TypeScript
   - type: checkboxes
-    id: terms
+    id: agreed
     attributes:
       label: Code of Conduct
-      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/storm-software/<%= name %>/blob/main/.github/CODE_OF_CONDUCT.md)
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/<%= organization %>/<%= name %>/blob/main/.github/CODE_OF_CONDUCT.md)
       options:
         - label: I agree to follow this project's Code of Conduct
           required: true

package/src/generators/preset/files/.github/ISSUE_TEMPLATE/documentation.yml.template

@@ -8,7 +8,7 @@ body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to help us improve our docs!
+        Thanks for taking the time to help us improve the ⚡Storm Docs!
   - type: input
     id: contact
     attributes:
@@ -16,25 +16,26 @@ body:
       description: How can we get in touch with you if we need more info?
       placeholder: ex. email@example.com
     validations:
-      required: false
-  - type: checkboxes
+      required: true
+  - type: dropdown
     id: type
     attributes:
       label: Documentation issue
       description: Reason for this request
+      multiple: true
       options:
-        - label: Reporting a typo
-        - label: Reporting a documentation bug
-        - label: Documentation improvement
-        - label: Documentation feedback
-          required: true
+        - Reporting a typo
+        - Reporting a documentation bug
+        - Documentation improvement
+        - Documentation feedback
+    validations:
+      required: true
   - type: input
     id: description
     attributes:
       label: Is there a specific documentation page you are reporting?
       description: Enter the URL or documentation section here.
       placeholder: Enter the URL or documentation section here.
-      value: "Enter the URL or documentation section here."
     validations:
       required: true
   - type: textarea
@@ -43,14 +44,13 @@ body:
       label: Additional context or description
       description: Provide any additional details here as needed.
       placeholder: Provide any additional details here as needed.
-      value: "Provide any additional details here as needed."
     validations:
       required: false
   - type: checkboxes
-    id: terms
+    id: agreed
     attributes:
       label: Code of Conduct
-      description: By submitting this request, you agree to follow our [Code of Conduct](https://github.com/storm-software/<%= name %>/blob/main/.github/CODE_OF_CONDUCT.md)
+      description: By submitting this request, you agree to follow our [Code of Conduct](https://github.com/<%= organization %>/<%= name %>/blob/main/.github/CODE_OF_CONDUCT.md)
       options:
         - label: I agree to follow this project's Code of Conduct
           required: true

package/src/generators/preset/files/.github/ISSUE_TEMPLATE/feature-request.yml.template

@@ -17,14 +17,13 @@ body:
       description: How can we get in touch with you if we need more info?
       placeholder: ex. email@example.com
     validations:
-      required: false
+      required: true
   - type: textarea
     id: description
     attributes:
       label: Description
       description: What is the behavior that you would like to see introduced?
       placeholder: What is the behavior that you would like to see introduced?
-      value: "What is the behavior that you would like to see introduced?"
     validations:
       required: true
   - type: textarea
@@ -33,7 +32,6 @@ body:
       label: Motivation
       description: Why do you believe this behavior would be beneficial?
       placeholder: Why do you believe this behavior would be beneficial?
-      value: "Why do you believe this behavior would be beneficial?"
     validations:
       required: false
   - type: textarea
@@ -42,7 +40,6 @@ body:
       label: Suggested Implementation
       description: How do you imagine this might work?
       placeholder: How do you imagine this might work?
-      value: "How do you imagine this might work?"
     validations:
       required: false
   - type: checkboxes
@@ -51,13 +48,13 @@ body:
       label: Contribution
       description: Willingness to contribute
       options:
-        - label: I'd be willing to implement this feature ([contributing guide](https://github.com/storm-software/<%= name %>/blob/main/.github/CONTRIBUTING.md))
+        - label: I'd be willing to implement this feature ([contributing guide](https://github.com/<%= organization %>/<%= name %>/blob/main/.github/CONTRIBUTING.md))
           required: false
   - type: checkboxes
-    id: terms
+    id: agreed
     attributes:
       label: Code of Conduct
-      description: By submitting this request, you agree to follow our [Code of Conduct](https://github.com/storm-software/<%= name %>/blob/main/.github/CODE_OF_CONDUCT.md)
+      description: By submitting this request, you agree to follow our [Code of Conduct](https://github.com/<%= organization %>/<%= name %>/blob/main/.github/CODE_OF_CONDUCT.md)
       options:
         - label: I agree to follow this project's Code of Conduct
           required: true

package/src/generators/preset/files/.github/PULL_REQUEST_TEMPLATE.md.template

@@ -4,7 +4,7 @@
 
 Thank you good citizen for your hard work! Please provide the below details describing your PR.
 
-**Note:** Please read the [contributing guide](https://github.com/storm-software/stormstack/blob/main/.github/CONTRIBUTING.md) before raising a pull request.
+**Note:** Please read the [contributing guide](https://github.com/<%= organization %>/<%= name %>/blob/main/.github/CONTRIBUTING.md) before raising a pull request.
 
 ## Pull request type
 

package/src/generators/preset/files/.github/actions/node/action.yaml

@@ -1,10 +1,6 @@
-name: "Setup Node"
+name: "Setup Workspace"
 description: "This action install node and cache modules. It uses pnpm as package manager."
 inputs:
-  node-version:
-    description: "The node version to install (Default: lts)"
-    default: "lts/*"
-    required: false
   working-directory:
     description: "The working directory of your node package"
     default: "."
@@ -20,7 +16,7 @@ runs:
     - uses: pnpm/action-setup@v2.4.0
       id: pnpm-install
       with:
-        version: 8.6.10
+        version: 8.7.4
         run_install: false
 
     - name: Get pnpm store directory
@@ -29,14 +25,17 @@ runs:
       run: |
         echo "pnpm_cache_dir=$(pnpm store path)" >> $GITHUB_OUTPUT
 
-    - uses: actions/cache@v3
-      name: Setup pnpm cache
+    - uses: actions/setup-node@v4
       with:
-        path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
-        key: ${{ runner.os }}-pnpm-8-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-        restore-keys: |
-          ${{ runner.os }}-pnpm-8-store-
+        registry-url: https://registry.npmjs.org/
+        node-version-file: .github/.nvmrc
+        cache: pnpm
+        cache-dependency-path: pnpm-lock.yaml
 
     - name: setup pnpm config registry
       run: pnpm config set registry https://registry.npmjs.org
       shell: bash
+
+    - name: setup pnpm config registry
+      run: pnpm install
+      shell: bash

package/src/generators/preset/files/.github/codecov.yml

@@ -26,4 +26,4 @@ comment:
   require_changes: false # if true: only post the comment if coverage changes
   require_base: false # [yes :: must have a base report to post]
   require_head: true # [yes :: must have a head report to post]
-  branches: ["main", "master"]
+  branches: ["main"]

package/src/generators/preset/files/.github/renovate.json.template

@@ -22,14 +22,14 @@
   },
   "packageRules": [
     {
-      "matchPackagePatterns": ["^@<%= name %>/"],
+      "matchPackagePatterns": ["^@<%= namespace %>/"],
       "enabled": true
     },
     {
       "matchPackageNames": ["@nx"],
       "postUpgradeTasks": {
         "commands": [
-          "npx nx migrate latest --run-migrations --create-commits --commit-message='chore(<%= name %>): update @nx dependencies'"
+          "npx nx migrate latest --run-migrations --create-commits --commit-message='chore(<%= name %>): update @nx dependencies [skip ci]'"
         ]
       }
     },
@@ -47,9 +47,5 @@
       "depTypeList": ["dependencies"],
       "updateTypes": ["patch", "pin"]
     }
-  ],
-    "vulnerabilityAlerts": {
-    "enabled": true
-  },
-  "osvVulnerabilityAlerts": true
+  ]
 }