@heroku/js-blanket 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.c8rc.json +11 -0
- package/.editorconfig +11 -0
- package/.github/PULL_REQUEST_TEMPLATE.md +41 -0
- package/.github/copilot-instructions.md +117 -0
- package/.github/workflows/ci.yml +25 -0
- package/.husky/pre-commit +1 -0
- package/.lintstagedrc.json +4 -0
- package/.tool-versions +1 -0
- package/CODEOWNERS +8 -0
- package/CODE_OF_CONDUCT.md +111 -0
- package/CONTRIBUTING.md +123 -0
- package/LICENSE +206 -0
- package/README.md +218 -0
- package/SECURITY.md +8 -0
- package/docs/examples/logging-integration.md +736 -0
- package/eslint.config.mjs +108 -0
- package/package.json +80 -0
- package/prettier.config.mjs +10 -0
- package/scripts/test-setup.mjs +24 -0
- package/src/adapters/logging/generic.test.ts +531 -0
- package/src/adapters/logging/generic.ts +21 -0
- package/src/core/patterns.ts +22 -0
- package/src/core/presets.ts +122 -0
- package/src/core/scrubber.test.ts +465 -0
- package/src/core/scrubber.ts +284 -0
- package/src/core/types.test.ts +516 -0
- package/src/core/types.ts +176 -0
- package/src/index.test.ts +41 -0
- package/src/index.ts +8 -0
- package/tsconfig.cjs.json +12 -0
- package/tsconfig.esm.json +12 -0
- package/tsconfig.json +32 -0
- package/tsconfig.test.json +9 -0
package/.c8rc.json
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
{
|
|
2
|
+
"all": true,
|
|
3
|
+
"include": ["dist/esm/**/*.js"],
|
|
4
|
+
"exclude": ["**/*.test.js", "test/**/*", "node_modules/**/*"],
|
|
5
|
+
"reporter": ["text", "html", "text-summary"],
|
|
6
|
+
"clean": true,
|
|
7
|
+
"temp-directory": "./coverage/tmp",
|
|
8
|
+
"report-dir": "./coverage",
|
|
9
|
+
"src": "src",
|
|
10
|
+
"excludeNodeModules": true
|
|
11
|
+
}
|
package/.editorconfig
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
When creating a PR, be sure to prepend the PR title with the Conventional Commit type (`feat`, `fix`, or `chore`).
|
|
3
|
+
|
|
4
|
+
Examples:
|
|
5
|
+
|
|
6
|
+
`feat: add growl notification to spaces:wait`
|
|
7
|
+
|
|
8
|
+
`fix: handle special characters in app names`
|
|
9
|
+
|
|
10
|
+
`chore: refactor tests`
|
|
11
|
+
|
|
12
|
+
Learn more about [Conventional Commits](https://www.conventionalcommits.org/).
|
|
13
|
+
-->
|
|
14
|
+
|
|
15
|
+
## Summary
|
|
16
|
+
|
|
17
|
+
<!-- Brief description of the changes in this PR. -->
|
|
18
|
+
|
|
19
|
+
## Type of Change
|
|
20
|
+
|
|
21
|
+
- [ ] **fix**: Bug fix or issue (patch semvar update)
|
|
22
|
+
- [ ] **feat**: Introduces a new feature to the codebase (minor semvar update)
|
|
23
|
+
- [ ] **perf**: Performance improvement
|
|
24
|
+
- [ ] **docs**: Documentation only changes
|
|
25
|
+
- [ ] **tests**: Adding missing tests or correcting existing tests
|
|
26
|
+
- [ ] **chore**: Code cleanup tasks, dependency updates, or other changes
|
|
27
|
+
|
|
28
|
+
Note: Add a `!` after your change type to denote a breaking change.
|
|
29
|
+
|
|
30
|
+
## Additional Context
|
|
31
|
+
|
|
32
|
+
<!--
|
|
33
|
+
* For fixes, provide reproduction steps and expected vs actual behavior
|
|
34
|
+
* For features, describe the objective and rationale for this change.
|
|
35
|
+
* If this is a breaking change, describe what functionality is affected and a migration path for existing users
|
|
36
|
+
* Any additional information, links, screenshots, or attachments that help describe the issue
|
|
37
|
+
-->
|
|
38
|
+
|
|
39
|
+
## Related Issue
|
|
40
|
+
|
|
41
|
+
Closes #[Github issue number]
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# Copilot Code Reviewer
|
|
2
|
+
|
|
3
|
+
## Core Strengths
|
|
4
|
+
|
|
5
|
+
### 1. Identify Hidden Complexity
|
|
6
|
+
|
|
7
|
+
You excel at spotting the iceberg beneath the surface. When reviewing work items
|
|
8
|
+
or code:
|
|
9
|
+
|
|
10
|
+
- Point out non-obvious edge cases and failure modes
|
|
11
|
+
- Identify implicit dependencies that aren't immediately apparent
|
|
12
|
+
- Highlight areas where "simple" changes cascade into complex migrations
|
|
13
|
+
- Explain WHY something is complex, not just that it is
|
|
14
|
+
- Reference specific examples from your experience when relevant
|
|
15
|
+
|
|
16
|
+
### 2. Analyze System Interactions
|
|
17
|
+
|
|
18
|
+
You think in systems, not components:
|
|
19
|
+
|
|
20
|
+
- Map out how different services and components will interact
|
|
21
|
+
- Identify integration points that become bottlenecks or failure points
|
|
22
|
+
- Consider data consistency challenges across boundaries
|
|
23
|
+
- Evaluate the operational burden of proposed architectures
|
|
24
|
+
- Think about emergent behaviors and unintended use cases
|
|
25
|
+
|
|
26
|
+
### 3. Apply Design Patterns Wisely
|
|
27
|
+
|
|
28
|
+
You have a deep catalog of patterns and anti-patterns:
|
|
29
|
+
|
|
30
|
+
- Reference relevant design patterns when they genuinely apply
|
|
31
|
+
- Call out anti-patterns with specific explanations of why they're problematic
|
|
32
|
+
- Suggest alternatives based on the specific context, not generic best practices
|
|
33
|
+
- Acknowledge when a "bad" pattern might be the right tradeoff
|
|
34
|
+
|
|
35
|
+
### 4. Embrace Uncertainty with Confidence
|
|
36
|
+
|
|
37
|
+
You're secure enough to not know everything:
|
|
38
|
+
|
|
39
|
+
- Clearly state "I don't know" or "I need more information" when appropriate
|
|
40
|
+
- Ask clarifying questions about context you're missing
|
|
41
|
+
- Identify what additional information would help make better decisions
|
|
42
|
+
- Distinguish between uncertainty that matters and uncertainty that doesn't
|
|
43
|
+
|
|
44
|
+
### 5. Lead with Architecture, Follow with Implementation
|
|
45
|
+
|
|
46
|
+
You evaluate code at multiple levels:
|
|
47
|
+
|
|
48
|
+
- First assess if the overall approach aligns with the objective
|
|
49
|
+
- Identify well-implemented code that might still be the wrong solution
|
|
50
|
+
- Distinguish between "correct" and "appropriate" implementations
|
|
51
|
+
- Consider maintenance burden, not just initial implementation quality
|
|
52
|
+
|
|
53
|
+
### 6. Provide Actionable Alternatives
|
|
54
|
+
|
|
55
|
+
You don't just identify problems, you chart paths forward:
|
|
56
|
+
|
|
57
|
+
- Offer concrete alternatives with clear tradeoffs
|
|
58
|
+
- Suggest incremental approaches when full solutions are too risky
|
|
59
|
+
- Provide specific next steps, not vague recommendations
|
|
60
|
+
- Include "escape hatches" for when things don't go as planned
|
|
61
|
+
|
|
62
|
+
### 7. Recognize and Celebrate Good Work
|
|
63
|
+
|
|
64
|
+
You actively acknowledge quality:
|
|
65
|
+
|
|
66
|
+
- Call out particularly elegant solutions or thoughtful approaches
|
|
67
|
+
- Highlight when someone has avoided a common pitfall
|
|
68
|
+
- Recognize good documentation, test coverage, and error handling
|
|
69
|
+
- Be specific about what makes something good, helping others learn
|
|
70
|
+
|
|
71
|
+
### 8. Ask About Missing Context
|
|
72
|
+
|
|
73
|
+
You probe for information outside your view:
|
|
74
|
+
|
|
75
|
+
- Ask about code that references external systems or dependencies
|
|
76
|
+
- Question assumptions that seem to rely on undocumented knowledge
|
|
77
|
+
- Identify when business logic might be driving technical decisions
|
|
78
|
+
- Request clarification on domain-specific terminology or patterns
|
|
79
|
+
|
|
80
|
+
### 9. Consider Ripple Effects
|
|
81
|
+
|
|
82
|
+
You think several moves ahead:
|
|
83
|
+
|
|
84
|
+
- Evaluate how changes affect system behavior under load
|
|
85
|
+
- Consider how features might be creatively misused
|
|
86
|
+
- Think about migration paths and backwards compatibility
|
|
87
|
+
- Assess impact on debugging, monitoring, and operations
|
|
88
|
+
|
|
89
|
+
### 10. Build and Nurture the Team
|
|
90
|
+
|
|
91
|
+
Your expertise elevates everyone:
|
|
92
|
+
|
|
93
|
+
- Frame observations as learning opportunities, not criticisms
|
|
94
|
+
- Share war stories that illustrate principles, not to show off
|
|
95
|
+
- Help the team understand their system better through your reviews
|
|
96
|
+
- Build confidence through knowledge transfer, not dependency
|
|
97
|
+
- Use your expertise to build bridges between different perspectives
|
|
98
|
+
|
|
99
|
+
## Your Communication Style
|
|
100
|
+
|
|
101
|
+
You communicate with:
|
|
102
|
+
|
|
103
|
+
- **Clarity**: Technical precision without unnecessary jargon
|
|
104
|
+
- **Humility**: Confidence without arrogance, strength without rigidity
|
|
105
|
+
- **Context**: Always explain the 'why' behind your observations
|
|
106
|
+
- **Empathy**: Remember that every line of code was someone's best effort at the
|
|
107
|
+
time
|
|
108
|
+
- **Pragmatism**: Perfect is the enemy of shipped; know when good enough is good
|
|
109
|
+
enough
|
|
110
|
+
|
|
111
|
+
## Your Review Approach
|
|
112
|
+
|
|
113
|
+
1. Start with a high-level assessment of the approach
|
|
114
|
+
2. Identify any architectural concerns or misalignments
|
|
115
|
+
3. Dive into implementation details only after validating the approach
|
|
116
|
+
4. Balance thoroughness with pragmatism—not every issue needs fixing
|
|
117
|
+
5. Prioritize feedback by impact and risk
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
name: Node CI Suite
|
|
2
|
+
|
|
3
|
+
on: push
|
|
4
|
+
|
|
5
|
+
jobs:
|
|
6
|
+
test:
|
|
7
|
+
runs-on: ${{ matrix.os }}
|
|
8
|
+
name: Node Tests
|
|
9
|
+
|
|
10
|
+
strategy:
|
|
11
|
+
matrix:
|
|
12
|
+
node-version: [20.x, 22.x, 24.x]
|
|
13
|
+
os: [sfdc-hk-ubuntu-latest]
|
|
14
|
+
|
|
15
|
+
steps:
|
|
16
|
+
- uses: actions/checkout@v4
|
|
17
|
+
- name: Use Node.js ${{ matrix.node-version }}
|
|
18
|
+
uses: actions/setup-node@v4
|
|
19
|
+
with:
|
|
20
|
+
node-version: ${{ matrix.node-version }}
|
|
21
|
+
check-latest: true
|
|
22
|
+
- name: Enable Corepack
|
|
23
|
+
run: corepack enable
|
|
24
|
+
- run: pnpm install --frozen-lockfile
|
|
25
|
+
- run: pnpm run ci
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
pnpm run lint-staged
|
package/.tool-versions
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
nodejs 24.11.0
|
package/CODEOWNERS
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# All files require review from the Heroku Front-End Dev Tools team.
|
|
2
|
+
|
|
3
|
+
# Comment line immediately above ownership line is reserved for related GUS information.
|
|
4
|
+
# Please exercise caution while editing.
|
|
5
|
+
|
|
6
|
+
#ECCN:Open Source
|
|
7
|
+
#GUSINFO: Heroku FE Dev Tools,Heroku CLI & Plugins
|
|
8
|
+
* @heroku/frontend-dev-tooling
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# Salesforce Open Source Community Code of Conduct
|
|
2
|
+
|
|
3
|
+
## About the Code of Conduct
|
|
4
|
+
|
|
5
|
+
Equality is a core value at Salesforce. We believe a diverse and inclusive
|
|
6
|
+
community fosters innovation and creativity, and are committed to building a
|
|
7
|
+
culture where everyone feels included.
|
|
8
|
+
|
|
9
|
+
Salesforce open-source projects are committed to providing a friendly, safe, and
|
|
10
|
+
welcoming environment for all, regardless of gender identity and expression,
|
|
11
|
+
sexual orientation, disability, physical appearance, body size, ethnicity,
|
|
12
|
+
nationality, race, age, religion, level of experience, education, socioeconomic
|
|
13
|
+
status, or other similar personal characteristics.
|
|
14
|
+
|
|
15
|
+
The goal of this code of conduct is to specify a baseline standard of behavior
|
|
16
|
+
so that people with different social values and communication styles can work
|
|
17
|
+
together effectively, productively, and respectfully in our open source
|
|
18
|
+
community. It also establishes a mechanism for reporting issues and resolving
|
|
19
|
+
conflicts.
|
|
20
|
+
|
|
21
|
+
All questions and reports of abusive, harassing, or otherwise unacceptable
|
|
22
|
+
behavior in a Salesforce open-source project may be reported by contacting the
|
|
23
|
+
Salesforce Open Source Conduct Committee at ossconduct@salesforce.com.
|
|
24
|
+
|
|
25
|
+
## Our Pledge
|
|
26
|
+
|
|
27
|
+
In the interest of fostering an open and welcoming environment, we as
|
|
28
|
+
contributors and maintainers pledge to making participation in our project and
|
|
29
|
+
our community a harassment-free experience for everyone, regardless of gender
|
|
30
|
+
identity and expression, sexual orientation, disability, physical appearance,
|
|
31
|
+
body size, ethnicity, nationality, race, age, religion, level of experience,
|
|
32
|
+
education, socioeconomic status, or other similar personal characteristics.
|
|
33
|
+
|
|
34
|
+
## Our Standards
|
|
35
|
+
|
|
36
|
+
Examples of behavior that contributes to creating a positive environment
|
|
37
|
+
include:
|
|
38
|
+
|
|
39
|
+
- Using welcoming and inclusive language
|
|
40
|
+
- Being respectful of differing viewpoints and experiences
|
|
41
|
+
- Gracefully accepting constructive criticism
|
|
42
|
+
- Focusing on what is best for the community
|
|
43
|
+
- Showing empathy toward other community members
|
|
44
|
+
|
|
45
|
+
Examples of unacceptable behavior by participants include:
|
|
46
|
+
|
|
47
|
+
- The use of sexualized language or imagery and unwelcome sexual attention or
|
|
48
|
+
advances
|
|
49
|
+
- Personal attacks, insulting/derogatory comments, or trolling
|
|
50
|
+
- Public or private harassment
|
|
51
|
+
- Publishing, or threatening to publish, others' private information—such as a
|
|
52
|
+
physical or electronic address—without explicit permission
|
|
53
|
+
- Other conduct which could reasonably be considered inappropriate in a
|
|
54
|
+
professional setting
|
|
55
|
+
- Advocating for or encouraging any of the above behaviors
|
|
56
|
+
|
|
57
|
+
## Our Responsibilities
|
|
58
|
+
|
|
59
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
|
60
|
+
behavior and are expected to take appropriate and fair corrective action in
|
|
61
|
+
response to any instances of unacceptable behavior.
|
|
62
|
+
|
|
63
|
+
Project maintainers have the right and responsibility to remove, edit, or reject
|
|
64
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
65
|
+
not aligned with this Code of Conduct, or to ban temporarily or permanently any
|
|
66
|
+
contributor for other behaviors that they deem inappropriate, threatening,
|
|
67
|
+
offensive, or harmful.
|
|
68
|
+
|
|
69
|
+
## Scope
|
|
70
|
+
|
|
71
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
|
72
|
+
when an individual is representing the project or its community. Examples of
|
|
73
|
+
representing a project or community include using an official project email
|
|
74
|
+
address, posting via an official social media account, or acting as an appointed
|
|
75
|
+
representative at an online or offline event. Representation of a project may be
|
|
76
|
+
further defined and clarified by project maintainers.
|
|
77
|
+
|
|
78
|
+
## Enforcement
|
|
79
|
+
|
|
80
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
81
|
+
reported by contacting the Salesforce Open Source Conduct Committee at
|
|
82
|
+
ossconduct@salesforce.com. All complaints will be reviewed and investigated and
|
|
83
|
+
will result in a response that is deemed necessary and appropriate to the
|
|
84
|
+
circumstances. The committee is obligated to maintain confidentiality with
|
|
85
|
+
regard to the reporter of an incident. Further details of specific enforcement
|
|
86
|
+
policies may be posted separately.
|
|
87
|
+
|
|
88
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
89
|
+
faith may face temporary or permanent repercussions as determined by other
|
|
90
|
+
members of the project's leadership and the Salesforce Open Source Conduct
|
|
91
|
+
Committee.
|
|
92
|
+
|
|
93
|
+
## Attribution
|
|
94
|
+
|
|
95
|
+
This Code of Conduct is adapted from the [Contributor
|
|
96
|
+
Covenant][contributor-covenant-home], version 1.4, available at
|
|
97
|
+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html. It
|
|
98
|
+
includes adaptions and additions from [Go Community Code of
|
|
99
|
+
Conduct][golang-coc], [CNCF Code of Conduct][cncf-coc], and [Microsoft Open
|
|
100
|
+
Source Code of Conduct][microsoft-coc].
|
|
101
|
+
|
|
102
|
+
This Code of Conduct is licensed under the [Creative Commons Attribution 3.0
|
|
103
|
+
License][cc-by-3-us].
|
|
104
|
+
|
|
105
|
+
[contributor-covenant-home]:
|
|
106
|
+
https://www.contributor-covenant.org
|
|
107
|
+
'https://www.contributor-covenant.org/'
|
|
108
|
+
[golang-coc]: https://golang.org/conduct
|
|
109
|
+
[cncf-coc]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md
|
|
110
|
+
[microsoft-coc]: https://opensource.microsoft.com/codeofconduct/
|
|
111
|
+
[cc-by-3-us]: https://creativecommons.org/licenses/by/3.0/us/
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# Contributing Guide For Heroku JS Blanket
|
|
2
|
+
|
|
3
|
+
This page lists the operational governance model of this project, as well as the
|
|
4
|
+
recommendations and requirements for how to best contribute to Heroku JS
|
|
5
|
+
Blanket. We strive to obey these as best as possible. As always, thanks for
|
|
6
|
+
contributing – we hope these guidelines make it easier and shed some light on
|
|
7
|
+
our approach and processes.
|
|
8
|
+
|
|
9
|
+
# Governance Model
|
|
10
|
+
|
|
11
|
+
## Salesforce Sponsored
|
|
12
|
+
|
|
13
|
+
The intent and goal of open sourcing this project is to increase the contributor
|
|
14
|
+
and user base. However, only Salesforce employees will be given `admin` rights
|
|
15
|
+
and will be the final arbitrars of what contributions are accepted or not.
|
|
16
|
+
|
|
17
|
+
# Issues, requests & ideas
|
|
18
|
+
|
|
19
|
+
Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
|
|
20
|
+
|
|
21
|
+
### Bug Reports and Fixes
|
|
22
|
+
|
|
23
|
+
- If you find a bug, please search for it in the
|
|
24
|
+
[Issues](https://github.com/heroku/js-blanket/issues), and if it isn't already
|
|
25
|
+
tracked,
|
|
26
|
+
[create a new issue](https://github.com/heroku/js-blanket/issues/new). Fill
|
|
27
|
+
out the "Bug Report" section of the issue template. Even if an Issue is
|
|
28
|
+
closed, feel free to comment and add details, it will still be reviewed.
|
|
29
|
+
- Issues that have already been identified as a bug (note: able to reproduce)
|
|
30
|
+
will be labelled `bug`.
|
|
31
|
+
- If you'd like to submit a fix for a bug,
|
|
32
|
+
[send a Pull Request](#creating_a_pull_request) and mention the Issue number.
|
|
33
|
+
- Include tests that isolate the bug and verifies that it was fixed.
|
|
34
|
+
|
|
35
|
+
### New Features
|
|
36
|
+
|
|
37
|
+
- If you'd like to add new functionality to this project, describe the problem
|
|
38
|
+
you want to solve in a
|
|
39
|
+
[new Issue](https://github.com/heroku/js-blanket/issues/new).
|
|
40
|
+
- Issues that have been identified as a feature request will be labelled
|
|
41
|
+
`enhancement`.
|
|
42
|
+
- If you'd like to implement the new feature, please wait for feedback from the
|
|
43
|
+
project maintainers before spending too much time writing the code. In some
|
|
44
|
+
cases, `enhancement`s may not align well with the project objectives at the
|
|
45
|
+
time.
|
|
46
|
+
|
|
47
|
+
### Tests, Documentation, Miscellaneous
|
|
48
|
+
|
|
49
|
+
- If you'd like to improve the tests, you want to make the documentation
|
|
50
|
+
clearer, you have an alternative implementation of something that may have
|
|
51
|
+
advantages over the way its currently done, or you have any other change, we
|
|
52
|
+
would be happy to hear about it!
|
|
53
|
+
- If its a trivial change, go ahead and
|
|
54
|
+
[send a Pull Request](#creating_a_pull_request) with the changes you have in
|
|
55
|
+
mind.
|
|
56
|
+
- If not, [open an Issue](https://github.com/heroku/js-blanket/issues/new) to
|
|
57
|
+
discuss the idea first.
|
|
58
|
+
|
|
59
|
+
If you're new to our project and looking for some way to make your first
|
|
60
|
+
contribution, look for Issues labelled `good first contribution`.
|
|
61
|
+
|
|
62
|
+
# Contribution Checklist
|
|
63
|
+
|
|
64
|
+
- [x] Clean, simple, well styled code
|
|
65
|
+
- [x] Commits should be atomic and messages must be descriptive. Related issues
|
|
66
|
+
should be mentioned by Issue number.
|
|
67
|
+
- [x] Comments
|
|
68
|
+
- Module-level & function-level comments.
|
|
69
|
+
- Comments on complex blocks of code or algorithms (include references to
|
|
70
|
+
sources).
|
|
71
|
+
- [x] Tests
|
|
72
|
+
- The test suite, if provided, must be complete and pass
|
|
73
|
+
- Increase code coverage, not versa.
|
|
74
|
+
- Use any of our testkits that contains a bunch of testing facilities you
|
|
75
|
+
would need. For example: `import com.salesforce.op.test._` and borrow
|
|
76
|
+
inspiration from existing tests.
|
|
77
|
+
- [x] Dependencies
|
|
78
|
+
- Minimize number of dependencies.
|
|
79
|
+
- Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses.
|
|
80
|
+
- [x] Reviews
|
|
81
|
+
- Changes must be approved via peer code review
|
|
82
|
+
|
|
83
|
+
# Creating a Pull Request
|
|
84
|
+
|
|
85
|
+
1. **Ensure the bug/feature was not already reported** by searching on GitHub
|
|
86
|
+
under Issues. If none exists, create a new issue so that other contributors
|
|
87
|
+
can keep track of what you are trying to add/fix and offer suggestions (or
|
|
88
|
+
let you know if there is already an effort in progress).
|
|
89
|
+
2. **Clone** the forked repo to your machine.
|
|
90
|
+
3. **Create** a new branch to contain your work (e.g. `git br fix-issue-11`)
|
|
91
|
+
4. **Commit** changes to your own branch.
|
|
92
|
+
5. **Push** your work back up to your fork. (e.g. `git push fix-issue-11`)
|
|
93
|
+
6. **Submit** a Pull Request against the `main` branch and refer to the issue(s)
|
|
94
|
+
you are fixing. Try not to pollute your pull request with unintended changes.
|
|
95
|
+
Keep it simple and small.
|
|
96
|
+
7. **Sign** the Salesforce CLA (you will be prompted to do so when submitting
|
|
97
|
+
the Pull Request)
|
|
98
|
+
|
|
99
|
+
> **NOTE**: Be sure to
|
|
100
|
+
> [sync your fork](https://help.github.com/articles/syncing-a-fork/) before
|
|
101
|
+
> making a pull request.
|
|
102
|
+
|
|
103
|
+
# Contributor License Agreement ("CLA")
|
|
104
|
+
|
|
105
|
+
In order to accept your pull request, we need you to submit a CLA. You only need
|
|
106
|
+
to do this once to work on any of Salesforce's open source projects.
|
|
107
|
+
|
|
108
|
+
Complete your CLA here: <https://cla.salesforce.com/sign-cla>
|
|
109
|
+
|
|
110
|
+
# Issues
|
|
111
|
+
|
|
112
|
+
We use GitHub issues to track public bugs. Please ensure your description is
|
|
113
|
+
clear and has sufficient instructions to be able to reproduce the issue.
|
|
114
|
+
|
|
115
|
+
# Code of Conduct
|
|
116
|
+
|
|
117
|
+
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
118
|
+
|
|
119
|
+
# License
|
|
120
|
+
|
|
121
|
+
By contributing your code, you agree to license your contribution under the
|
|
122
|
+
terms of our project [LICENSE](LICENSE.txt) and to sign the
|
|
123
|
+
[Salesforce CLA](https://cla.salesforce.com/sign-cla)
|
package/LICENSE
ADDED
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
Apache License Version 2.0
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Salesforce, Inc.
|
|
4
|
+
All rights reserved.
|
|
5
|
+
|
|
6
|
+
Apache License
|
|
7
|
+
Version 2.0, January 2004
|
|
8
|
+
http://www.apache.org/licenses/
|
|
9
|
+
|
|
10
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
11
|
+
|
|
12
|
+
1. Definitions.
|
|
13
|
+
|
|
14
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
15
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
16
|
+
|
|
17
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
18
|
+
the copyright owner that is granting the License.
|
|
19
|
+
|
|
20
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
21
|
+
other entities that control, are controlled by, or are under common
|
|
22
|
+
control with that entity. For the purposes of this definition,
|
|
23
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
24
|
+
direction or management of such entity, whether by contract or
|
|
25
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
26
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
27
|
+
|
|
28
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
29
|
+
exercising permissions granted by this License.
|
|
30
|
+
|
|
31
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
32
|
+
including but not limited to software source code, documentation
|
|
33
|
+
source, and configuration files.
|
|
34
|
+
|
|
35
|
+
"Object" form shall mean any form resulting from mechanical
|
|
36
|
+
transformation or translation of a Source form, including but
|
|
37
|
+
not limited to compiled object code, generated documentation,
|
|
38
|
+
and conversions to other media types.
|
|
39
|
+
|
|
40
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
41
|
+
Object form, made available under the License, as indicated by a
|
|
42
|
+
copyright notice that is included in or attached to the work
|
|
43
|
+
(an example is provided in the Appendix below).
|
|
44
|
+
|
|
45
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
46
|
+
form, that is based on (or derived from) the Work and for which the
|
|
47
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
48
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
49
|
+
of this License, Derivative Works shall not include works that remain
|
|
50
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
51
|
+
the Work and Derivative Works thereof.
|
|
52
|
+
|
|
53
|
+
"Contribution" shall mean any work of authorship, including
|
|
54
|
+
the original version of the Work and any modifications or additions
|
|
55
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
56
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
57
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
58
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
59
|
+
means any form of electronic, verbal, or written communication sent
|
|
60
|
+
to the Licensor or its representatives, including but not limited to
|
|
61
|
+
communication on electronic mailing lists, source code control systems,
|
|
62
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
63
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
64
|
+
excluding communication that is conspicuously marked or otherwise
|
|
65
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
66
|
+
|
|
67
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
68
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
69
|
+
subsequently incorporated within the Work.
|
|
70
|
+
|
|
71
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
72
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
73
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
74
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
75
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
76
|
+
Work and such Derivative Works in Source or Object form.
|
|
77
|
+
|
|
78
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
79
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
80
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
81
|
+
(except as stated in this section) patent license to make, have made,
|
|
82
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
83
|
+
where such license applies only to those patent claims licensable
|
|
84
|
+
by such Contributor that are necessarily infringed by their
|
|
85
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
86
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
87
|
+
institute patent litigation against any entity (including a
|
|
88
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
89
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
90
|
+
or contributory patent infringement, then any patent licenses
|
|
91
|
+
granted to You under this License for that Work shall terminate
|
|
92
|
+
as of the date such litigation is filed.
|
|
93
|
+
|
|
94
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
95
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
96
|
+
modifications, and in Source or Object form, provided that You
|
|
97
|
+
meet the following conditions:
|
|
98
|
+
|
|
99
|
+
(a) You must give any other recipients of the Work or
|
|
100
|
+
Derivative Works a copy of this License; and
|
|
101
|
+
|
|
102
|
+
(b) You must cause any modified files to carry prominent notices
|
|
103
|
+
stating that You changed the files; and
|
|
104
|
+
|
|
105
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
106
|
+
that You distribute, all copyright, patent, trademark, and
|
|
107
|
+
attribution notices from the Source form of the Work,
|
|
108
|
+
excluding those notices that do not pertain to any part of
|
|
109
|
+
the Derivative Works; and
|
|
110
|
+
|
|
111
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
112
|
+
distribution, then any Derivative Works that You distribute must
|
|
113
|
+
include a readable copy of the attribution notices contained
|
|
114
|
+
within such NOTICE file, excluding those notices that do not
|
|
115
|
+
pertain to any part of the Derivative Works, in at least one
|
|
116
|
+
of the following places: within a NOTICE text file distributed
|
|
117
|
+
as part of the Derivative Works; within the Source form or
|
|
118
|
+
documentation, if provided along with the Derivative Works; or,
|
|
119
|
+
within a display generated by the Derivative Works, if and
|
|
120
|
+
wherever such third-party notices normally appear. The contents
|
|
121
|
+
of the NOTICE file are for informational purposes only and
|
|
122
|
+
do not modify the License. You may add Your own attribution
|
|
123
|
+
notices within Derivative Works that You distribute, alongside
|
|
124
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
125
|
+
that such additional attribution notices cannot be construed
|
|
126
|
+
as modifying the License.
|
|
127
|
+
|
|
128
|
+
You may add Your own copyright statement to Your modifications and
|
|
129
|
+
may provide additional or different license terms and conditions
|
|
130
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
131
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
132
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
133
|
+
the conditions stated in this License.
|
|
134
|
+
|
|
135
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
136
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
137
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
138
|
+
this License, without any additional terms or conditions.
|
|
139
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
140
|
+
the terms of any separate license agreement you may have executed
|
|
141
|
+
with Licensor regarding such Contributions.
|
|
142
|
+
|
|
143
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
144
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
145
|
+
except as required for reasonable and customary use in describing the
|
|
146
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
147
|
+
|
|
148
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
149
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
150
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
151
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
152
|
+
implied, including, without limitation, any warranties or conditions
|
|
153
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
154
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
155
|
+
appropriateness of using or redistributing the Work and assume any
|
|
156
|
+
risks associated with Your exercise of permissions under this License.
|
|
157
|
+
|
|
158
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
159
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
160
|
+
unless required by applicable law (such as deliberate and grossly
|
|
161
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
162
|
+
liable to You for damages, including any direct, indirect, special,
|
|
163
|
+
incidental, or consequential damages of any character arising as a
|
|
164
|
+
result of this License or out of the use or inability to use the
|
|
165
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
166
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
167
|
+
other commercial damages or losses), even if such Contributor
|
|
168
|
+
has been advised of the possibility of such damages.
|
|
169
|
+
|
|
170
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
171
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
172
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
173
|
+
or other liability obligations and/or rights consistent with this
|
|
174
|
+
License. However, in accepting such obligations, You may act only
|
|
175
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
176
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
177
|
+
defend, and hold each Contributor harmless for any liability
|
|
178
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
179
|
+
of your accepting any such warranty or additional liability.
|
|
180
|
+
|
|
181
|
+
END OF TERMS AND CONDITIONS
|
|
182
|
+
|
|
183
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
184
|
+
|
|
185
|
+
To apply the Apache License to your work, attach the following
|
|
186
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
187
|
+
replaced with your own identifying information. (Don't include
|
|
188
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
189
|
+
comment syntax for the file format. We also recommend that a
|
|
190
|
+
file or class name and description of purpose be included on the
|
|
191
|
+
same "printed page" as the copyright notice for easier
|
|
192
|
+
identification within third-party archives.
|
|
193
|
+
|
|
194
|
+
Copyright 2024 Heroku
|
|
195
|
+
|
|
196
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
197
|
+
you may not use this file except in compliance with the License.
|
|
198
|
+
You may obtain a copy of the License at
|
|
199
|
+
|
|
200
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
201
|
+
|
|
202
|
+
Unless required by applicable law or agreed to in writing, software
|
|
203
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
204
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
205
|
+
See the License for the specific language governing permissions and
|
|
206
|
+
limitations under the License.
|