❤
npm
Sign UpSign In

profile-modifier-plugin

1.0.8 • Public • Published

SFDX profile-modifier-plugin

A plugin for Salesforce DX CLI that provides ability to add, edit, and remove Apex Classes, Visualforce Pages, Objects, and Fields from profiles within SFDX projects (an sfdx-project.json file in the root of the project directory is required).

The motivation for the development of this plugin came from project work frequently requiring these four (4) pieces of metadata to be added to, edited in, and removed from multiple profiles within a project space. Manually editing the profile metadata to accomplish this was time consuming, error prone, and a drag to say the least.

This plugin could be expanded to accommodate other types of profile metadata such as user permissions, tab visibilities and record type accesses.

Setup

Install as plugin (Recommended approach for Installing)

Install plugin using command : sfdx plugins:install profile-modifier-plugin

Commands

sfdx profile:class:add

Adds Apex class to profiles.

USAGE
  $ sfdx profile:class:add

OPTIONS
  -n, --name=classname                  (required) the name of the Apex Class you want to add.

  -p, --profile=profilename             the name of the profile you want to add the class to. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the class will be added to all profiles in the path locations specified in your sfdx-project.json file.

  -e, --enabled                         [default: false] Enable Apex Class
  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:class:add --name MyClass --profile "Admin" --enabled
    $ sfdx profile:class:add --name MyClass --enabled // Adds MyClass to all profiles

See code: src/commands/profile/class/add.ts

sfdx profile:class:delete

Removes Apex class from profiles.

USAGE
  $ sfdx profile:class:delete

OPTIONS
  -n, --name=classname                  (required) the name of the Apex Class you want to remove.

  -p, --profile=profilename             the name of the profile you want to remove the class from. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the class will be removed from all profiles in the path locations specified in your sfdx-project.json file.

  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:class:delete --name MyClass --profile "Admin" --enabled
    $ sfdx profile:class:delete --name MyClass // Removes MyClass from all profiles

See code: src/commands/profile/class/delete.ts

sfdx profile:class:edit

Edits an Apex class in profiles.

USAGE
  $ sfdx profile:class:edit

OPTIONS
  -n, --name=classname                  (required) the name of the Apex Class you want to edit. Only one Apex Class name is allowed.

  -r --rename=renameclassname           the name of the Apex Class you want to rename the class specified in --name to

  -p, --profile=profilename             the name of the profile you want to edit the class in. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the class will be edited in all profiles in the path locations specified in your sfdx-project.json file.

  -e, --enabled                         [default: false] Enable Apex Class
  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:class:edit --name MyClass --rename YourClass --profile "Admin" --enabled',
    $ sfdx profile:class:edit --name MyClass --rename YourClass --enabled // Edits MyClass in all profiles

See code: src/commands/profile/class/edit.ts

sfdx profile:field:add

Adds field to profiles.

USAGE
  $ sfdx profile:field:add

OPTIONS
  -n, --name=fieldname                  (required) the name of the field you want to add. This should be a field name prefixed with the object name and separated by a dot.

  -p, --profile=profilename             the name of the profile you want to add the field to. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the field will be added to all profiles in the path locations specified in your sfdx-project.json file.

  -m, --permissions                     the permissions to assign the field: 'e' for editable and 'r' for readable

  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:field:add --name MyField --profile "Admin" --permissions re'
    $ sfdx profile:field:add --name MyField --permissions re // Adds MyField to all profiles with both editable and readable set to true

See code: src/commands/profile/field/add.ts

sfdx profile:field:delete

Removes Apex class from profiles.

USAGE
  $ sfdx profile:field:delete

OPTIONS
  -n, --name=fieldname                  (required) the name of the field you want to remove.

  -p, --profile=profilename             the name of the profile you want to remove the field from. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the field will be removed from all profiles in the path locations specified in your sfdx-project.json file.

  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:field:delete --name MyObject.MyField --profile "Admin" --enabled
    $ sfdx profile:field:delete --name MyObject.MyField // Removes MyObject.MyField from all profiles

See code: src/commands/profile/field/delete.ts

sfdx profile:field:edit

Edits a field in profiles.

USAGE
  $ sfdx profile:field:edit

OPTIONS
  -n, --name=classname                  (required) the name of the field you want to edit. Only one field name is allowed.

  -r --rename=renamefieldname           the name of the field you want to rename the field specified in --name to

  -p, --profile=profilename             the name of the profile you want to edit the field in. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the field will be edited in all profiles in the path locations specified in your sfdx-project.json file.

  -m, --permissions                     the permissions to assign the field: 'e' for editable and 'r' for readable

  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:field:edit --name MyObject.MyField --rename MyObject.YourField --profile "Admin" --permissions re',
    $ sfdx profile:field:edit --name MyObject.MyField --rename MyObject.YourField --permissions re // Edits MyObject.MyField in all profiles

See code: src/commands/profile/field/edit.ts

sfdx profile:object:add

Adds object to profiles.

