@simplysf/simply-document 0.2.0

package/lib/common/technicalDesignDocumentTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"technicalDesignDocumentTemplate.js","sourceRoot":"","sources":["../../src/common/technicalDesignDocumentTemplate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,UAAU,MAAM,YAAY,CAAC;AA0HpC,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;AAEvC,UAAU,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,OAAe,EAAU,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;AAEtF,MAAM,6BAA6B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAisCrC,CAAC;AAEF,MAAM,6BAA6B,GAAG,UAAU,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;AAExF;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,gCAAgC,CAC9C,IAAiC,EACjC,oBAA6B;IAE7B,MAAM,MAAM,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,6BAA6B,CAAC;IAC/G,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/lib/index.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2026, Clay Chipps; Copyright (c) 2026 Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export default {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,eAAe,EAAE,CAAC"}

package/messages/simply.document.diff.md

@@ -0,0 +1,63 @@
+# summary
+
+Generate a change report between two git refs.
+
+# description
+
+Runs `git diff --name-status` between two git refs (tags, branches, or commits) in the current working directory, groups the changed files by Salesforce metadata component type, and renders a Confluence-storage-format change report suitable for pasting into a release or change-management page.
+
+# flags.from-tag.summary
+
+The starting git ref for the diff report.
+
+# flags.to-tag.summary
+
+The ending git ref for the diff report.
+
+# flags.output-file.summary
+
+Path to write the generated report to.
+
+# flags.output-file.description
+
+When specified, the generated report is written to this path instead of being printed to the terminal.
+
+# flags.template-file.summary
+
+Path to a custom Handlebars template to render instead of the built-in one.
+
+# flags.template-file.description
+
+When specified, this template is rendered with the same data the built-in report template receives, and can reuse the built-in `changeTable` partial. See this package's README "Custom Templates" section for the data shape and available partials.
+
+# flags.output-format.summary
+
+Output format to render the report in.
+
+# flags.output-format.description
+
+Currently only `html` is supported. Reserved for future formats (e.g. Markdown).
+
+# examples
+
+- <%= config.bin %> <%= command.id %> --from-tag v1.0.0 --to-tag v1.1.0
+
+- <%= config.bin %> <%= command.id %> --from-tag v1.0.0 --to-tag v1.1.0 --output-file change-report.html
+
+- <%= config.bin %> <%= command.id %> --from-tag v1.0.0 --to-tag v1.1.0 --template-file my-change-report.hbs
+
+# error.gitDiffFailed
+
+Failed to run git diff: %s
+
+# error.unsupportedOutputFormat
+
+Unsupported output format: %s
+
+# info.generatingDiff
+
+Generating change report from %s to %s...
+
+# info.complete
+
+Change report written to %s

package/messages/simply.document.generate.md

@@ -0,0 +1,61 @@
+# summary
+
+Generate a technical design document for a Salesforce project.
+
+# description
+
+Scans a Salesforce DX project's source directory for metadata (objects, fields, Apex, Lightning components, flows, permissions, and more) and renders a Confluence-storage-format technical design document covering the data model, security model, groups/queues/permissions, solution inventory, and custom code inventory.
+
+# flags.directory.summary
+
+Salesforce project source directory to scan.
+
+# flags.output-file.summary
+
+Path to write the generated document to.
+
+# flags.template-file.summary
+
+Path to a custom Handlebars template to render instead of the built-in one.
+
+# flags.template-file.description
+
+When specified, this template is rendered with the same scanned project data the built-in technical design document template receives, and can reuse the built-in `loud` helper. See this package's README "Custom Templates" section for the data shape.
+
+# flags.output-format.summary
+
+Output format to render the document in.
+
+# flags.output-format.description
+
+Currently only `html` is supported. Reserved for future formats (e.g. Markdown).
+
+# examples
+
+- <%= config.bin %> <%= command.id %> --directory force-app --output-file technical-design-document.html
+
+- <%= config.bin %> <%= command.id %> --directory force-app --output-file technical-design-document.html --template-file my-tdd-template.hbs
+
+# error.scanFailed
+
+Failed to scan the project directory: %s
+
+# error.unsupportedOutputFormat
+
+Unsupported output format: %s
+
+# info.scanningProject
+
+Scanning Salesforce project directory...
+
+# info.mappingObjects
+
+Processing and mapping custom/standard objects...
+
+# info.renderingDocument
+
+Rendering technical design document...
+
+# info.complete
+
+Technical design document written to %s

package/package.json

