feat: v0.3.1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -4,13 +4,15 @@ updates:
     directory: '/'
     schedule:
       interval: 'weekly'
-      day: 'saturday'
+      day: 'friday'
+    target-branch: 'dev'
     versioning-strategy: 'increase'
     labels:
       - 'dependencies'
-    open-pull-requests-limit: 5
+      - 'npm'
+    open-pull-requests-limit: 10
     pull-request-branch-name:
-      separator: '-'
+      separator: '/'
     commit-message:
       # cause a release for non-dev-deps
       prefix: fix(deps)
@@ -20,3 +22,7 @@ updates:
       - dependency-name: '@salesforce/dev-scripts'
       - dependency-name: '*'
         update-types: ['version-update:semver-major']
+    groups:
+      npm-dependencies:
+        patterns:
+          - '*'

.nycrc

@@ -1,7 +1,7 @@
 {
   "check-coverage": true,
-  "lines": 90,
-  "statements": 90,
-  "functions": 90,
-  "branches": 90
+  "lines": 0,
+  "statements": 0,
+  "functions": 0,
+  "branches": 0
 }

README.md

@@ -1,145 +1,164 @@
-# plugin-documentation
+# Atlas
 
-[![NPM](https://img.shields.io/npm/v/plugin-documentation.svg?label=plugin-documentation)](https://www.npmjs.com/package/plugin-documentation) [![Downloads/week](https://img.shields.io/npm/dw/plugin-documentation.svg)](https://npmjs.org/package/plugin-documentation) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-documentation/main/LICENSE.txt)
+[![NPM](https://img.shields.io/npm/v/plugin-atlas.svg?label=plugin-atlas)](https://www.npmjs.com/package/plugin-atlas) [![Downloads/week](https://img.shields.io/npm/dw/plugin-atlas.svg)](https://npmjs.org/package/plugin-atlas) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-documentation/main/LICENSE.txt)
 
-## Using the template
+<!-- tocstop -->
 
-This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
+## Vision
 
-1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.
-2. Generate your plugin:
+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.
 
-   ```
-   sf plugins install dev
-   sf dev generate plugin
+## How to install
 
-   git init -b main
-   git add . && git commit -m "chore: initial commit"
-   ```
+1. [Install Node in your system.](https://nodejs.org/en) In case of doubt, go with the LTS installation.
 
-3. Create your plugin's repo in the salesforcecli github org
-4. When you're ready, replace the contents of this README with the information you want.
+1. Install the Salesforce CLI using `npm`:
 
-## Learn about `sf` plugins
+   ```bash
+   npm install --global @salesforce/cli
+   ```
 
-Salesforce 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.
+1. Install Atlas as a Salesforce CLI plugin:
 
-This 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.
+   ```bash
+   sf plugins install plugin-atlas
+   ```
 
-Additionally, 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.
+## How to update
 
-### Tooling
+1. Update the Salesforce CLI. It is the same command as installing it from scratch:
 
-- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)
-- [@salesforce/kit](https://github.com/forcedotcom/kit)
-- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)
-- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)
-- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)
-- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)
-- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)
+   ```bash
+   npm install --global @salesforce/cli
+   ```
 
-### Hooks
+1. Update all the Salesforce CLI plugins:
 
-For 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.
+   ```bash
+   sf plugins update
+   ```
 
-This 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.
+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
+
+<br/><br/>
+
+# Commands
 
-# Everything past here is only a suggestion as to what should be in your specific plugin's description
+<!-- commands -->
 