USAGE
  $ sfdx profile:object:add

OPTIONS
  -n, --name=objectname                 (required) the name of the object you want to add.

  -p, --profile=profilename             the name of the profile you want to add the object to. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the object will be added to all profiles in the path locations specified in your sfdx-project.json file.

  -m, --permissions                     the permissions to assign the object: 'c' for creatable, 'r' for readable, 'e' for editable, 'd' for deletable, 'm' for allow modify all, and 'v' for allow view all.

  -a, --alphabetize                     [default: false] Alphabetize profile metadata file
  -f, --addfields                       add object fields in addition to object (will not include required fields or master detail fields with read and edit permissions)

EXAMPLES
    $ sfdx profile:object:add --name MyObject --profile "Admin" --permissions credmv
    $ sfdx profile:object:add --name MyObject --permissions credmv

See code: src/commands/profile/object/add.ts

sfdx profile:object:delete

Removes object from profiles.

USAGE
  $ sfdx profile:object:delete

OPTIONS
  -n, --name=objectname                 (required) the name of the object you want to remove.

  -p, --profile=profilename             the name of the profile you want to remove the object from. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the object will be removed from all profiles in the path locations specified in your sfdx-project.json file.

  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:object:delete --name MyObject --profile "Admin" --enabled
    $ sfdx profile:object:delete --name MyObject // Removes MyObject from all profiles

See code: src/commands/profile/object/delete.ts

sfdx profile:object:edit

Edits a object in profiles.

USAGE
  $ sfdx profile:object:edit

OPTIONS
  -n, --name=objectname                 (required) the name of the object you want to edit. Only one object name is allowed.

  -r --rename=renameobjectname          the name of the object you want to rename the object specified in --name to

  -p, --profile=profilename             the name of the profile you want to edit the object in. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the object will be edited in all profiles in the path locations specified in your sfdx-project.json file.

  -m, --permissions                     the permissions to assign the object: 'c' for creatable, 'r' for readable, 'e' for editable, 'd' for deletable, 'm' for allow modify all, and 'v' for allow view all.

  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:object:edit --name MyObject --rename MyObject --profile "Admin" --permissions credmv',
    $ sfdx profile:object:edit --name MyObject --rename MyObject --permissions credmv // Edits MyObject in all profiles

See code: src/commands/profile/object/edit.ts

sfdx profile:page:add

Adds Visualforce Page to profiles.

USAGE
  $ sfdx profile:page:add

OPTIONS
  -n, --name=pagename                   (required) the name of the Visualforce Page you want to add.

  -p, --profile=profilename             the name of the profile you want to add the page to. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the page will be added to all profiles in the path locations specified in your sfdx-project.json file.

  -e, --enabled                         [default: false] Enable Visualforce Page

  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:page:add --name MyPage --profile "Admin" --enabled
    $ sfdx profile:page:add --name MyPage --enabled // Adds MyPage to all profiles

See code: src/commands/profile/page/add.ts

sfdx profile:page:delete

Removes Visualforce Page from profiles.

USAGE
  $ sfdx profile:page:delete

OPTIONS
  -n, --name=pagename                   (required) the name of the Visualforce Page you want to remove.

  -p, --profile=profilename             the name of the profile you want to remove the page from. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the page will be removed from all profiles in the path locations specified in your sfdx-project.json file.

  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:page:delete --name MyPage --profile "Admin" --enabled
    $ sfdx profile:page:delete --name MyPage // Removes MyPage from all profiles

See code: src/commands/profile/page/delete.ts

sfdx profile:page:edit

Edits a Visualforce Page in profiles.

USAGE
  $ sfdx profile:page:edit

OPTIONS
  -n, --name=pagename                   (required) the name of the Visualforce Page you want to edit. Only one Visualforce Page name is allowed.

  -r --rename=renamepagename            the name of the Visualforce Page you want to rename the page specified in --name to

  -p, --profile=profilename             the name of the profile you want to edit the page in. This can be a comma separated list of profile names. Note: if a profile name has a space in the name, the name should be enclosed in quotes. If this flag is not specified, the assumption is that the page will be edited in all profiles in the path locations specified in your sfdx-project.json file.

  -e, --enabled                         [default: false] Enable Visualforce Page

  -a, --alphabetize                     [default: false] Alphabetize profile metadata file

EXAMPLES
    $ sfdx profile:page:edit --name MyPage --rename YourPage --profile "Admin" --enabled',
    $ sfdx profile:page:edit --name MyPage --rename YourPage --enabled // Edits MyPage in all profiles

See code: src/commands/profile/page/edit.ts

Readme

Keywords

Package Sidebar

Install

npm i profile-modifier-plugin

Repository

github.com/seanrussell/profile-modifier-plugin

Homepage

github.com/seanrussell/profile-modifier-plugin

Weekly Downloads

10

Version

1.0.8

License

MIT

Unpacked Size

210 kB

Total Files

94

Last publish

Collaborators

  • seanrussell
Try on RunKit
Report malware