Skip to content

Commit b021e9d

Browse files
MqxxMqxx
authored
Initial commit
0 parents  commit b021e9d

File tree

10 files changed

+339
-0
lines changed

10 files changed

+339
-0
lines changed

‎.github/workflows/lint.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Run Linter
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
checks: write
12+
13+
jobs:
14+
lint:
15+
name: Lint
16+
runs-on: ubuntu-latest
17+
env:
18+
deno-version: lts
19+
20+
steps:
21+
- name: 'Setup Repository (${{github.event.repository.name}})'
22+
uses: actions/checkout@v4
23+
24+
- name: 'Setup Deno'
25+
uses: denoland/setup-deno@v2.0.3
26+
with:
27+
deno-version: ${{env.deno-version}}
28+
29+
- name: 'Run Linter'
30+
run: deno task lint

‎.github/workflows/new_release.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: 'New release'
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
version:
7+
description: 'Version for new release.'
8+
type: string
9+
required: true
10+
11+
permissions:
12+
contents: write
13+
14+
jobs:
15+
release:
16+
name: 'Draft new release (${{inputs.version}})'
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- name: 'Setup Repository (${{github.event.repository.name}})'
21+
uses: actions/checkout@v4
22+
23+
- name: 'Create new release (${{inputs.version}})'
24+
uses: ncipollo/release-action@v1
25+
with:
26+
allowUpdates: false
27+
makeLatest: true
28+
tag: ${{inputs.version}}

‎.github/workflows/test.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Run Unit Tests
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
checks: write
12+
13+
jobs:
14+
test:
15+
name: Unit Test
16+
runs-on: ubuntu-latest
17+
env:
18+
deno-version: lts
19+
20+
steps:
21+
- name: 'Setup Repository (${{github.event.repository.name}})'
22+
uses: actions/checkout@v4
23+
24+
- name: 'Setup Deno'
25+
uses: denoland/setup-deno@v2.0.3
26+
with:
27+
deno-version: ${{env.deno-version}}
28+
29+
- name: 'Run Tests'
30+
run: deno task test
31+
32+
- name: 'Generate jUnit Report'
33+
uses: mikepenz/action-junit-report@v3.8.0
34+
with:
35+
report_paths: 'report.xml'

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.vscode/

‎LICENSE‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Template
2+
3+
[![Run Linter](https://github.com/DenoPlayground/Template/actions/workflows/lint.yml/badge.svg)](https://github.com/DenoPlayground/Template/actions/workflows/lint.yml)
4+
[![Run Unit Tests](https://github.com/DenoPlayground/Template/actions/workflows/test.yml/badge.svg)](https://github.com/DenoPlayground/Template/actions/workflows/test.yml)
5+
6+
This is a template for a Deno module.
7+
8+
## File/Directory Structure
9+
10+
- `cli.ts` - File for functions which should be executed directly for the module.
11+
- `src/` - Directory for storing all source code.
12+
- `docs/` - Directory for storing all documentation files specific for the module.

‎cli.ts‎

Whitespace-only changes.

‎deno.json‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"name": "@denoplayground/template",
3+
"version": "0.1.0",
4+
"tasks": {
5+
"run": {
6+
"description": "Run the main application.",
7+
"command": "deno run -A --check ./src/index.ts"
8+
},
9+
"run:watch": {
10+
"description": "Run the main application in watch mode.",
11+
"command": "deno run -A --check --watch ./src/index.ts"
12+
},
13+
"lint": {
14+
"description": "Run the linting tool.",
15+
"command": "deno lint"
16+
},
17+
"test": {
18+
"description": "Run the test suite.",
19+
"command": "deno test -A --check --permit-no-files --reload --doc --junit-path=\"./reports/report.xml\""
20+
}
21+
},
22+
"compilerOptions": {
23+
"allowJs": false,
24+
"lib": [
25+
"deno.ns",
26+
"deno.window",
27+
"deno.worker",
28+
"decorators",
29+
"esnext"
30+
]
31+
},
32+
"test": {
33+
"include": [
34+
"./src/**/*.test.ts"
35+
]
36+
},
37+
"lint": {
38+
"rules": {
39+
"tags": [
40+
"recommended"
41+
],
42+
"include": [
43+
"camelcase",
44+
"default-param-last",
45+
"eqeqeq",
46+
"explicit-function-return-type",
47+
"explicit-module-boundary-types",
48+
"guard-for-in",
49+
"no-eval",
50+
"no-sparse-arrays",
51+
"prefer-ascii"
52+
],
53+
"exclude": [
54+
"no-inferrable-types"
55+
]
56+
}
57+
},
58+
"fmt": {
59+
"semiColons": true,
60+
"singleQuote": true,
61+
"trailingCommas": "never",
62+
"lineWidth": 120,
63+
"typeLiteral.separatorKind": "comma",
64+
"useBraces": "always"
65+
}
66+
}

‎docs/DOCS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎src/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

0 commit comments

Comments
 (0)