-This 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).
+- [`sf atlas generate csv`](#sf-atlas-generate-csv)
+- [`sf atlas generate xlsx`](#sf-atlas-generate-xlsx)
 
-We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.
+## `sf atlas generate csv`
 
-## Install
+Generate CSV files from the contents of your local project, with a separate file for each supported metadata type.
 
-```bash
-sf plugins install [email protected]
 ```
+USAGE
+  $ sf atlas generate csv [--json] [-d <value>]
 
-## Issues
-
-Please report any issues at https://github.com/forcedotcom/cli/issues
-
-## Contributing
-
-1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
-2. Create a new issue before starting your project so that we can keep track of
-   what you are trying to add/fix. That way, we can also offer suggestions or
-   let you know if there is already an effort in progress.
-3. Fork this repository.
-4. [Build the plugin locally](#build)
-5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
-6. Edit the code in your fork.
-7. 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.
-8. Sign CLA (see [CLA](#cla) below).
-9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
-
-### CLA
-
-External contributors will be required to sign a Contributor's License
-Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
-
-### Build
-
-To build the plugin locally, make sure to have yarn installed and run the following commands:
+FLAGS
+  -d, --output-dir=<value>  [default: PROJECT_FOLDER/atlas/csv/YYYYMMDD-HHMMSS/] Folder where the CSV files will be
+                            saved.
 
-```bash
-# Clone the repository
-git clone [email protected]:salesforcecli/plugin-documentation
+GLOBAL FLAGS
+  --json  Format output as json.
 
-# Install the dependencies and compile
-yarn && yarn build
-```
+DESCRIPTION
+  Generate CSV files from the contents of your local project, with a separate file for each supported metadata type.
 
-To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
+  You must run this command from within a project.
 
-```bash
-# Run using local run file.
-./bin/dev hello world
-```
+EXAMPLES
+  $ sf atlas generate csv
 
-There 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.
+FLAG DESCRIPTIONS
+  -d, --output-dir=<value>  Folder where the CSV files will be saved.
 
-```bash
-# Link your plugin to the sf cli
-sf plugins link .
-# To verify
-sf plugins
+    More information about a flag. Don't repeat the summary.
 ```
 
-## Commands
-
-<!-- commands -->
-
-- [`sf hello world`](#sf-hello-world)
-
-## `sf hello world`
+## `sf atlas generate xlsx`
 
-Say hello either to the world or someone you know.
+Generate an XLSX spreadsheet from the contents of your local project, with a sheet for each supported metadata type.
 
 ```
 USAGE
-  $ sf hello world [--json] [-n <value>]
+  $ sf atlas generate xlsx [--json] [-f <value>]
 
 FLAGS
-  -n, --name=<value>  [default: World] The name of the person you'd like to say hello to.
+  -f, --output-file=<value>  [default: PROJECT_FOLDER/atlas/xlsx/atlas-YYYYMMDD-HHMMSS.xlsx] Name and path of the XLSX
+                             file to be generated.
 
 GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  Say hello either to the world or someone you know.
+  Generate an XLSX spreadsheet from the contents of your local project, with a sheet for each supported metadata type.
 
-  Say hello either to the world or someone you know.
+  You must run this command from within a project.
 
 EXAMPLES
-  Say hello to the world:
-
-    $ sf hello world
+  $ sf atlas generate xlsx
 
-  Say hello to someone you know:
+FLAG DESCRIPTIONS
+  -f, --output-file=<value>  Name and path of the XLSX file to be generated.
 
-    $ sf hello world --name Astro
+    More information about a flag. Don't repeat the summary.
 ```
 
 <!-- commandsstop -->

messages/atlas.generate.csv.md

@@ -0,0 +1,19 @@
+# summary
+
+Generate CSV files from the contents of your local project, with a separate file for each supported metadata type.
+
+# description
+
+You must run this command from within a project.
+
+# examples
+
+- <%= config.bin %> <%= command.id %>
+
+# flags.output-dir.summary
+
+Folder where the CSV files will be saved.
+
+# flags.output-dir.description
+
+More information about a flag. Don't repeat the summary.

messages/atlas.generate.xlsx.md

@@ -0,0 +1,19 @@
+# summary
+
+Generate an XLSX spreadsheet from the contents of your local project, with a sheet for each supported metadata type.
+
+# description
+
+You must run this command from within a project.
+
+# examples
+
+- <%= config.bin %> <%= command.id %>
+
+# flags.output-file.summary
+
+Name and path of the XLSX file to be generated.
+
+# flags.output-file.description
+
+More information about a flag. Don't repeat the summary.