Skip to content

Commit 5da2eab

Browse files
committed
codebase improvements.
1 parent 0f7757e commit 5da2eab

File tree

12 files changed

+214
-8
lines changed

12 files changed

+214
-8
lines changed

.gitignore

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,28 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
13
# OS-specific files
24
.DS_Store
5+
Thumbs.db
36

47
# Editor-specific files
5-
# .vscode/
8+
.vscode/*
9+
!.vscode/extensions.json
10+
!.vscode/settings.json
11+
.idea/
612

7-
# NPM packages
13+
# NPM packaging
814
node_modules/
15+
yarn.lock
16+
package-lock.json
917

1018
# Build output
1119
dist/
1220
tsconfig.tsbuildinfo
21+
22+
# sensitive files
23+
*.pem
24+
*.swp
25+
26+
# coverage files
27+
etc/coverage/*.json
28+
etc/coverage/cov_profile.lcov

.vscode/extensions.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"recommendations": [
3+
"denoland.vscode-deno",
4+
"ryanluker.vscode-coverage-gutters"
5+
]
6+
}

.vscode/settings.json

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"deno.enable": true,
3+
"deno.suggest.autoImports": true,
4+
"deno.suggest.completeFunctionCalls": true,
5+
"deno.suggest.imports.autoDiscover": true,
6+
"deno.suggest.imports.hosts": {
7+
"https://deno.land": true
8+
},
9+
"deno.suggest.names": true,
10+
"deno.suggest.paths": true,
11+
"deno.unstable": true,
12+
"editor.defaultFormatter": "denoland.vscode-deno",
13+
"coverage-gutters.coverageBaseDir": "**/etc/coverage",
14+
"coverage-gutters.coverageFileNames": [ "cov_profile.lcov" ],
15+
"coverage-gutters.showGutterCoverage": true,
16+
"coverage-gutters.showLineCoverage": true,
17+
"coverage-gutters.showRulerCoverage": true,
18+
"files.exclude": {
19+
"**/.git": true,
20+
"**/.svn": true,
21+
"**/.hg": true,
22+
"**/CVS": true,
23+
"**/.DS_Store": true,
24+
"**/Thumbs.db": true,
25+
".github/ISSUE_TEMPLATE": true,
26+
".github/FUNDING.yml": true,
27+
"etc/coverage/*.json": true,
28+
"node_modules": true,
29+
"yarn.lock": true,
30+
"package-lock.json": true,
31+
"package.json": true,
32+
".editorconfig": true,
33+
"CODE_OF_CONDUCT.md": true,
34+
"CONTRIBUTING.md": true,
35+
"SECURITY.md": true,
36+
"LICENSE": true,
37+
"packager.ts": true
38+
},
39+
"files.watcherExclude": {
40+
"**/.git/objects/**": true,
41+
"**/.git/subtree-cache/**": true,
42+
"**/node_modules/*/**": true,
43+
"**/.hg/store/**": true,
44+
"dist/**": true,
45+
"etc/coverage/**": true
46+
}
47+
}

CODE_OF_CONDUCT.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and
9+
expression, level of experience, education, socio-economic status, nationality,
10+
personal appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or reject
41+
comments, commits, code, wiki edits, issues, and other contributions that are
42+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
43+
contributor for other behaviors that they deem inappropriate, threatening,
44+
offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All complaints will
59+
be reviewed and investigated and will result in a response that is deemed
60+
necessary and appropriate to the circumstances. The project team is obligated to
61+
maintain confidentiality with regard to the reporter of an incident. Further
62+
details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
71+
version 1.4, available at
72+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
73+
74+
[homepage]: https://www.contributor-covenant.org
75+
76+
For answers to common questions about this code of conduct, see
77+
https://www.contributor-covenant.org/faq

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright 2022 Eser Ozvataf
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

SECURITY.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Use this section to tell people about which versions of your project are
6+
currently being supported with security updates.
7+
8+
| Version | Supported |
9+
| ------- | ------------------ |
10+
| 1.0.x | :white_check_mark: |
11+
| < 0.9 | :x: |
12+
13+
## Reporting a Vulnerability
14+
15+
Use this section to tell people how to report a vulnerability.
16+
17+
Tell them where to go, how often they can expect to get an update on a reported
18+
vulnerability, what to expect if the vulnerability is accepted or declined, etc.

deno.json

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
2+
"importMap": "./import_map.json",
23
"lint": {
34
"files": {
45
"include": [
@@ -46,9 +47,12 @@
4647
}
4748
},
4849
"tasks": {
49-
"build": "deno task build:deno",
50-
"build:deno": "deno run -A packager.ts",
51-
"pub": "deno task build && npm publish dist/",
52-
"cleanup": "rm -rf ./dist/ yarn.lock package-lock.json"
50+
"test": "deno test ./src/ --allow-net --coverage=./etc/coverage",
51+
"test:coverage": "deno coverage ./etc/coverage",
52+
"test:generate-lcov": "deno coverage ./etc/coverage --lcov > ./etc/coverage/cov_profile.lcov",
53+
"bench": "deno bench ./src/ --unstable",
54+
"cleanup": "rm -rf ./dist/ yarn.lock package-lock.json",
55+
"build": "deno run -A packager.ts",
56+
"pub": "deno task build && npm publish dist/"
5357
}
5458
}

etc/coverage/.gitkeep

Whitespace-only changes.

import_map.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"imports": {
3+
}
4+
}

mod.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export * from "./src/mod.ts";

0 commit comments

Comments
 (0)