amtrack · amtrack · Feb 4, 2025 · Feb 7, 2025 · Feb 8, 2025 · Feb 17, 2025
diff --git a/.github/workflows/default.yml b/.github/workflows/default.yml
@@ -22,17 +22,12 @@ jobs:
           npm install --global @salesforce/cli
       - name: Run tests
         run: npm run test
-      - name: Run E2E tests
+      - name: Run E2E tests in Developer Edition
         env:
-          SFDX_AUTH_URL_DEVHUB: ${{ secrets.SFDX_AUTH_URL_DEVHUB }}
+          SFDX_AUTH_URL_DEVED: ${{ secrets.SFDX_AUTH_URL_DEVED }}
         run: |
-          echo "${SFDX_AUTH_URL_DEVHUB}" | sf org login sfdx-url --set-default-dev-hub --alias devhub --sfdx-url-stdin
-          sf org create scratch -f config/project-scratch-def.json --set-default
+          echo "${SFDX_AUTH_URL_DEVED}" | sf org login sfdx-url --set-default --alias deved --sfdx-url-stdin
           npm run test:e2e
-      - name: Delete scratch org
-        if: always()
-        run: |
-          sf org delete scratch --no-prompt
       - name: Release package
         run: npx semantic-release
         env:

diff --git a/README.md b/README.md
@@ -4,7 +4,14 @@
 
 For certain Metadata Types there is a different behaviour of the [file-based](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_retrieve.htm) vs. [CRUD-based](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_readMetadata.htm) Metadata API.
 
-This plugin provides a `sf force source read` command to read Metadata using the "CRUD-based" Metadata API similar to `sf force source retrieve` (which uses the "file-based" Metadata API).
+And additionally the file-based Metadata API even behaves differently for source-tracked vs. non-source-tracked orgs.
+
+> [!IMPORTANT]
+> The CRUD-based Metadata API can be of great help when working with non-source-tracked orgs.
+>
+> Read more about about this in my [mdapi-issues/retrieve-behavior-scratch-org](https://github.com/mdapi-issues/retrieve-behavior-scratch-org) repository.
+
+This plugin provides a `sf crud-mdapi read` (formerly `sf force source read`) command to read Metadata using the "CRUD-based" Metadata API similar to `sf project retrieve start` (which uses the "file-based" Metadata API).
 
 > [!NOTE]
 > This plugin simply returns the unfiltered response from the CRUD-based Metadata API.
@@ -20,11 +27,11 @@ sf plugins install sfdx-plugin-source-read
 ## Usage
 
 ```console
-sf force source read -m "Profile:Admin"
-sf force source read -p force-app/main/default/profiles/Admin.profile-meta.xml
-sf force source read -m "RecordType:Account.Business"
-sf force source read -p force-app/main/default/objects/Account/recordTypes/Business.recordType-meta.xml
-sf force source read -m "CustomObjectTranslation:Task-de"
+sf crud-mdapi read --metadata "Profile:Admin"
+sf crud-mdapi read --source-dir force-app/main/default/profiles/Admin.profile-meta.xml
+sf crud-mdapi read --metadata "RecordType:Account.Business"
+sf crud-mdapi read --source-dir force-app/main/default/objects/Account/recordTypes/Business.recordType-meta.xml
+sf crud-mdapi read --metadata "CustomObjectTranslation:Task-de"
 ```
 
 ## Example

diff --git a/bin/dev.cmd b/bin/dev.cmd
@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*
diff --git a/bin/dev.js b/bin/dev.js
@@ -0,0 +1,8 @@
+#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
+// eslint-disable-next-line node/shebang
+async function main() {
+  const { execute } = await import("@oclif/core");
+  await execute({ development: true, dir: import.meta.url });
+}
+
+await main();
diff --git a/bin/run.cmd b/bin/run.cmd
diff --git a/bin/run → bin/run.js b/bin/run → bin/run.js
diff --git a/config/project-scratch-def.json b/config/project-scratch-def.json
@@ -3,5 +3,9 @@
   "edition": "Developer",
   "language": "en_US",
   "features": [],
-  "settings": {}
+  "settings": {
+    "languageSettings": {
+      "enableTranslationWorkbench": true
+    }
+  }
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
   "bugs": "https://github.com/amtrack/sfdx-plugin-source-read/issues",
   "type": "module",
   "bin": {
-    "sfdx-plugin-source-read": "bin/run"
+    "sfdx-plugin-source-read": "bin/run.js"
   },
   "dependencies": {
     "@salesforce/sf-plugins-core": "12.1.3",
@@ -17,6 +17,7 @@
     "execa": "9.5.2",
     "oclif": "4.17.25"
   },
+  "exports": "./lib/index.js",
   "files": [
     "/bin",
     "/lib",
@@ -34,7 +35,12 @@
     "topicSeparator": " ",
     "additionalHelpFlags": [
       "-h"
-    ]
+    ],
+    "topics": {
+      "crud-mdapi": {
+        "description": "Work with the CRUD Metadata API."
+      }
+    }
   },
   "mocha": {
     "loader": "ts-node/esm",
@@ -45,7 +51,7 @@
     "build": "rm -rf lib && tsc -p . && oclif manifest",
     "prepack": "npm run build",
     "prepare": "npm run build",
-    "test": "tsc -p test && nyc --reporter=lcov --reporter=text mocha \"test/**/*.test.ts\"",
+    "test": "tsc -p test && mocha \"test/**/*.test.ts\"",
     "test:e2e": "tsc -p test && mocha --timeout 60000 \"test/**/*.e2e.ts\""
   }
 }
