Skip to content

Commit 3198ffd

Browse files
committed
chore: prettier --write **/*.{ts,md,json}
1 parent cb9bf09 commit 3198ffd

Some content is hidden

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

76 files changed

+1798
-1523
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
*Issue #, if available:*
2-
3-
*Description of changes:*
1+
_Issue #, if available:_
42

3+
_Description of changes:_
54

65
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

CODE_OF_CONDUCT.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
## Code of Conduct
2-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
2+
3+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
4+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
45
[email protected] with any additional questions or comments.

CONTRIBUTING.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
11
# Contributing Guidelines
22

3-
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
3+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
44
documentation, we greatly value feedback and contributions from our community.
55

6-
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
6+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
77
information to effectively respond to your bug report or contribution.
88

9-
109
## Reporting Bugs/Feature Requests
1110

1211
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1312

14-
When filing an issue, please check [existing open](https://github.com/aws/aws-sdk-js-crypto-helpers/issues), or [recently closed](https://github.com/aws/aws-sdk-js-crypto-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
13+
When filing an issue, please check [existing open](https://github.com/aws/aws-sdk-js-crypto-helpers/issues), or [recently closed](https://github.com/aws/aws-sdk-js-crypto-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
1514
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
1615

17-
* A reproducible test case or series of steps
18-
* The version of our code being used
19-
* Any modifications you've made relevant to the bug
20-
* Anything unusual about your environment or deployment
21-
16+
- A reproducible test case or series of steps
17+
- The version of our code being used
18+
- Any modifications you've made relevant to the bug
19+
- Anything unusual about your environment or deployment
2220

2321
## Contributing via Pull Requests
22+
2423
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
2524

26-
1. You are working against the latest source on the *master* branch.
25+
1. You are working against the latest source on the _master_ branch.
2726
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
2827
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
2928

@@ -36,23 +35,22 @@ To send us a pull request, please:
3635
5. Send us a pull request, answering any default questions in the pull request interface.
3736
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
3837

39-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
38+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4039
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4140

42-
4341
## Finding contributions to work on
44-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-sdk-js-crypto-helpers/labels/help%20wanted) issues is a great place to start.
4542

43+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-sdk-js-crypto-helpers/labels/help%20wanted) issues is a great place to start.
4644

4745
## Code of Conduct
48-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50-
[email protected] with any additional questions or comments.
5146

47+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
48+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
49+
[email protected] with any additional questions or comments.
5250

5351
## Security issue notifications
54-
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
5552

53+
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
5654

5755
## Licensing
5856

README.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,71 @@
11
## AWS SDK JS Crypto Helpers
2+
23
AWS Cryptographic Helpers for Javascript and Node.js
34

45
## Scope
6+
57
This repository collects cryptographic helper packages. We have designed it to gather packages that implement simple primitives for the browser or Node.js. More information about AWS Crypto Tools can be found [here](https://docs.aws.amazon.com/aws-crypto-tools/index.html?id=docs_gateway#lang/en_us)
68

79
## Project Status
10+
811
This project is still in its early stages. Please send us your feedback. We might make breaking changes in future releases while the SDK is still in developer preview.
912

1013
## Getting started
14+
1115
Let’s walk through setting up a project that requires a cryptographically secure random value. The following steps use npm as an example. They assume you have node.js and npm already installed.
12-
1. Create a new node.js project.
13-
2. In the project, run: `npm install --save @aws-crypto/random-source-node@preview`
14-
3. Create a new file called index.js, require the function, and then use it to get a random value.
16+
17+
1. Create a new node.js project.
18+
2. In the project, run: `npm install --save @aws-crypto/random-source-node@preview`
19+
3. Create a new file called index.js, require the function, and then use it to get a random value.
20+
1521
```javascript
16-
const {randomValues} = require('@aws-crypto/random-source-node')
22+
const { randomValues } = require("@aws-crypto/random-source-node");
1723
async function example() {
18-
try {
19-
const rand = await randomValues(32)
20-
console.log(rand.length)
24+
try {
25+
const rand = await randomValues(32);
26+
console.log(rand.length);
2127
} catch (err) {
22-
console.error(err)
28+
console.error(err);
2329
}
2430
}
2531
example();
2632
```
2733

2834
## Crypto Helper Package Index
35+
2936
Each package has readme details.
3037

31-
* [crc32](packages/crc32)
32-
* [ie11-detection](packages/ie11-detection)
33-
* [random-source-browser](packages/random-source-browser)
34-
* [random-source-node](packages/random-source-node)
35-
* [random-source-universal](packages/random-source-universal)
36-
* [sha256-browser](packages/sha256-browser)
37-
* [sha256-js](packages/sha256-js)
38-
* [sha256-universal](packages/sha256-universal)
39-
* [supports-web-crypto](packages/supports-web-crypto)
38+
- [crc32](packages/crc32)
39+
- [ie11-detection](packages/ie11-detection)
40+
- [random-source-browser](packages/random-source-browser)
41+
- [random-source-node](packages/random-source-node)
42+
- [random-source-universal](packages/random-source-universal)
43+
- [sha256-browser](packages/sha256-browser)
44+
- [sha256-js](packages/sha256-js)
45+
- [sha256-universal](packages/sha256-universal)
46+
- [supports-web-crypto](packages/supports-web-crypto)
4047

4148
## Testing
49+
4250
To run the tests in every package.
51+
4352
```
4453
npm install
4554
npm run bootstrap
4655
npm test
4756
```
4857

4958
## Feedback
50-
We welcome your feedback! If you have comments, questions, or suggestions, open a GitHub issue.
59+
60+
We welcome your feedback! If you have comments, questions, or suggestions, open a GitHub issue.
5161
We are actively monitoring issues and will respond to feedback as we prepare for our GA launch.
5262

5363
## Contributing
64+
5465
We welcome your contributions! To fix a problem, or add to an existing package: create a pull request.
5566
You must submit all pull requests under the Apache 2.0 license. They will be reviewed by a team member prior to merging.
5667
We would appreciate, but do not require, unit tests for all significant contributions. See [Contributing](CONTRIBUTING.md) for more information.
5768

5869
## License
5970

60-
This library is licensed under the Apache 2.0 License.
71+
This library is licensed under the Apache 2.0 License.

lerna.json

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,12 @@
11
{
22
"lerna": "2.11.0",
3-
"packages": [
4-
"packages/*"
5-
],
3+
"packages": ["packages/*"],
64
"version": "independent",
75
"command": {
86
"bootstrap": {
9-
"nohoist": [
10-
"@types/*",
11-
"typedoc",
12-
"karma*"
13-
]
7+
"nohoist": ["@types/*", "typedoc", "karma*"]
148
}
159
},
1610
"hoist": true,
17-
"nohoist": [
18-
"@types/*",
19-
"typedoc",
20-
"karma*"
21-
]
11+
"nohoist": ["@types/*", "typedoc", "karma*"]
2212
}

packages/crc32/package-lock.json

Lines changed: 18 additions & 18 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)