Skip to content

Commit

Permalink
Update README, CCI, prettier files; rename files and fields (#36)
Browse files Browse the repository at this point in the history
* Update README - Redo sections, update documentation link directory (SSSFDG to sticky-selectron-documentation), and remove last section “Salesforce DX Project: Next Steps” that was from default file in VSCode

* Rename files and fields - Update some file and field names according to Salesforce Quip doc, e.g., FieldLabelControllerTest.cls to FieldLabelController_Test.cls (add hyphen), fieldApiName vs fieldAPIName (make consistent)

* Modify cumulusci.yml - Update documentation link directory name from SSSFDG to sticky-selectron-documentation

* .prettierignore - Restore to previous config based on dreamhouse-lwc

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
kalena and github-actions[bot] authored Jun 13, 2024
1 parent 295fe4e commit 814a1fd
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 36 deletions.
4 changes: 1 addition & 3 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,4 @@
.sfdx/
.vscode/
coverage/
.github/
jsconfig.json
package-lock.json
jsconfig.json
37 changes: 11 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,22 @@

Sticky Selectron is a Data Table Lightning Web Component for easy record selection in a screen flow that will persist (or remain “sticky”) across flow screens.

For project information, install instructions, and documentation, please visit our [wiki](https://github.com/SFDO-Community/sticky-selectron/wiki).
## Documentation

## Questions and Community Support

The Sticky Selectron project is a community-built and community-maintained Salesforce solution and a proud member of the [Salesforce.org Open Source Commons Program](https://www.salesforce.org/resources/commons/). Please join the [Commons Project: Sticky Selectron Group](https://trailhead.salesforce.com/trailblazer-community/groups/0F94S000000HDS7SAO?tab=discussion&sort=LAST_MODIFIED_DATE_DESC) in the Trailblazer Community to ask questions, share your experiences, and help others!

If you have a feature request or bug report, you can [submit an issue](https://github.com/SFDO-Community/sticky-selectron/issues) on our GitHub repository.

## CCI Development
For more information on the project's installation instructions and documentation, please visit our [documentation website](https://sfdo-community-sprints.github.io/sticky-selectron-documentation/).

To work on this project in a scratch org using CumulusCI:
## Installation

1. [Set up CumulusCI](https://cumulusci.readthedocs.io/en/latest/get-started.html)
2. Run `cci flow run dev_org --org dev` to deploy this project.
3. Run `cci org browser dev` to open the org in your browser.
- [Sandbox & Scratch Orgs (Latest Release)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t6g000007zMhqAAE)
- [Production & Developer Edition Orgs (Latest Release)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t6g000007zMhqAAE)
- [Current and past releases](https://github.com/SFDO-Community/sticky-selectron/releases)

## Salesforce DX Project: Next Steps

Now that you’ve created a Salesforce DX project, what’s next? Here are some documentation resources to get you started.

### How Do You Plan to Deploy Your Changes?

Do you want to deploy a set of changes, or create a self-contained application? Choose a [development model](https://developer.salesforce.com/tools/vscode/en/sf-dev-models/development-models).
## Questions and Community Support

### Configure Your Salesforce DX Project
The Sticky Selectron project is a community-built and community-maintained Salesforce solution and a proud member of the [Salesforce.org Open Source Commons Program](https://www.salesforce.org/resources/commons/). Please join the [Commons Project: Sticky Selectron Group](https://trailhead.salesforce.com/trailblazer-community/groups/0F94S000000HDS7SAO?tab=discussion&sort=LAST_MODIFIED_DATE_DESC) in the Trailblazer Community to ask questions, share your experiences, and help others!

The `sfdx-project.json` file contains useful configuration information for your project. See [Salesforce DX Project Configuration](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm) in the _Salesforce DX Developer Guide_ for details about this file.
If you have a feature request or bug report, you can [submit an issue](https://github.com/SFDO-Community/sticky-selectron/issues) on our GitHub repository.

### Read All About It
## License

- [Salesforce Extensions Documentation](https://developer.salesforce.com/tools/vscode)
- [Salesforce CLI Setup Guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm)
- [Salesforce DX Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_intro.htm)
- [Salesforce CLI Command Reference](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_top.htm)
Distributed under the [BSD 3-Clause License](https://github.com/SFDO-Community/sticky-selectron/blob/main/LICENSE).
8 changes: 4 additions & 4 deletions cumulusci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ plans:
slug: install
title: Install Sticky Selectron
tier: primary
preflight_message: "This will install Sticky Selectron (slctrn) in your org."
post_install_message: "Thanks for installing Sticky Selectron (slctrn)."
error_message: "To get help, please visit our [Sticky Selectron Documentation](https://sfdo-community-sprints.github.io/SSSFDG/)"
preflight_message: 'This will install Sticky Selectron (slctrn) in your org.'
post_install_message: 'Thanks for installing Sticky Selectron (slctrn).'
error_message: 'To get help, please visit our [Sticky Selectron documentation website](https://sfdo-community-sprints.github.io/sticky-selectron-documentation/).'
steps:
1:
flow: customer_org
Expand All @@ -70,4 +70,4 @@ orgs:
scratch:
dev_long:
config_file: orgs/dev.json
days: 30
days: 30
4 changes: 2 additions & 2 deletions force-app/main/default/classes/FieldLabelController.cls
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ public with sharing class FieldLabelController {
@AuraEnabled(cacheable=true)
public static String getFieldLabels(
String objectName,
String fieldAPIName
String fieldApiName
) {
String label = null;
try {
Expand All @@ -11,7 +11,7 @@ public with sharing class FieldLabelController {
.get(objectName)
.getDescribe()
.fields.getMap();
label = fieldMap.get(fieldAPIName).getDescribe().getLabel();
label = fieldMap.get(fieldApiName).getDescribe().getLabel();
} catch (Exception e) {
throw new AuraHandledException(e.getMessage());
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
@isTest
public class FieldLabelControllerTest {
public class FieldLabelController_Test {
@isTest
static void labelTest() {
String fieldApiName = 'CreatedDate';
Expand Down

0 comments on commit 814a1fd

Please sign in to comment.