{"_id":"@salesforce/plugin-schema-generator","_rev":"39-827eff8703e9c9108264cb9f721d7365","name":"@salesforce/plugin-schema-generator","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@salesforce/plugin-schema-generator","version":"0.0.1","keywords":["force","salesforce","sfdx","salesforcedx","sfdx-plugin","sf-plugin","sf"],"author":{"name":"Salesforce"},"license":"BSD-3-Clause","_id":"@salesforce/plugin-schema-generator@0.0.1","maintainers":[{"name":"jye-sf","email":"jye@salesforce.com"},{"name":"adirasanam","email":"adirasanam@salesforce.com"},{"name":"hkii","email":"knair@salesforce.com"},{"name":"mcasado","email":"mcasado@salesforce.com"},{"name":"iamaziz","email":"azizramos00@gmail.com"},{"name":"dlouvton","email":"dlouvton@gmail.com"},{"name":"jc-sf","email":"junchao.zhang@salesforce.com"},{"name":"pvandyk-sf","email":"pvandyk@salesforce.com"},{"name":"dbreese-salesforce","email":"dbreese@salesforce.com"},{"name":"ashokrudraraju","email":"arudraraju@salesforce.com"},{"name":"dhersam","email":"dhersam@salesforce.com"},{"name":"demianbrecht","email":"dbrecht@salesforce.com"},{"name":"mbettio","email":"mbettiomoreira@salesforce.com"},{"name":"damilareolowoniyi","email":"damilare.olowoniyi2@mail.dcu.ie"},{"name":"mmadialagan","email":"mmadialagan@salesforce.com"},{"name":"spoorti.nidagundi","email":"spoorti.nidagundi@salesforce.com"},{"name":"rodesp","email":"rodesp@hey.com"},{"name":"mjrust","email":"mrust@salesforce.com"},{"name":"salesforce-releases","email":"alm-cli@salesforce.com"},{"name":"conal","email":"conalc86@gmail.com"},{"name":"vazexqi","email":"nchen.dev@mac.com"},{"name":"joshwlewis","email":"josh.w.lewis@gmail.com"},{"name":"mpsenn","email":"msenn@salesforce.com"},{"name":"sfdc_iamigo","email":"igoldstein@salesforce.com"},{"name":"kevinv11n","email":"kevin@v11n.com"},{"name":"tbliss","email":"tbliss@salesforce.com"},{"name":"byao","email":"bobbyyao@gmail.com"},{"name":"pmdartus","email":"dartus.pierremarie@gmail.com"},{"name":"futuremint_sf","email":"dwoodward@salesforce.com"},{"name":"interactivellama","email":"llama@interactivellama.com"},{"name":"ekashida","email":"ekashida@gmail.com"},{"name":"gr8gatsby","email":"kevinhill@live.com"},{"name":"ravi.jayaramappa","email":"ravi.jayaramappa@salesforce.com"},{"name":"apapko","email":"apapko@salesforce.com"},{"name":"krisgraysfdc","email":"kgray@salesforce.com"},{"name":"jleen-sfdc","email":"jleen@salesforce.com"},{"name":"jqian","email":"jqian@salesforce.com"},{"name":"cwallsf","email":"cwall@salesforce.com"},{"name":"dhagberg-sf","email":"dhagberg@salesforce.com"},{"name":"michaelhoefer","email":"michaelhoefer@gmail.com"},{"name":"tlohr","email":"tlohr@salesforce.com"},{"name":"khawkins","email":"khawkins@salesforce.com"},{"name":"amphro","email":"amphro@gmail.com"},{"name":"tconn","email":"tconn@salesforce.com"},{"name":"dehru","email":"dehru2@yahoo.com"},{"name":"abdulsattar","email":"asattar.md@gmail.com"},{"name":"jodarove","email":"jodarove@gmail.com"},{"name":"rxu-sfdc","email":"rxu@salesforce.com"},{"name":"amcconnell-sf","email":"amcconnell@salesforce.com"},{"name":"nolanlawson","email":"nolan@nolanlawson.com"},{"name":"sfdctaka","email":"t.arai@salesforce.com"},{"name":"fernomac","email":"no_oneatall@hotmail.com"},{"name":"cafreeman","email":"cfreeman.code@gmail.com"},{"name":"jimjag","email":"jimjag@gmail.com"},{"name":"ivarley","email":"ian@ianvarley.com"},{"name":"jbartolotta-sfdc","email":"jbartolotta@salesforce.com"}],"homepage":"https://github.com/salesforcecli/plugin-schema-generator","bugs":{"url":"https://github.com/forcedotcom/cli/issues"},"dist":{"shasum":"3ce32ce187040a041bd6beccaddf8fafd42ea352","tarball":"https://registry.npmjs.org/@salesforce/plugin-schema-generator/-/plugin-schema-generator-0.0.1.tgz","fileCount":44,"integrity":"sha512-dcugvA93tAfMKa6PLadEV6C/wbeQhR9Ud6D434zZo77oS/EynGD8HrUKELBExy01tqtUEAAKau0oX4r7MjYi8w==","signatures":[{"sig":"MEYCIQD9VCxdXMpmJHfLcJ4cUVUNBz+lYOAlu6cC0+UlQuh2wAIhAIQLK5/l4Na6108n0XAuixCWsVdh/s4YhWD7AYQ6he8m","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":95457,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi4ui9ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrxMw/+KeCb4s1WEyAwtVBtWj/j3n1Sz/OsnU3IiYbfzLHK3WcOJENW\r\nQryRxGzjHRCT/7asL0c2/WH6ILW+nlIyojKIMxMx0sR/b5qEzq46iNmyrocS\r\n3+hLDw2N5UamWjyLMRFSvbN9yApSm653lMm/VdhyeFEdhwx9qUo+hm21Uody\r\ny9KuS9BOHMKf5p/bLIP+vYGH8L6wf9Z3ImGVqFdM9bCPmcCx42EJ4kUpv2Zr\r\nMOyTMcdMjNw0Z7UvidmdtlqjqEmD2IWE73/fuyEg2u5n+D3Ou5UDlizr1dxK\r\nxToY/qAley34uub+9YB2ii78/oXWkikWnzs8osc6TvTqn56eHTTr+cS9WK6O\r\nWZIPjmoz4G1Tb4NhSP393Oo62x/4Na+PORIwW+7fs8x02+GA2/IDGzhB/rMl\r\nYdL9PR/jcdAFDw8e+q3kKw3oKY33AdN3frvxdhsSJv8O4I+alpZnxm+eLeFu\r\ne3rHjzIdgzjz+zvOR0P3QIRnGIH1OBz5LcfBVaSwiJ2wUVTSEvcAE8+NY+M5\r\n7scR3j8eeowZ9i/jpQvDzv+jzAX98Ny8Bh9BHimk+p2gbVdBJUdOMqMZISae\r\nycP9KsUiEBSYJoAvgNqsctIoB0LpVKBKrBORqqCgyjjXFqOyFXinXEVmWpYT\r\njandkHCM7RK6ZT7xhoJhjsLUsRrJ5Ofe9PU=\r\n=yoKE\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","oclif":{"bin":"sf","topics":{"generate":{"subtopics":{"metadata":{"description":"generate metadata files for various Salesforce metadata types"}},"description":"generate local files"}},"commands":"./lib/commands","devPlugins":["@oclif/plugin-help","@oclif/plugin-command-snapshot","@salesforce/plugin-command-reference"],"topicSeparator":" "},"config":{"commitizen":{"path":"cz-conventional-changelog"}},"engines":{"node":">=14.0.0"},"gitHead":"ebc96ea402519b89bbc4838a70f1fda618618630","scripts":{"docs":"sf-docs","lint":"sf-lint","test":"sf-test","build":"sf-build","clean":"sf-clean","format":"sf-format","compile":"sf-compile","prepack":"sf-prepack","prepare":"sf-install","pretest":"sf-compile-test","version":"oclif readme","postpack":"shx rm -f oclif.manifest.json","posttest":"yarn lint && yarn test:deprecation-policy && yarn test:json-schema && yarn test:command-reference","clean-all":"sf-clean all","clean:lib":"shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json","test:nuts":"nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel","test:json-schema":"./bin/dev schema:compare","test:command-reference":"./bin/dev commandreference:generate --erroronwarnings","test:deprecation-policy":"./bin/dev snapshot:compare"},"_npmUser":{"name":"salesforce-releases","email":"alm-cli@salesforce.com"},"repository":{"url":"git+https://github.com/salesforcecli/plugin-schema-generator.git","type":"git"},"_npmVersion":"6.14.17","description":"Create objects, fields, tabs, etc","directories":{},"_nodeVersion":"14.20.0","dependencies":{"tslib":"^2","inquirer":"^8.2.0","fast-glob":"^3.2.11","@oclif/core":"^1.9.5","change-case":"^4.1.2","js2xmlparser":"^4.0.2","@salesforce/kit":"^1.5.42","fast-xml-parser":"^4.0.9","@salesforce/core":"^3.15.1","@salesforce/sf-plugins-core":"^1.13.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^15.1.0","shx":"0.3.4","chai":"^4.3.6","husky":"^7.0.4","mocha":"^9.2.2","oclif":"^2.6.3","sinon":"10.0.0","eslint":"^7.32.0","shelljs":"^0.8.4","ts-node":"^10.8.1","prettier":"^2.6.2","typescript":"^4.7.4","@oclif/test":"^2.1.0","lint-staged":"^11.2.6","pretty-quick":"^3.1.3","@types/shelljs":"^0.8.11","@types/inquirer":"^8.2.0","eslint-plugin-jsdoc":"^35.1.2","@salesforce/ts-sinon":"1.3.21","eslint-plugin-header":"^3.0.0","eslint-plugin-import":"2.26.0","@salesforce/dev-config":"^3.0.1","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^3.4.1","@salesforce/dev-scripts":"^2","eslint-plugin-sf-plugin":"^0.3.0","eslint-config-salesforce":"^0.1.6","@typescript-eslint/parser":"^5.30.6","cz-conventional-changelog":"^3.3.0","@salesforce/prettier-config":"^0.0.2","@oclif/plugin-command-snapshot":"^3.1.3","@salesforce/cli-plugins-testkit":"^2.3.4","@typescript-eslint/eslint-plugin":"^5.30.6","eslint-config-salesforce-license":"^0.1.6","eslint-config-salesforce-typescript":"^0.2.7","@salesforce/plugin-command-reference":"^2.2.8"},"_npmOperationalInternal":{"tmp":"tmp/plugin-schema-generator_0.0.1_1659037885054_0.3060011917752534","host":"s3://npm-registry-packages"}}},"time":{"created":"2022-07-28T19:51:24.988Z","modified":"2026-04-17T10:15:17.184Z","0.0.1":"2022-07-28T19:51:25.203Z"},"bugs":{"url":"https://github.com/forcedotcom/cli/issues"},"author":{"name":"Salesforce"},"license":"BSD-3-Clause","homepage":"https://github.com/salesforcecli/plugin-schema-generator","keywords":["force","salesforce","sfdx","salesforcedx","sfdx-plugin","sf-plugin","sf"],"repository":{"url":"git+https://github.com/salesforcecli/plugin-schema-generator.git","type":"git"},"description":"Create objects, fields, tabs, etc","maintainers":[{"email":"industriesEngineeringDevOps@salesforce.com","name":"ire-npm-team-user"},{"email":"jimjag@gmail.com","name":"jimjag"},{"email":"alm-cli@salesforce.com","name":"salesforce-releases"},{"email":"jschroeder@salesforce.com","name":"jasonschroeder-sfdc"},{"email":"dev@mobify.com","name":"mobify"},{"email":"admin@lwcjs.org","name":"lwc-admin"},{"email":"osscore@salesforce.com","name":"salesforce-admin"}],"readme":"**NOTE: This template for sf plugins is not yet offical. Please consult with the Platform CLI team before using this template.**\n\n# plugin-template-sf\n\n[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-template-sf.svg?label=@salesforce/plugin-template-sf)](https://www.npmjs.com/package/@salesforce/plugin-template-sf) [![CircleCI](https://circleci.com/gh/salesforcecli/plugin-template-sf/tree/main.svg?style=shield)](https://circleci.com/gh/salesforcecli/plugin-template-sf/tree/main) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-template-sf.svg)](https://npmjs.org/package/@salesforce/plugin-template-sf) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-template-sf/main/LICENSE.txt)\n\n## Using the template\n\nThis repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:\n\n1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.\n2. Generate your plugin:\n\n ```\n sf plugins install dev\n sf dev generate plugin\n\n git init -b main\n git add . && git commit -m \"chore: initial commit\"\n ```\n\n3. Create your plugin's repo in the salesforcecli github org\n4. When you're ready, replace the contents of this README with the information you want.\n\n## Learn about `sf` plugins\n\nSalesforce CLI plugins are based on the [oclif plugin framework](<(https://oclif.io/docs/introduction.html)>). Read the [plugin developer guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins_architecture_sf_cli.htm) to learn about Salesforce CLI plugin development.\n\nThis repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the [node developer packages](#tooling) used by Salesforce. There is also a default circleci config using the [release management orb](https://github.com/forcedotcom/npm-release-management-orb) standards.\n\nAdditionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the `posttest` script and it is required to keep these tests active in your plugin if you plan to have it bundled.\n\n### Tooling\n\n- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)\n- [@salesforce/kit](https://github.com/forcedotcom/kit)\n- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)\n- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)\n- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)\n- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)\n- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)\n\n### Hooks\n\nFor cross clouds commands, e.g. `sf env list`, we utilize [oclif hooks](https://oclif.io/docs/hooks) to get the relevant information from installed plugins.\n\nThis plugin includes sample hooks in the [src/hooks directory](src/hooks). You'll just need to add the appropriate logic. You can also delete any of the hooks if they aren't required for your plugin.\n\n# Everything past here is only a suggestion as to what should be in your specific plugin's description\n\nThis plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information on the CLI, read the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm).\n\nWe always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.\n\n## Install\n\n```bash\nsf plugins install @salesforce/plugin-template-sf@x.y.z\n```\n\n## Issues\n\nPlease report any issues at https://github.com/forcedotcom/cli/issues\n\n## Contributing\n\n1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)\n2. Create a new issue before starting your project so that we can keep track of\n what you are trying to add/fix. That way, we can also offer suggestions or\n let you know if there is already an effort in progress.\n3. Fork this repository.\n4. [Build the plugin locally](#build)\n5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.\n6. Edit the code in your fork.\n7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.\n8. Sign CLA (see [CLA](#cla) below).\n9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.\n\n### CLA\n\nExternal contributors will be required to sign a Contributor's License\nAgreement. You can do so by going to https://cla.salesforce.com/sign-cla.\n\n### Build\n\nTo build the plugin locally, make sure to have yarn installed and run the following commands:\n\n```bash\n# Clone the repository\ngit clone git@github.com:salesforcecli/plugin-template-sf\n\n# Install the dependencies and compile\nyarn && yarn build\n```\n\nTo use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.\n\n```bash\n# Run using local run file.\n./bin/dev hello world\n```\n\nThere should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.\n\n```bash\n# Link your plugin to the sf cli\nsf plugins link .\n# To verify\nsf plugins\n```\n\n## Commands\n\n\n\n- [`sf generate metadata field`](#sf-generate-metadata-field)\n- [`sf generate metadata platformevent`](#sf-generate-metadata-platformevent)\n- [`sf generate metadata sobject`](#sf-generate-metadata-sobject)\n- [`sf generate metadata tab`](#sf-generate-metadata-tab)\n\n## `sf generate metadata field`\n\nGenerate local metadata for a custom field on\n\n```\nUSAGE\n $ sf generate metadata field -l [-o ]\n\nFLAGS\n -l, --label= (required) The label of the field.\n -o, --object= The directory of the object folder\n\nDESCRIPTION\n Generate local metadata for a custom field on\n\n Interactively generate local metadata for a custom field. This requires that the custom object you're adding the field\n to be present locally\n\nEXAMPLES\n - Create a field with a given Label (you'll be prompted to choose an object)\n $ sf generate metadata field --label \"My Field\"\n - Specify a local path to the object's folder\n $ sf generate metadata field --label \"My Field\" -o force-app/main/default/objects/MyObj\\_\\_c\n\nFLAG DESCRIPTIONS\n -o, --object= The directory of the object folder\n\n The directory of object you're adding the field to. Include **c if the object is custom. For example,\n `force-app/main/default/objects/MyObj**c`\n\n If not provided, the command will prompt you to choose from your local objects.\n```\n\n## `sf generate metadata platformevent`\n\nGenerate local metadata for a platform event\n\n```\nUSAGE\n $ sf generate metadata platformevent -l \n\nFLAGS\n -l, --label= (required) The label of the event.\n\nDESCRIPTION\n Generate local metadata for a platform event\n\n Interactively generate local metadata for a platform object\n\nEXAMPLES\n - Create an platform event with the given\n\n $ sf generate metadata platformevent --label \"Platform Evt\"\n```\n\n## `sf generate metadata sobject`\n\nGenerate local metadata for a custom object\n\n```\nUSAGE\n $ sf generate metadata sobject -l [-f]\n\nFLAGS\n -f, --use-default-features Enable all optional features without prompting.\n -l, --label= (required) The label of the object.\n\nDESCRIPTION\n Generate local metadata for a custom object\n\n Interactively generate local metadata for a custom object\n\nEXAMPLES\n - Create an object with a given Label and be prompted for additional information\n $ sf generate metadata sobject --label \"My Object\"\n - Create an object and opt in to most defaults (see flag help for details)\n $ sf generate metadata sobject --label \"My Object\" --use-default-features\n\nFLAG DESCRIPTIONS\n -f, --use-default-features Enable all optional features without prompting.\n\n Enables search, feeds, reports, history, activities, bulk API, sharing, and streaming API.\n```\n\n## `sf generate metadata tab`\n\nGenerate a tab for a custom object.\n\n```\nUSAGE\n $ sf generate metadata tab -o -d -i [--json]\n\nFLAGS\n -d, --directory= (required) Path to a `tabs` folder that your new tab will be created in.\n -i, --icon= (required) An icon number from from 1 to\n 100'\n -o, --object= (required) API name of the object to generate a tab for.\n\nGLOBAL FLAGS\n --json Format output as json.\n\nDESCRIPTION\n Generate a tab for a custom object.\n\n Description of a command.\n\nEXAMPLES\n $ sf generate metadata tab -o MyObj\\_\\_c -i 54 -d force-app/main/default/tabs\n\nFLAG DESCRIPTIONS\n -o, --object= API name of the object to generate a tab for.\n\n API name of the object to generate a tab for. Custom objects should end in \\_\\_c. The object need not be present in\n your local source.\n```\n\n\n","readmeFilename":"README.md"}