Skip to content

Commit e94d6c8

Browse files
author
Alexander Melnyk
committed
add init config
1 parent 266651b commit e94d6c8

File tree

5 files changed

+120
-0
lines changed

5 files changed

+120
-0
lines changed

‎packages/parser/README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Powertools for AWS Lambda (TypeScript) - Parser Utility <!-- omit in toc -->
2+
3+
4+
| ⚠️ **WARNING: Do not use this utility in production just yet!** ⚠️ |
5+
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
6+
| **This utility is currently released as beta developer preview** and is intended strictly for feedback and testing purposes **and not for production workloads**.. The version and all future versions tagged with the `-beta` suffix should be treated as not stable. Up until before the [General Availability release](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/14) we might introduce significant breaking changes and improvements in response to customers feedback. | _ |
7+
8+
- [Intro](#intro)
9+
- [Key features](#key-features)
10+
- [Usage](#usage)
11+
- [Contribute](#contribute)
12+
- [Roadmap](#roadmap)
13+
- [Connect](#connect)
14+
- [How to support Powertools for AWS Lambda (TypeScript)?](#how-to-support-powertools-for-aws-lambda-typescript)
15+
- [Becoming a reference customer](#becoming-a-reference-customer)
16+
- [Sharing your work](#sharing-your-work)
17+
- [Using Lambda Layer](#using-lambda-layer)
18+
- [Credits](#credits)
19+
- [License](#license)
20+
21+
## Intro
22+
23+
## Key features
24+
25+
## Usage
26+
27+
## Contribute
28+
29+
If you are interested in contributing to this project, please refer to our [Contributing Guidelines](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md).
30+
31+
## Roadmap
32+
33+
The roadmap of Powertools for AWS Lambda (TypeScript) is driven by customers’ demand.
34+
Help us prioritize upcoming functionalities or utilities by [upvoting existing RFCs and feature requests](https://github.com/aws-powertools/powertools-lambda-typescript/issues), or [creating new ones](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new/choose), in this GitHub repository.
35+
36+
## Connect
37+
38+
* **Powertools for AWS Lambda on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)**
39+
* **Email**: aws-lambda-powertools-feedback@amazon.com
40+
41+
## How to support Powertools for AWS Lambda (TypeScript)?
42+
43+
### Becoming a reference customer
44+
45+
Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E) issue.
46+
47+
The following companies, among others, use Powertools:
48+
49+
* [Hashnode](https://hashnode.com/)
50+
* [Trek10](https://www.trek10.com/)
51+
* [Elva](https://elva-group.com)
52+
* [globaldatanet](https://globaldatanet.com/)
53+
* [Bailey Nelson](https://www.baileynelson.com.au)
54+
* [Perfect Post](https://www.perfectpost.fr)
55+
* [Sennder](https://sennder.com/)
56+
* [Certible](https://www.certible.com/)
57+
* [tecRacer GmbH & Co. KG](https://www.tecracer.com/)
58+
59+
### Sharing your work
60+
61+
Share what you did with Powertools for AWS Lambda (TypeScript) 💞💞. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://docs.powertools.aws.dev/lambda-typescript/latest/we_made_this).
62+
63+
### Using Lambda Layer
64+
65+
This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](#lambda-layers), you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process.
66+
67+
## Credits
68+
69+
Credits for the Lambda Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/).
70+
71+
## License
72+
73+
This library is licensed under the MIT-0 License. See the LICENSE file.

‎packages/parser/jest.config.js

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
module.exports = {
2+
displayName: {
3+
name: 'Powertools for AWS Lambda (TypeScript) utility: PARSER',
4+
color: 'blue',
5+
},
6+
runner: 'groups',
7+
preset: 'ts-jest',
8+
transform: {
9+
'^.+\\.ts?$': 'ts-jest',
10+
},
11+
moduleFileExtensions: ['js', 'ts'],
12+
collectCoverageFrom: ['**/src/**/*.ts', '!**/node_modules/**'],
13+
testMatch: ['**/?(*.)+(spec|test).ts'],
14+
roots: ['<rootDir>/src', '<rootDir>/tests'],
15+
testPathIgnorePatterns: ['/node_modules/'],
16+
testEnvironment: 'node',
17+
coveragePathIgnorePatterns: ['/node_modules/', '/types/'],
18+
coverageThreshold: {
19+
global: {
20+
statements: 100,
21+
branches: 100,
22+
functions: 100,
23+
lines: 100,
24+
},
25+
},
26+
coverageReporters: ['json-summary', 'text', 'lcov'],
27+
setupFiles: ['<rootDir>/tests/helpers/populateEnvironmentVariables.ts'],
28+
};

‎packages/parser/src/intex.ts

Whitespace-only changes.

‎packages/parser/tsconfig.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"extends": "../../tsconfig.json",
3+
"compilerOptions": {
4+
"outDir": "./lib",
5+
"rootDir": "./src",
6+
},
7+
"include": [
8+
"./src/**/*"
9+
],
10+
}

‎packages/parser/typedoc.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"extends": [
3+
"../../typedoc.base.json"
4+
],
5+
"entryPoints": [
6+
"./src/index.ts"
7+
],
8+
"readme": "README.md"
9+
}

0 commit comments

Comments
 (0)