Ignore File - JJLongoria/aura-helper GitHub Wiki

Ignore File

The ignore file is a JSON file used by some commands. On this file you can specify metadata types, objects and elements for ignore or delete from your local project, package files or ignore when check or repair dependencies.

The ignore file have the next structure

{
    // Basic structure
    "MetadataTypeAPIName": {
        "MetadataObject1",
        "MetadataObject2"
    }

    // Advance Structure
    "MetadataTypeAPIName": {
        "MetadataObject1:MetadataItem1",
        "MetadataObject1:MetadataItem2",
        "MetadataObject2:*",
        "*",
        "*:*" // Only valid on Custom Objects
    }

    // Special for Permissions
    "MetadataTypeAPIName": {
        "UserPermission:MetadataObject1:PermissionName",
        "UserPermission:MetadataObject2:*",
        "UserPermission:*:PermissionName"
    }
}

Example:

{
    "CustomLabels": {
        "labelName1",                   // Ignore or remove the custom label "labelName1"
        "labelName2",                   // Ignore or remove the custom label "labelName2",
        "*"                             // Ignore or remove all Custom Labels
    },
    "AssignmentRules":{
        "Case:Assign1",                 // Ignore or remove the Assignent Rule "Assign1" from the object Case
        "Lead:*",                       // Ignore or remove all Assignment Rules from Lead
        "*"                             // Ignore or remove all Assignment Rules
    },
    "CustomObject": {
        "Account",                      // Ignore or remove the Account Object
        "Case:*",                       // Ignore or remove all related objects from case, including the object (Bussines Process, Fields, Validation Rules...),
        "*",                            // Ignore or remove all custom objects (only the object not the related metadata)
        "*:*",                          // Ignore or remove all custom objects and the related metadata (Bussines Process, Fields, Validation Rules...)
    },
    "Report": {
        "ReportFolder",                 // Ignore or remove the entire folder
        "ReportFolder1:ReportName2",    // Ignore or remove the report "ReportName2" from "ReportFolder1" folder.
        "*",                            // Ignore or remove all reports.
    },
    "Workflow": {
        "Account",                      // Ignore or remove the Account worflows (Rules, Task, Alerts...)
        "*"                             // Ignore or  remove all workflows (Rules, Task, Alerts...) from all objects 
    },
    "WorkflowRule": {
        "Case:*",                       // Ignore or remove all Workflow rules from case object
        "Account:Rule1",                // Ignore or remove "Rule1" from Account workflows,
        "*"                             // Ignore or remove all Worflow rules from all objects
    },
    "Profile": {
        "UserPermission:*:Permission1", // Remove the "Permission1" User Permission from all profiles
        "UserPermission:TestProfile:*", // Remove all User permissions from TestProfile file
        "UserPermission:Admin:Perm1",   // Remove the Perm1 User Permission from Admin profile
        "TestProfile2",                 // Ignore or remove  the "TestProfile" profile 
        "*"                             // Ignore or remove all profiles
    }
}
⚠️ **GitHub.com Fallback** ⚠️