@@ -0,0 +1,210 @@
+{
+  "name": "@simplysf/simply-document",
+  "description": "Utilities for generating project documentation",
+  "version": "0.2.0",
+  "author": "@ClayChipps",
+  "homepage": "https://github.com/SimplySF/simply-node",
+  "bugs": "https://github.com/SimplySF/simply-node/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SimplySF/simply-node",
+    "directory": "packages/simply-document"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/npm-shrinkwrap.json",
+    "/oclif.lock",
+    "/oclif.manifest.json"
+  ],
+  "keywords": [
+    "force",
+    "salesforce",
+    "sfdx",
+    "salesforcedx",
+    "sfdx-plugin",
+    "sf-plugin",
+    "sf"
+  ],
+  "license": "Apache-2.0",
+  "exports": "./lib/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "sf",
+    "commands": "./lib/commands",
+    "devPlugins": [
+      "@oclif/plugin-command-snapshot",
+      "@oclif/plugin-help",
+      "@salesforce/plugin-command-reference"
+    ],
+    "flexibleTaxonomy": true,
+    "plugins": [],
+    "repositoryPrefix": "<%- repo %>/blob/@simplysf/simply-document@<%- version %>/packages/simply-document/<%- commandPath %>",
+    "topics": {
+      "simply": {
+        "description": "Commands for simplifying Salesforce",
+        "subtopics": {
+          "document": {
+            "description": "Commands for generating project documentation"
+          }
+        }
+      }
+    },
+    "topicSeparator": " "
+  },
+  "dependencies": {
+    "@oclif/core": "^4.11.2",
+    "@salesforce/core": "^8.30.0",
+    "@salesforce/sf-plugins-core": "^12.2.16",
+    "@salesforce/source-deploy-retrieve": "^12.37.2",
+    "@salesforce/ts-types": "^2.0.12",
+    "handlebars": "^4.7.9"
+  },
+  "devDependencies": {
+    "@oclif/plugin-command-snapshot": "^5.3.19",
+    "@salesforce/plugin-command-reference": "^3.1.99",
+    "@vitest/coverage-v8": "^4.1.10",
+    "vitest": "^4.1.10"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "wireit",
+    "compile": "wireit",
+    "fix-license": "eslint src test --fix --rule \"header/header: [2]\"",
+    "format": "wireit",
+    "link-check": "wireit",
+    "lint": "wireit",
+    "readme": "oclif readme --no-aliases",
+    "test": "wireit",
+    "test:coverage": "vitest run --coverage --project simply-document",
+    "test:nuts": "vitest run --config vitest.nuts.config.ts --project simply-document",
+    "test:only": "wireit",
+    "test:watch": "vitest watch --project simply-document"
+  },
+  "wireit": {
+    "build": {
+      "dependencies": [
+        "command-snapshot",
+        "compile",
+        "lint"
+      ]
+    },
+    "compile": {
+      "command": "tsc -p . --pretty --incremental",
+      "files": [
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        "../../tsconfig.json",
+        "messages/**"
+      ],
+      "output": [
+        "lib/**",
+        "*.tsbuildinfo"
+      ],
+      "clean": "if-file-deleted"
+    },
+    "format": {
+      "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "schemas/**/*.json",
+        "command-snapshot.json",
+        ".prettier*"
+      ],
+      "output": []
+    },
+    "lint": {
+      "command": "eslint src test --color --cache --cache-location .eslintcache",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "messages/**",
+        "**/.eslint*",
+        "**/tsconfig.json",
+        "../../eslint.config.mjs",
+        "../../tsconfig.json"
+      ],
+      "output": []
+    },
+    "test": {
+      "dependencies": [
+        "test:compile",
+        "test:only",
+        "test:command-reference",
+        "lint",
+        "test:json-schema",
+        "link-check"
+      ]
+    },
+    "test:command-reference": {
+      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" commandreference:generate --erroronwarnings",
+      "files": [
+        "src/**/*.ts",
+        "messages/**",
+        "package.json"
+      ],
+      "output": [
+        "tmp/root"
+      ]
+    },
+    "command-snapshot": {
+      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" snapshot:generate && prettier --write command-snapshot.json",
+      "files": [
+        "src/**/*.ts"
+      ],
+      "output": [
+        "command-snapshot.json"
+      ],
+      "dependencies": [
+        "compile"
+      ]
+    },
+    "test:json-schema": {
+      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" schema:compare",
+      "files": [
+        "src/**/*.ts",
+        "schemas"
+      ],
+      "output": []
+    },
+    "test:compile": {
+      "command": "tsc -p \"./test\" --pretty",
+      "files": [
+        "test/**/*.ts",
+        "**/tsconfig.json",
+        "../../tsconfig.json"
+      ],
+      "output": []
+    },
+    "test:only": {
+      "command": "vitest run --project simply-document",
+      "env": {
+        "FORCE_COLOR": "2"
+      },
+      "files": [
+        "test/**/*.ts",
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        "../../tsconfig.json",
+        "vitest.config.ts",
+        "!*.nut.ts"
+      ],
+      "output": []
+    },
+    "link-check": {
+      "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"**/*.md\" --skip \"CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|localhost|blob/.*/lib/|%s\" --markdown --retry --directory-listing --verbosity error",
+      "files": [
+        "./*.md",
+        "./!(CHANGELOG).md",
+        "messages/**/*.md"
+      ],
+      "output": []
+    }
+  }
+}