Skip to content

catalandres/plugin-atlas

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ea32c0f · Jan 6, 2024

History

32 Commits
Dec 18, 2023
Dec 18, 2023
Dec 18, 2023
Dec 18, 2023
Jan 6, 2024
Jan 6, 2024
Jan 6, 2024
Dec 18, 2023
Dec 18, 2023
Dec 18, 2023
Dec 18, 2023
Dec 18, 2023
Dec 18, 2023
Dec 24, 2023
Dec 18, 2023
Dec 18, 2023
Jan 3, 2024
Dec 18, 2023
Jan 6, 2024
Jan 6, 2024
Jan 6, 2024

Repository files navigation

Atlas

NPM Downloads/week License

Vision

Atlas is a one-stop shop documentation toolkit for your Salesforce project. It uses all the information stored in your Salesforce metadata files and outputs all that information in a structured, user-readable form, in multiple formats.

How to install

  1. Install Node in your system. In case of doubt, go with the LTS installation.

  2. Install the Salesforce CLI using npm:

    npm install --global @salesforce/cli
  3. Install Atlas as a Salesforce CLI plugin:

    sf plugins install plugin-atlas

How to update

  1. Update the Salesforce CLI. It is the same command as installing it from scratch:

    npm install --global @salesforce/cli
  2. Update all the Salesforce CLI plugins:

    sf plugins update

If the update fails, you can uninstall the plugin with sf plugins uninstall plugin-atlas and then reinstall it.

Features

Currently supported output format:

  • Excel spreadsheet (xlsx), with each metadata type (objects, fields, list views, etc) in separate tabs.

Currently supported metadata types:

  • Objects
  • Fields
  • Record types
  • Fieldsets
  • Layouts
  • List views
  • Compact layouts
  • Tabs
  • Quick actions
  • Validation rules
  • Weblinks
  • Flexipages (Lightning pages)
  • Apex classes and triggers
  • Visualforce pages and components
  • Aura components
  • Lightning web components
  • Flows
  • Workflow rules
  • Profiles
  • Roles
  • Permission Sets
  • Permission Set Groups
  • User Access Policies

Roadmap

Features

  • Additional output formats:
    • Multiple spreadsheets
    • Multiple CSV files
    • Markdown websites
    • HTML websites
  • Enhance existing functionality:
    • Increase the number of metadata types included in the output
    • Make more information available for existing types
    • Quality of life improvements:
      • Choose the target file name and location
      • Select which metadata types should be included

Maintenance and internal

  • Increase test coverage
  • Set up an automated release pipeline
  • Continue to maintain



Commands

sf doc generate atlas

Generate documentation from the contents of your local project.

USAGE
  $ sf doc generate atlas [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Generate documentation from the contents of your local project.

  You must run this command from within a project.
  Note that the default behavior is to create an XLSX spreadsheet with a sheet for each supported metadata type. This
  will change in an upcoming release.

EXAMPLES
  $ sf doc generate atlas

About

A one-stop shop documentation toolkit for your Salesforce project.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published