Skip to content

Commit d6ae93c

Browse files
committed
🔀 Merge branch 'devel' into release
- 🙈 .npmignore is added - 💚 .travis.yml is updated - Cache ~/.npm directory - Except release tags - 📝 CHANGELOG.md is added - 📝 CODE_OF_CONDUCT.md is added - ✏️ Typo at 'description' of 'badges' is fixed - 🔨 package.json is updated - Declaration file is generated directly by `tsc` - Use `rimraf` instead of `rm` command - 🔧 tsconfig.json is updated - Declaration file is generated to lib/ by `tsc` - 'typeRoots' is added - 'include' is added Signed-off-by: kei-g <km.8k6ce+github@gmail.com>
2 parents a0de9d6 + 0ae1a1b commit d6ae93c

File tree

8 files changed

+214
-8
lines changed

8 files changed

+214
-8
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
**/.vscode/
33
**/build/
44
**/coverage/
5-
**/lib/
5+
**/lib/*.js
6+
**/lib/*.ts
67
**/node_modules/
78
**/package-lock.json

.npmignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
**/*.ts
2+
**/.editorconfig
3+
**/.eslintrc.json
4+
**/.mocharc.json
5+
**/.travis.yml
6+
**/CODE_OF_CONDUCT.md
7+
**/build/
8+
**/test/
9+
**/tsconfig.json

.travis.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
cache: npm
1+
branches:
2+
except:
3+
- /^v\d+\.\d+\.\d+$/
4+
cache:
5+
directories:
6+
- ~/.npm
27
language: node_js
38
node_js:
49
- 14

CHANGELOG.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# ChangeLogs
2+
3+
## Version 1.0.5
4+
5+
- :see_no_evil: .npmignore is added
6+
- :green_heart: .travis.yml is updated
7+
- Cache ~/.npm directory
8+
- Except release tags
9+
- :memo: CHANGELOG.md is added
10+
- :memo: CODE_OF_CONDUCT.md is added
11+
- :pencil2: Typo at 'description' of 'badges' is fixed
12+
- :hammer: package.json is updated
13+
- Declaration file is generated directly by `tsc`
14+
- Use `rimraf` instead of `rm` command
15+
- :wrench: tsconfig.json is updated
16+
- Declaration file is generated to lib/ by `tsc`
17+
- 'typeRoots' is added
18+
- 'include' is added
19+
20+
## Version 1.0.4
21+
22+
- :pushpin: Node.js v14.x is supported
23+
- `SharedArrayBuffer` is also used with `Uint8Array`
24+
25+
## Version 1.0.3
26+
27+
- :zap: Performance Improvement
28+
- Call `reject` rather than throwing Error
29+
- Use `Atomics`
30+
- :memo: README.md is updated
31+
- logo of badges are updated
32+
- :package: package.json is updated
33+
- 'badges' is added
34+
35+
## Version 1.0.2
36+
37+
- :package: package.json is updated
38+
- 'main' is added
39+
40+
## Version 1.0.1
41+
42+
- :memo: README.md is updated
43+
- description is added
44+
- image URL of badge is fixed
45+
- :package: package.json is updated
46+
- 'keywords' are added
47+
- 'license' is added
48+
49+
## Version 1.0.0
50+
51+
- :tada: Initial release

CODE_OF_CONDUCT.md

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

lib/.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
!**/*.d.ts

package.json

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"url": "https://npmjs.com/package/async-iterable-queue"
2626
},
2727
{
28-
"description": "maintainance",
28+
"description": "maintenance",
2929
"href": "https://img.shields.io/npms-io/maintenance-score/async-iterable-queue?logo=npm",
3030
"url": "https://npms.io/search?q=async-iterable-queue"
3131
},
@@ -52,14 +52,12 @@
5252
"eslint": "^7.32.0",
5353
"mocha": "^9.1.0",
5454
"nyc": "^15.1.0",
55+
"rimraf": "^3.0.2",
5556
"terser": "^5.7.1",
5657
"ts-node": "^10.2.1",
5758
"typescript": "^4.3.5",
5859
"uuid": "^8.3.2"
5960
},
60-
"files": [
61-
"lib"
62-
],
6361
"homepage": "https://github.com/kei-g/async-iterable-queue",
6462
"keywords": [
6563
"async",
@@ -86,10 +84,11 @@
8684
"url": "https://github.com/kei-g/async-iterable-queue.git"
8785
},
8886
"scripts": {
89-
"build": "npm run lint && tsc && ([ -d lib ] || mkdir lib) && cp build/async-iterable-queue.d.ts lib/ && terser build/async-iterable-queue.js -c -m -o lib/async-iterable-queue.js --toplevel",
90-
"clean": "rm -fr .nyc_output/ build/ coverage/ lib/",
87+
"build": "npm run lint && tsc && terser build/async-iterable-queue.js -c -m -o lib/async-iterable-queue.js --toplevel",
88+
"clean": "rimraf .nyc_output/ build/ coverage/ lib/*.d.ts lib/*.js",
9189
"cover": "nyc --check-coverage -r html -r text _mocha",
9290
"lint": "eslint *.ts",
91+
"prebuild": "rimraf build/ lib/*.d.ts lib/*.js",
9392
"prepublishOnly": "npm run build",
9493
"test": "npm run lint && npm run cover"
9594
},

tsconfig.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"alwaysStrict": true,
44
"charset": "utf8",
55
"declaration": true,
6+
"declarationDir": "lib",
67
"downlevelIteration": true,
78
"emitBOM": false,
89
"emitDeclarationOnly": false,
@@ -20,8 +21,14 @@
2021
"strict": true,
2122
"strictNullChecks": false,
2223
"target": "ES6",
24+
"typeRoots": [
25+
"node_modules/@types",
26+
],
2327
},
2428
"files": [
2529
"async-iterable-queue.ts",
2630
],
31+
"include": [
32+
"async-iterable-queue.ts",
33+
],
2734
}

0 commit comments

Comments
 (0)