sfignore

sfdx-sfignore-plugin

Plugin to add entries to forceignore, to save folk remembering the syntax.

Currently supported;

• Remote meta
• Subset of metadata types - being added as I come across them.

If you want a metadatatype added please raise an issue.

Known issues

• Ignoring CustomField can only be done at an object-side level. Belief is that this is a limitation with the SFDX cli
• Ignoring RecordTpe can only be done at an object-side level. Belief is that this is a limitation with the SFDX cli
• Ignoring of custom metadata appears to have a global affect - so it's left out deliberately for the time being

Installation & Usage

$ npm install -g sfignore
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
sfignore/0.0.1 linux-x64 node-v8.11.4
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx

sfdx

Add an entry to your .forceignore file

USAGE
  $ sfdx sfignore:add [FILE]

OPTIONS
  -m, 
  --metadatatype=ApexClass|AppMenu|AuraDefinitionBundle|CustomObject|EmailTemplate|FlexiPage|Layout|LightningComponentBu
  ndle|NavigationMenu|Network|Portal|Profile|Role|SiteDotCom|StaticResource
      (required) metadata type

  -n, --name=name
      (required) name of entry

  -r, --remote
      Remote

  --json
      format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
      [default: warn] logging level for this command invocation

EXAMPLES
  $ sfdx sfignore:add -n MyRole -t Role -r
     Inserted into .forceignore: 'MyRole.role'
  
  $ sfdx sfignore:add -n "Custom: Sales Profile" -t Profile -r
     Inserted into .forceignore: 'Custom%3A Sales Profile.profile'

See code: lib/commands/sfignore/add.js

Roadmap

• Support for local file ignoring
• widcarding/directories
• vsCode support