diff --git a/...dtranslations/objectTranslations/Dummy__c-en_US/Dummy__c-en_US.objectTranslation-meta.xml b/...dtranslations/objectTranslations/Dummy__c-en_US/Dummy__c-en_US.objectTranslation-meta.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomObjectTranslation xmlns="http://soap.sforce.com/2006/04/metadata">
+    <fullName>Dummy__c-en_US</fullName>
+</CustomObjectTranslation>
diff --git a/...ith-fieldtranslations/objectTranslations/Dummy__c-en_US/Type__c.fieldTranslation-meta.xml b/...ith-fieldtranslations/objectTranslations/Dummy__c-en_US/Type__c.fieldTranslation-meta.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomFieldTranslation xmlns="http://soap.sforce.com/2006/04/metadata">
+    <help>TEST help text</help>
+    <label>TEST Type</label>
+    <name>Type__c</name>
+</CustomFieldTranslation>
diff --git a/...customobjecttranslations-with-fieldtranslations/objects/Dummy__c/Dummy__c.object-meta.xml b/...customobjecttranslations-with-fieldtranslations/objects/Dummy__c/Dummy__c.object-meta.xml
@@ -0,0 +1,165 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+    <actionOverrides>
+        <actionName>Accept</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Accept</actionName>
+        <formFactor>Large</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Accept</actionName>
+        <formFactor>Small</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>CancelEdit</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>CancelEdit</actionName>
+        <formFactor>Large</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>CancelEdit</actionName>
+        <formFactor>Small</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Clone</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Clone</actionName>
+        <formFactor>Large</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Clone</actionName>
+        <formFactor>Small</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Delete</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Delete</actionName>
+        <formFactor>Large</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Delete</actionName>
+        <formFactor>Small</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Edit</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Edit</actionName>
+        <formFactor>Large</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Edit</actionName>
+        <formFactor>Small</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>List</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>List</actionName>
+        <formFactor>Large</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>List</actionName>
+        <formFactor>Small</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>New</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>New</actionName>
+        <formFactor>Large</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>New</actionName>
+        <formFactor>Small</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>SaveEdit</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>SaveEdit</actionName>
+        <formFactor>Large</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>SaveEdit</actionName>
+        <formFactor>Small</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Tab</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Tab</actionName>
+        <formFactor>Large</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>Tab</actionName>
+        <formFactor>Small</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>View</actionName>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>View</actionName>
+        <formFactor>Large</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <actionOverrides>
+        <actionName>View</actionName>
+        <formFactor>Small</formFactor>
+        <type>Default</type>
+    </actionOverrides>
+    <allowInChatterGroups>false</allowInChatterGroups>
+    <compactLayoutAssignment>SYSTEM</compactLayoutAssignment>
+    <deploymentStatus>Deployed</deploymentStatus>
+    <enableActivities>false</enableActivities>
+    <enableBulkApi>true</enableBulkApi>
+    <enableFeeds>false</enableFeeds>
+    <enableHistory>false</enableHistory>
+    <enableLicensing>false</enableLicensing>
+    <enableReports>false</enableReports>
+    <enableSearch>false</enableSearch>
+    <enableSharing>true</enableSharing>
+    <enableStreamingApi>true</enableStreamingApi>
+    <externalSharingModel>Private</externalSharingModel>
+    <label>Dummy</label>
+    <nameField>
+        <label>Dummy Name</label>
+        <type>Text</type>
+    </nameField>
+    <pluralLabel>Dummies</pluralLabel>
+    <searchLayouts></searchLayouts>
+    <sharingModel>ReadWrite</sharingModel>
+    <visibility>Public</visibility>
+</CustomObject>
diff --git a/...mobjecttranslations-with-fieldtranslations/objects/Dummy__c/fields/Type__c.field-meta.xml b/...mobjecttranslations-with-fieldtranslations/objects/Dummy__c/fields/Type__c.field-meta.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
+    <fullName>Type__c</fullName>
+    <externalId>false</externalId>
+    <inlineHelpText>Type</inlineHelpText>
+    <label>Type</label>
+    <required>false</required>
+    <trackTrending>false</trackTrending>
+    <type>Picklist</type>
+    <valueSet>
+        <restricted>true</restricted>
+        <valueSetDefinition>
+            <sorted>false</sorted>
+            <value>
+                <fullName>One</fullName>
+                <default>false</default>
+                <label>One</label>
+            </value>
+            <value>
+                <fullName>Two</fullName>
+                <default>false</default>
+                <label>Two</label>
+            </value>
+            <value>
+                <fullName>Three</fullName>
+                <default>false</default>
+                <label>Three</label>
+            </value>
+        </valueSetDefinition>
+    </valueSet>
+</CustomField>
diff --git a/sfdx-source/profile-with-field-permissions/objects/Account/Account.object-meta.xml b/sfdx-source/profile-with-field-permissions/objects/Account/Account.object-meta.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata"></CustomObject>
diff --git a/sfdx-source/profile-with-field-permissions/objects/Account/fields/IsTest__c.field-meta.xml b/sfdx-source/profile-with-field-permissions/objects/Account/fields/IsTest__c.field-meta.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
+    <fullName>IsTest__c</fullName>
+    <defaultValue>false</defaultValue>
+    <description>description</description>
+    <inlineHelpText>help text</inlineHelpText>
+    <label>Is Test</label>
+    <type>Checkbox</type>
+</CustomField>
diff --git a/sfdx-source/profile-with-field-permissions/profiles/Dummy.profile-meta.xml b/sfdx-source/profile-with-field-permissions/profiles/Dummy.profile-meta.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Profile xmlns="http://soap.sforce.com/2006/04/metadata">
+    <fieldPermissions>
+        <editable>true</editable>
+        <field>Account.IsTest__c</field>
+        <readable>true</readable>
+    </fieldPermissions>
+    <custom>true</custom>
+    <userLicense>Salesforce</userLicense>
+</Profile>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		@echo off

		node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		<?xml version="1.0" encoding="UTF-8"?>
		<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata"></CustomObject>