rflib-plugin 0.1.2

package/oclif.manifest.json

@@ -0,0 +1,197 @@
+{
+  "commands": {
+    "rflib:logging:apex:instrument": {
+      "aliases": [],
+      "args": {},
+      "description": "Analyzes Apex classes and adds RFLIB logging statements for method entry and error handling. Adds class-level logger initialization if not already present. \nFor Apex Test classes, the `@TestSetup` method will be updated to include `rflib_TestUtil.prepareLoggerForUnitTests();` to avoid test failures caused by the logging framework.",
+      "examples": [
+        "- Add logging statements to all Apex classes in a directory:\n\n$ sf rflib logging apex instrument --sourcepath force-app/main/default/classes\n\n- Preview changes without modifying files:\n\n$ sf rflib logging apex instrument --sourcepath force-app/main/default/classes --dryrun\n\n- Add logging statements and format code:\n\n$ sf rflib logging apex instrument --sourcepath force-app/main/default/classes --prettier"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "sourcepath": {
+          "char": "s",
+          "description": "Path to the source directory containing Apex classes that should be instrumented with RFLIB logging statements. Test classes (ending with 'Test.cls') are automatically excluded.",
+          "name": "sourcepath",
+          "required": true,
+          "summary": "Directory containing Apex classes to instrument with logging.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "dryrun": {
+          "char": "d",
+          "description": "When enabled, shows which files would be modified without making actual changes. Useful for reviewing the impact before applying changes.",
+          "name": "dryrun",
+          "summary": "Preview changes without modifying files.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "prettier": {
+          "char": "p",
+          "description": "When enabled, formats the modified Apex files using prettier-plugin-apex after adding logging statements. Maintains consistent code style.",
+          "name": "prettier",
+          "summary": "Format modified files using Prettier.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "rflib:logging:apex:instrument",
+      "pluginAlias": "rflib-plugin",
+      "pluginName": "rflib-plugin",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Instrument Apex classes with RFLIB logging statements automatically.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "rflib",
+        "logging",
+        "apex",
+        "instrument.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "rflib:logging:apex:instrument",
+        "logging:rflib:apex:instrument",
+        "logging:apex:rflib:instrument",
+        "logging:apex:instrument:rflib",
+        "rflib:apex:logging:instrument",
+        "apex:rflib:logging:instrument",
+        "apex:logging:rflib:instrument",
+        "apex:logging:instrument:rflib",
+        "rflib:apex:instrument:logging",
+        "apex:rflib:instrument:logging",
+        "apex:instrument:rflib:logging",
+        "apex:instrument:logging:rflib",
+        "rflib:logging:instrument:apex",
+        "logging:rflib:instrument:apex",
+        "logging:instrument:rflib:apex",
+        "logging:instrument:apex:rflib",
+        "rflib:instrument:logging:apex",
+        "instrument:rflib:logging:apex",
+        "instrument:logging:rflib:apex",
+        "instrument:logging:apex:rflib",
+        "rflib:instrument:apex:logging",
+        "instrument:rflib:apex:logging",
+        "instrument:apex:rflib:logging",
+        "instrument:apex:logging:rflib"
+      ]
+    },
+    "rflib:logging:lwc:instrument": {
+      "aliases": [],
+      "args": {},
+      "description": "Analyzes Lightning Web Component JavaScript files and adds RFLIB logging statements for:\n- Method entry logging with parameter values\n- Error logging in try-catch blocks\n- Error logging in Promise catch handlers\n- Condition logging in if/else blocks\n- Adds logger import if not present\n- Adds logger initialization if not present\n- Formats modified files using Prettier (optional)",
+      "examples": [
+        "- Add logging to all LWC files:\n$ sf rflib logging lwc instrument --sourcepath force-app/main/default/lwc\n\n- Preview changes:\n$ sf rflib logging lwc instrument --sourcepath force-app/main/default/lwc --dryrun\n\n- Add logging and format code:\n$ sf rflib logging lwc instrument --sourcepath force-app/main/default/lwc --prettier\n\n- Process specific component:\n$ sf rflib logging lwc instrument --sourcepath force-app/main/default/lwc/myComponent"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "sourcepath": {
+          "char": "s",
+          "description": "Path to the source directory containing Lightning Web Component JavaScript files that should be instrumented with RFLIB logging statements. Aura component files are automatically excluded. The command will:\n- Process all .js files in the directory and subdirectories\n- Skip files in 'aura' directories\n- Add import statement: import { createLogger } from 'c/rflibLogger'\n- Add logger initialization: const logger = createLogger('ComponentName')",
+          "name": "sourcepath",
+          "required": true,
+          "summary": "Directory containing LWC JavaScript files to instrument with logging.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "dryrun": {
+          "char": "d",
+          "description": "When enabled, shows which files would be modified without making actual changes. Useful for reviewing the impact before applying changes. Shows:\n- Files that would be modified\n- Number of processed files\n- Number of modified files\n- Number of formatted files",
+          "name": "dryrun",
+          "summary": "Preview changes without modifying files.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "prettier": {
+          "char": "p",
+          "description": "When enabled, formats the modified JavaScript files using Prettier after adding logging statements. Maintains consistent code style with:\n- 120 character line width\n- 4 space indentation\n- Single quotes for strings\n- No tabs",
+          "name": "prettier",
+          "summary": "Format modified files using Prettier.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "rflib:logging:lwc:instrument",
+      "pluginAlias": "rflib-plugin",
+      "pluginName": "rflib-plugin",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Instrument Lightning Web Components with RFLIB logging statements automatically.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "rflib",
+        "logging",
+        "lwc",
+        "instrument.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "rflib:logging:lwc:instrument",
+        "logging:rflib:lwc:instrument",
+        "logging:lwc:rflib:instrument",
+        "logging:lwc:instrument:rflib",
+        "rflib:lwc:logging:instrument",
+        "lwc:rflib:logging:instrument",
+        "lwc:logging:rflib:instrument",
+        "lwc:logging:instrument:rflib",
+        "rflib:lwc:instrument:logging",
+        "lwc:rflib:instrument:logging",
+        "lwc:instrument:rflib:logging",
+        "lwc:instrument:logging:rflib",
+        "rflib:logging:instrument:lwc",
+        "logging:rflib:instrument:lwc",
+        "logging:instrument:rflib:lwc",
+        "logging:instrument:lwc:rflib",
+        "rflib:instrument:logging:lwc",
+        "instrument:rflib:logging:lwc",
+        "instrument:logging:rflib:lwc",
+        "instrument:logging:lwc:rflib",
+        "rflib:instrument:lwc:logging",
+        "instrument:rflib:lwc:logging",
+        "instrument:lwc:rflib:logging",
+        "instrument:lwc:logging:rflib"
+      ]
+    }
+  },
+  "version": "0.1.2"
+}

package/package.json

@@ -0,0 +1,211 @@
+{
+  "name": "rflib-plugin",
+  "description": "Utility commands to help with the adoption of the RFLIB open-source library for Salesforce.",
+  "version": "0.1.2",
+  "dependencies": {
+    "@oclif/core": "^4",
+    "@salesforce/core": "^8",
+    "@salesforce/sf-plugins-core": "^12",
+    "prettier": "^3.4.2",
+    "prettier-plugin-apex": "^2.2.2"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.6.1",
+    "@oclif/plugin-command-snapshot": "^5.1.9",
+    "@salesforce/cli-plugins-testkit": "^5.3.10",
+    "@salesforce/dev-scripts": "^10",
+    "eslint-plugin-sf-plugin": "^1.18.6",
+    "husky": "^8.0.0",
+    "oclif": "^4.17.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/oclif.manifest.json",
+    "/oclif.lock"
+  ],
+  "keywords": [
+    "force",
+    "salesforce",
+    "salesforcedx",
+    "sf",
+    "sf-plugin",
+    "sfdx",
+    "sfdx-plugin"
+  ],
+  "license": "BSD-3-Clause",
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "sf",
+    "topicSeparator": " ",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
+    "topics": {
+      "rflib": {
+        "description": "description for rflib",
+        "subtopics": {
+          "logging": {
+            "description": "description for rflib.logging",
+            "subtopics": {
+              "apex": {
+                "description": "description for rflib.logging.apex"
+              },
+              "lwc": {
+                "description": "description for rflib.logging.lwc"
+              }
+            }
+          }
+        }
+      }
+    },
+    "flexibleTaxonomy": true
+  },
+  "scripts": {
+    "build": "wireit",
+    "clean": "sf-clean",
+    "clean-all": "sf-clean all",
+    "compile": "wireit",
+    "docs": "sf-docs",
+    "format": "wireit",
+    "link-check": "wireit",
+    "lint": "wireit",
+    "postinstall": "yarn husky install || echo \"Unable to install Husky. If you are in a CI/CD job, that's ok !\"",
+    "postpack": "sf-clean --ignore-signing-artifacts",
+    "prepack": "sf-prepack",
+    "test": "wireit",
+    "test:nuts": "wireit",
+    "test:only": "wireit",
+    "version": "oclif readme",
+    "prepare": "husky install"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "wireit": {
+    "build": {
+      "dependencies": [
+        "compile",
+        "lint"
+      ]
+    },
+    "compile": {
+      "command": "tsc -p . --pretty --incremental",
+      "files": [
+        "src/**/*.ts",
+        "**/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"
+      ],
+      "output": []
+    },
+    "test:compile": {
+      "command": "tsc -p \"./test\" --pretty",
+      "files": [
+        "test/**/*.ts",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test": {
+      "dependencies": [
+        "test:compile",
+        "test:only",
+        "lint"
+      ]
+    },
+    "test:only": {
+      "command": "nyc mocha \"test/**/*.test.ts\"",
+      "env": {
+        "FORCE_COLOR": "2"
+      },
+      "files": [
+        "test/**/*.ts",
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        ".mocha*",
+        "!*.nut.ts",
+        ".nycrc"
+      ],
+      "output": []
+    },
+    "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"
+      ]
+    },
+    "test:deprecation-policy": {
+      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" snapshot:compare",
+      "files": [
+        "src/**/*.ts"
+      ],
+      "output": [],
+      "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:nuts": {
+      "command": "nyc mocha \"test/**/*.nut.ts\" --slow 4500 --timeout 600000",
+      "dependencies": [
+        "compile"
+      ]
+    },
+    "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|%s\" --markdown --retry --directory-listing --verbosity error",
+      "files": [
+        "./*.md",
+        "./!(CHANGELOG).md",
+        "messages/**/*.md"
+      ],
+      "output": []
+    }
+  },
+  "exports": "./lib/index.js",
+  "type": "module",
+  "author": "Johannes Fischer"
+}