@simplysf/simply-apex 1.0.3 → 1.1.0

package/README.md

@@ -0,0 +1,172 @@
+# @simplysf/simply-apex
+
+[![NPM](https://img.shields.io/npm/v/@simplysf/simply-apex?label=@simplysf/simply-apex)](https://npmjs.com/@simplysf/simply-apex) [![Downloads/week](https://img.shields.io/npm/dw/@simplysf/simply-apex.svg)](https://npmjs.com/@simplysf/simply-apex) [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://raw.githubusercontent.com/SimplySF/simply/main/LICENSE.txt)
+
+## Install
+
+```bash
+sf plugins install @simplysf/simply-apex
+```
+
+## Issues
+
+Please report any issues at https://github.com/SimplySF/simply/issues
+
+## Contributing
+
+This package is part of the [`@simplysf/simply`](https://github.com/SimplySF/simply) monorepo. See the repo's [CONTRIBUTING.md](https://github.com/SimplySF/simply/blob/main/CONTRIBUTING.md) for the repo structure, how to set up and build the project, our commit conventions, and how to submit a pull request. Please also read our [Code of Conduct](https://github.com/SimplySF/simply/blob/main/CODE_OF_CONDUCT.md).
+
+## Commands
+
+<!-- commands -->
+
+- [`sf simply apex execute`](#sf-simply-apex-execute)
+- [`sf simply apex logs purge`](#sf-simply-apex-logs-purge)
+- [`sf simply apex trace setup`](#sf-simply-apex-trace-setup)
+- [`sf simply apex trace silence`](#sf-simply-apex-trace-silence)
+
+## `sf simply apex execute`
+
+Execute anonymous Apex code.
+
+```
+USAGE
+  $ sf simply apex execute -f <value> -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
+
+FLAGS
+  -f, --file=<value>         (required) Path to Apex file
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
+      --api-version=<value>  Override the api version used for api requests made by this command
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Execute anonymous Apex code.
+
+  Executes an anonymous block of Apex code from a local .apex file against a target org and reports the compile and
+  execution results, including any debug logs produced.
+
+EXAMPLES
+  $ sf simply apex execute --target-org myOrg --file scripts/apex/data-fix.apex
+
+FLAG DESCRIPTIONS
+  -f, --file=<value>  Path to Apex file
+
+    The path to the local .apex file containing the anonymous Apex code to execute.
+```
+
+_See code: [lib/commands/simply/apex/execute.js](https://github.com/SimplySF/simply/blob/@simplysf/simply-apex@1.0.3/packages/simply-apex/lib/commands/simply/apex/execute.js)_
+
+## `sf simply apex logs purge`
+
+Purge Apex debug logs.
+
+```
+USAGE
+  $ sf simply apex logs purge -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>]
+
+FLAGS
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
+  -w, --where=<value>        SOQL WHERE clause
+      --api-version=<value>  Override the api version used for api requests made by this command
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Purge Apex debug logs.
+
+  Deletes ApexLog records from the target org. By default all logs are purged; use --where to scope the deletion to a
+  subset of logs.
+
+EXAMPLES
+  $ sf simply apex logs purge --target-org myOrg
+
+  $ sf simply apex logs purge --target-org myOrg --where "Status = 'Success'"
+
+FLAG DESCRIPTIONS
+  -w, --where=<value>  SOQL WHERE clause
+
+    A WHERE clause used to filter which ApexLog records are purged (e.g. "Status = 'Success'").
+```
+
+_See code: [lib/commands/simply/apex/logs/purge.js](https://github.com/SimplySF/simply/blob/@simplysf/simply-apex@1.0.3/packages/simply-apex/lib/commands/simply/apex/logs/purge.js)_
+
+## `sf simply apex trace setup`
+
+Configure a debug log trace flag for the current user.
+
+```
+USAGE
+  $ sf simply apex trace setup -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
+
+FLAGS
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
+      --api-version=<value>  Override the api version used for api requests made by this command
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Configure a debug log trace flag for the current user.
+
+  Creates or updates a 24-hour DEVELOPER_LOG trace flag for the user running the command, using a FINEST/FINER debug
+  level suitable for the Apex Replay Debugger.
+
+EXAMPLES
+  $ sf simply apex trace setup --target-org myOrg
+```
+
+_See code: [lib/commands/simply/apex/trace/setup.js](https://github.com/SimplySF/simply/blob/@simplysf/simply-apex@1.0.3/packages/simply-apex/lib/commands/simply/apex/trace/setup.js)_
+
+## `sf simply apex trace silence`
+
+Silence debug logs for specific Apex classes.
+
+```
+USAGE
+  $ sf simply apex trace silence -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-c <value> | --classes-file
+    <value>]
+
+FLAGS
+  -c, --classes=<value>       Comma-separated Apex class names
+  -o, --target-org=<value>    (required) Username or alias of the target org. Not required if the `target-org`
+                              configuration variable is already set.
+      --api-version=<value>   Override the api version used for api requests made by this command
+      --classes-file=<value>  Path to a JSON file listing classes to silence
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Silence debug logs for specific Apex classes.
+
+  Creates a 24-hour CLASS_TRACING trace flag with a fully suppressed (NONE) debug level for each specified Apex class,
+  preventing those classes from generating debug log output.
+
+EXAMPLES
+  $ sf simply apex trace silence --target-org myOrg --classes NoisyClass,ChattyTrigger
+
+  $ sf simply apex trace silence --target-org myOrg --classes-file classesToSilence.json
+
+FLAG DESCRIPTIONS
+  -c, --classes=<value>  Comma-separated Apex class names
+
+    A comma-separated list of Apex class names to silence.
+
+  --classes-file=<value>  Path to a JSON file listing classes to silence
+
+    The path to a JSON file with the shape { "classes": ["ClassOne", "ClassTwo"] } listing the Apex class names to
+    silence.
+```
+
+_See code: [lib/commands/simply/apex/trace/silence.js](https://github.com/SimplySF/simply/blob/@simplysf/simply-apex@1.0.3/packages/simply-apex/lib/commands/simply/apex/trace/silence.js)_
+<!-- commandsstop -->

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@simplysf/simply-apex",
   "description": "Utilities for working with Apex",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "author": "@ClayChipps",
   "homepage": "https://github.com/SimplySF/simply",
   "bugs": "https://github.com/SimplySF/simply/issues",
@@ -73,7 +73,9 @@
   },
   "devDependencies": {
     "@oclif/plugin-command-snapshot": "^5.3.19",
-    "@salesforce/plugin-command-reference": "^3.1.99"
+    "@salesforce/plugin-command-reference": "^3.1.99",
+    "@vitest/coverage-v8": "^4.1.10",
+    "vitest": "^4.1.10"
   },
   "publishConfig": {
     "access": "public"
@@ -87,13 +89,15 @@
     "lint": "wireit",
     "readme": "oclif readme --no-aliases",
     "test": "wireit",
+    "test:coverage": "vitest run --coverage",
     "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 1200000 --parallel --jobs 5",
     "test:only": "wireit",
-    "test:watch": "mocha --watch \"./test/**/*.test.ts\""
+    "test:watch": "vitest watch"
   },
   "wireit": {
     "build": {
       "dependencies": [
+        "command-snapshot",
         "compile",
         "lint"
       ]
@@ -138,7 +142,6 @@
         "test:compile",
         "test:only",
         "test:command-reference",
-        "test:deprecation-policy",
         "lint",
         "test:json-schema",
         "link-check"
@@ -155,12 +158,14 @@
         "tmp/root"
       ]
     },
-    "test:deprecation-policy": {
-      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" snapshot:compare",
+    "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": [],
+      "output": [
+        "command-snapshot.json"
+      ],
       "dependencies": [
         "compile"
       ]
@@ -182,7 +187,7 @@
       "output": []
     },
     "test:only": {
-      "command": "nyc mocha \"test/**/*.test.ts\"",
+      "command": "vitest run",
       "env": {
         "FORCE_COLOR": "2"
       },
@@ -190,9 +195,8 @@
         "test/**/*.ts",
         "src/**/*.ts",
         "**/tsconfig.json",
-        ".mocha*",
-        "!*.nut.ts",
-        ".nycrc"
+        "vitest.config.ts",
+        "!*.nut.ts"
       ],
       "output": []
     },
@@ -206,5 +210,5 @@
       "output": []
     }
   },
-  "gitHead": "a02ea12286840c63211344a54fbf005abc635721"
+  "gitHead": "1b10083c05b9cee20b43122cbabdc468069173ce"
 }