Skip to content

Commit 293bec3

Browse files
authored
New unlocked packages (with and without namespace) (#39)
* Simplified directory structury within nebula-query-and-search directory * Created 2 unlocked packages (no namespace and Nebula namespace) * Added package.json, added or updated several other project config files (.forceignore, .gitignore, .prettierrc, etc) * Bumped all Apex classes to API v57.0 (Spring '23) * Added @SuppressWarnings tests in Apex classes (several will eventually be removed after refactoring) and added missing curly braces prior to running prettier * Ran prettier on the whole repo * Changed casing of class names from Soql & Sosl to SOQL & SOSL * Added ApexDocs comments to the top of each class + added precommit hook & npm script & dependencies for generating docs markdown * Added Apex test suite, cleaned up test classes and added a few more test methods * Updated most classes, enums, and methods from public to global, updated doc-generation to only include items marked as global * Added Apex script with some sample queries
1 parent 9b15609 commit 293bec3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+71477
-2240
lines changed

.forceignore

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44

55
package.xml
66

7-
# LWC configuration files
8-
**/jsconfig.json
9-
**/.eslintrc.json
7+
# Project repo files
8+
**.md
109

11-
# LWC Jest
12-
**/__tests__/**
10+
# Metadata
11+
**.profile-meta.xml

.gitattributes

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Set the default line return behavior, in case people don't have core.autocrlf set.
2+
* text=auto eol=lf
3+
4+
# Common git file types
5+
.gitattributes text eol=lf
6+
.gitignore text eol=lf
7+
*.md text eol=lf
8+
9+
# Salesforce-specfic file types
10+
*.app text eol=lf
11+
*.cls text eol=lf
12+
*.cmp text eol=lf
13+
*.component text eol=lf
14+
*.css text eol=lf
15+
*.html text eol=lf
16+
*.js text eol=lf
17+
*.page text eol=lf
18+
*.trigger text eol=lf
19+
*.xml text eol=lf
Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
name: Fetch Repo Stats
22

33
on:
4-
schedule:
5-
# Run this once per day, towards the end of the day for keeping the most
6-
# recent data point most meaningful (hours are interpreted in UTC).
7-
- cron: '0 23 * * *'
8-
workflow_dispatch: # Allow for running this manually.
4+
schedule:
5+
# Run this once per day, towards the end of the day for keeping the most
6+
# recent data point most meaningful (hours are interpreted in UTC).
7+
- cron: '0 23 * * *'
8+
workflow_dispatch: # Allow for running this manually.
99

1010
jobs:
11-
j1:
12-
name: store-repo-stats
13-
runs-on: ubuntu-latest
14-
steps:
15-
- name: run-ghrs
16-
uses: jgehrcke/github-repo-stats@RELEASE
17-
with:
18-
ghtoken: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
11+
j1:
12+
name: store-repo-stats
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: run-ghrs
16+
uses: jgehrcke/github-repo-stats@RELEASE
17+
with:
18+
ghtoken: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}

.gitignore

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,41 @@
1-
# Folders to exclude
2-
.settings/
1+
# This file is used for Git repositories to specify intentionally untracked files that Git should ignore.
2+
# If you are not using git, you can delete this file. For more information see: https://git-scm.com/docs/gitignore
3+
# For useful gitignore templates see: https://github.com/github/gitignore
4+
5+
# Salesforce cache
6+
.sf/
37
.sfdx/
8+
.localdevserver/
49
.vscode/
5-
*/main/default/
10+
deploy-options.json
11+
12+
# LWC VSCode autocomplete
13+
**/lwc/jsconfig.json
614

7-
# Files to exclude
15+
# Code coverage reports
16+
test-coverage/
17+
18+
# Logs
19+
logs
820
*.log
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*
24+
25+
# Dependency directories
26+
node_modules/
27+
28+
# Eslint cache
29+
.eslintcache
30+
31+
# MacOS system files
32+
.DS_Store
33+
34+
# Windows system files
35+
Thumbs.db
36+
ehthumbs.db
37+
[Dd]esktop.ini
38+
$RECYCLE.BIN/
939

40+
# Local environment variables
41+
.env

.husky/_/husky.sh

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
#!/bin/sh
2+
if [ -z "$husky_skip_init" ]; then
3+
debug () {
4+
if [ "$HUSKY_DEBUG" = "1" ]; then
5+
echo "husky (debug) - $1"
6+
fi
7+
}
8+
9+
readonly hook_name="$(basename "$0")"
10+
debug "starting $hook_name..."
11+
12+
if [ "$HUSKY" = "0" ]; then
13+
debug "HUSKY env variable is set to 0, skipping hook"
14+
exit 0
15+
fi
16+
17+
if [ -f ~/.huskyrc ]; then
18+
debug "sourcing ~/.huskyrc"
19+
. ~/.huskyrc
20+
fi
21+
22+
export readonly husky_skip_init=1
23+
sh -e "$0" "$@"
24+
exitCode="$?"
25+
26+
if [ $exitCode != 0 ]; then
27+
echo "husky - $hook_name hook exited with code $exitCode (error)"
28+
fi
29+
30+
exit $exitCode
31+
fi

.husky/pre-commit

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
npm run precommit

.prettierignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# List files or directories below to ignore them when running prettier
2+
# More information: https://prettier.io/docs/en/ignore.html
3+
#
4+
5+
**/staticresources/**
6+
.localdevserver/
7+
.sf/
8+
.sfdx/
9+
.husky/
10+
node_modules/
11+
test-coverage/

.prettierrc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"arrowParens": "avoid",
3+
"printWidth": 160,
4+
"singleQuote": true,
5+
"tabWidth": 2,
6+
"trailingComma": "none"
7+
}

.travis.yml

Lines changed: 0 additions & 27 deletions
This file was deleted.

CODE_OF_CONDUCT.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement.
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series
85+
of actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or
92+
permanent ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.0, available at
118+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
120+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121+
enforcement ladder](https://github.com/mozilla/diversity).
122+
123+
[homepage]: https://www.contributor-covenant.org
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
https://www.contributor-covenant.org/faq. Translations are available at
127+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)