Skip to content

Commit 15d9dd4

Browse files
adrianprelipceanadrianprelipcean
authored
Merge pull request #1 from adrianprelipcean/feature/extra-docs
Feature/extra docs
2 parents a89c8c4 + 7bbb8bc commit 15d9dd4

File tree

11 files changed

+349
-106
lines changed

11 files changed

+349
-106
lines changed

‎.github/workflows/cicd.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ on:
55
pull_request:
66

77
jobs:
8-
test:
8+
ci:
9+
name: Continuous Integration
910
runs-on: ubuntu-latest
1011
strategy:
1112
matrix:
@@ -18,10 +19,11 @@ jobs:
1819
node-version: ${{ matrix.node-version }}
1920
- run: npm ci
2021
- run: npm test
21-
publish:
22-
name: Publish
22+
- run: npm run lint
23+
cd:
24+
name: Continuous Deployment
2325
runs-on: ubuntu-latest
24-
needs: test
26+
needs: ci
2527
if: startsWith(github.ref, 'refs/tags/v')
2628
steps:
2729
- name: Checkout the repository

‎.prettierignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
third_party_licenses/
2+
.github/
3+
.husky/

‎changelog.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to
7+
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
8+
9+
## [1.0.2](https://github.com/adrianprelipcean/express-rate-limit-postgresql/releases/tag/v1.0.2)
10+
11+
### Added
12+
13+
- First release with core functionality according to
14+
[express-rate-limit guide](https://github.com/express-rate-limit/express-rate-limit/wiki/Creating-Your-Own-Store)

‎code_of_conduct.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Contributor Covenant Code of Conduct
32

43
## Our Pledge
@@ -18,23 +17,23 @@ diverse, inclusive, and healthy community.
1817
Examples of behavior that contributes to a positive environment for our
1918
community include:
2019

21-
* Demonstrating empathy and kindness toward other people
22-
* Being respectful of differing opinions, viewpoints, and experiences
23-
* Giving and gracefully accepting constructive feedback
24-
* Accepting responsibility and apologizing to those affected by our mistakes,
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,
2524
and learning from the experience
26-
* Focusing on what is best not just for us as individuals, but for the overall
25+
- Focusing on what is best not just for us as individuals, but for the overall
2726
community
2827

2928
Examples of unacceptable behavior include:
3029

31-
* The use of sexualized language or imagery, and sexual attention or advances of
30+
- The use of sexualized language or imagery, and sexual attention or advances of
3231
any kind
33-
* Trolling, insulting or derogatory comments, and personal or political attacks
34-
* Public or private harassment
35-
* Publishing others' private information, such as a physical or email address,
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 address,
3635
without their explicit permission
37-
* Other conduct which could reasonably be considered inappropriate in a
36+
- Other conduct which could reasonably be considered inappropriate in a
3837
professional setting
3938

4039
## Enforcement Responsibilities
@@ -60,9 +59,8 @@ representative at an online or offline event.
6059
## Enforcement
6160

6261
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63-
reported to the community leaders responsible for enforcement at
64-
[INSERT CONTACT METHOD].
65-
All complaints will be reviewed and investigated promptly and fairly.
62+
reported to the community leaders responsible for enforcement at [INSERT CONTACT
63+
METHOD]. All complaints will be reviewed and investigated promptly and fairly.
6664

6765
All community leaders are obligated to respect the privacy and security of the
6866
reporter of any incident.
@@ -119,8 +117,8 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119117
version 2.1, available at
120118
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121119

122-
Community Impact Guidelines were inspired by
123-
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
120+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121+
enforcement ladder][Mozilla CoC].
124122

125123
For answers to common questions about this code of conduct, see the FAQ at
126124
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at

‎configs/tsconfig.base.json

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
11
{
2-
"compilerOptions": {
3-
"strict": true,
4-
"esModuleInterop": true,
5-
"forceConsistentCasingInFileNames": true,
6-
"skipLibCheck": true,
7-
"checkJs": true,
8-
"allowJs": true,
9-
"declaration": true,
10-
"declarationMap": true,
11-
"allowSyntheticDefaultImports": true
12-
},
13-
"include": [
14-
"../source/"
15-
],
16-
"exclude": [
17-
"../node_modules/",
18-
"../local_folder/"
19-
],
20-
"extends": "@express-rate-limit/tsconfig"
21-
}
2+
"compilerOptions": {
3+
"strict": true,
4+
"esModuleInterop": true,
5+
"forceConsistentCasingInFileNames": true,
6+
"skipLibCheck": true,
7+
"checkJs": true,
8+
"allowJs": true,
9+
"declaration": true,
10+
"declarationMap": true,
11+
"allowSyntheticDefaultImports": true
12+
},
13+
"include": ["../source/"],
14+
"exclude": ["../node_modules/", "../local_folder/"],
15+
"extends": "@express-rate-limit/tsconfig"
16+
}

‎configs/tsconfig.cjs.json

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
{
2-
"extends": "./tsconfig.base.json",
3-
"compilerOptions": {
4-
"lib": [
5-
"ES6",
6-
"DOM"
7-
],
8-
"target": "ES6",
9-
"module": "CommonJS",
10-
"moduleResolution": "Node",
11-
"outDir": "../dist/cjs",
12-
"declarationDir": "../dist/cjs/types"
13-
}
14-
}
2+
"extends": "./tsconfig.base.json",
3+
"compilerOptions": {
4+
"lib": ["ES6", "DOM"],
5+
"target": "ES6",
6+
"module": "CommonJS",
7+
"moduleResolution": "Node",
8+
"outDir": "../dist/cjs",
9+
"declarationDir": "../dist/cjs/types"
10+
}
11+
}

‎configs/tsconfig.esm.json

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
{
2-
"extends": "./tsconfig.base.json",
3-
"compilerOptions": {
4-
"lib": [
5-
"ES2022",
6-
"DOM"
7-
],
8-
"target": "ES2022",
9-
"module": "NodeNext",
10-
"moduleResolution": "NodeNext",
11-
"outDir": "../dist/esm",
12-
"declarationDir": "../dist/esm/types"
13-
}
14-
}
2+
"extends": "./tsconfig.base.json",
3+
"compilerOptions": {
4+
"lib": ["ES2022", "DOM"],
5+
"target": "ES2022",
6+
"module": "NodeNext",
7+
"moduleResolution": "NodeNext",
8+
"outDir": "../dist/esm",
9+
"declarationDir": "../dist/esm/types"
10+
}
11+
}

0 commit comments

Comments
 (0)