Skip to content

Commit af37485

Browse files
committed
switch to deno
1 parent 7ff90c6 commit af37485

File tree

140 files changed

+10107
-19302
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

140 files changed

+10107
-19302
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
In the interest of fostering an open and welcoming environment, we as
66
contributors and maintainers pledge to making participation in our project and
77
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, gender identity and expression, level of experience,
9-
nationality, personal appearance, race, religion, or sexual identity and
10-
orientation.
8+
size, disability, ethnicity, gender identity and expression, level of
9+
experience, nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
1111

1212
### Our Standards
1313

@@ -30,19 +30,20 @@ Examples of unacceptable behavior by participants include:
3030
address, without explicit permission
3131
- Other conduct which could reasonably be considered inappropriate in a
3232
professional setting
33-
- Other conduct which falls outside of [NanoAPI's Open-Source Manifesto](https://github.com/Nano-API/oss-manifesto/blob/main/README.md)
33+
- Other conduct which falls outside of
34+
[NanoAPI's Open-Source Manifesto](https://github.com/Nano-API/oss-manifesto/blob/main/README.md)
3435

3536
### Our Responsibilities
3637

3738
Project maintainers are responsible for clarifying the standards of acceptable
3839
behavior and are expected to take appropriate and fair corrective action in
3940
response to any instances of unacceptable behavior.
4041

41-
Project maintainers have the right and responsibility to remove, edit, or
42-
reject comments, commits, code, wiki edits, issues, and other contributions
43-
that are not aligned to this Code of Conduct, or to ban temporarily or
44-
permanently any contributor for other behaviors that they deem inappropriate,
45-
threatening, offensive, or harmful.
42+
Project maintainers have the right and responsibility to remove, edit, or reject
43+
comments, commits, code, wiki edits, issues, and other contributions that are
44+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
45+
contributor for other behaviors that they deem inappropriate, threatening,
46+
offensive, or harmful.
4647

4748
### Scope
4849

@@ -56,20 +57,23 @@ further defined and clarified by project maintainers.
5657
### Enforcement
5758

5859
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59-
reported by contacting the project team at [[email protected]](mailto:[email protected]). All
60-
complaints will be reviewed and investigated and will result in a response that
61-
is deemed necessary and appropriate to the circumstances. The project team is
62-
obligated to maintain confidentiality with regard to the reporter of an incident.
63-
Further details of specific enforcement policies may be posted separately.
60+
reported by contacting the project team at
61+
[[email protected]](mailto:[email protected]). All complaints will be reviewed and
62+
investigated and will result in a response that is deemed necessary and
63+
appropriate to the circumstances. The project team is obligated to maintain
64+
confidentiality with regard to the reporter of an incident. Further details of
65+
specific enforcement policies may be posted separately.
6466

6567
Project maintainers who do not follow or enforce the Code of Conduct in good
6668
faith may face temporary or permanent repercussions as determined by other
6769
members of the project's leadership.
6870

6971
### Attribution
7072

71-
This Code of Conduct is adapted from the [ncc CoC](https://github.com/vercel/ncc/blob/main/CODE_OF_CONDUCT.md) which is itself adapted from the [Contributor Covenant][homepage], version 1.4,
72-
available at [http://contributor-covenant.org/version/1/4][version]
73+
This Code of Conduct is adapted from the
74+
[ncc CoC](https://github.com/vercel/ncc/blob/main/CODE_OF_CONDUCT.md) which is
75+
itself adapted from the [Contributor Covenant][homepage], version 1.4, available
76+
at [http://contributor-covenant.org/version/1/4][version]
7377

7478
[homepage]: http://contributor-covenant.org
75-
[version]: http://contributor-covenant.org/version/1/4/
79+
[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

Lines changed: 67 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# How to Contribute to NanoAPI
22

33
## Contributor License Agreement
4+
45
<!-- This section always comes first -->
5-
- By submitting code as an individual you agree to the [individual contributor license agreement](/CLA/INDIVIDUAL_CONTRIBUTOR_LICENSE_AGREEMENT.md).
6-
- By submitting code as an entity you agree to the [corporate contributor license agreement](/CLA/CORPORATE_CONTRIBUTOR_LICENSE_AGREEMENT.md).
6+
7+
- By submitting code as an individual you agree to the
8+
[individual contributor license agreement](/CLA/INDIVIDUAL_CONTRIBUTOR_LICENSE_AGREEMENT.md).
9+
- By submitting code as an entity you agree to the
10+
[corporate contributor license agreement](/CLA/CORPORATE_CONTRIBUTOR_LICENSE_AGREEMENT.md).
711

812
## Housekeeping
913

@@ -15,11 +19,16 @@ Here are some guidelines to help you get started contributing to NanoAPI.
1519
2. Check for open issues before creating a new one.
1620
3. We require an open issue for all pull requests.
1721
4. Help others by reviewing their pull requests.
18-
5. All donations we receive go directly back to our contributors. We’re here to support you when you successfully submit a PR to us. Your efforts help the community grow, and we want to give back to those who help make that possible!
22+
5. All donations we receive go directly back to our contributors. We’re here to
23+
support you when you successfully submit a PR to us. Your efforts help the
24+
community grow, and we want to give back to those who help make that
25+
possible!
1926

2027
## How to File Issues
2128

22-
Make use of the issue templates, and label your issues appropriately. If you’re unsure about which label to use, don’t worry! We will help you choose the right one.
29+
Make use of the issue templates, and label your issues appropriately. If you’re
30+
unsure about which label to use, don’t worry! We will help you choose the right
31+
one.
2332

2433
## How to Submit a Pull Request
2534

@@ -35,98 +44,118 @@ Make use of the issue templates, and label your issues appropriately. If you’r
3544
9. Follow the template and fill in all the sections.
3645
10. Wait for feedback.
3746
11. Make changes if necessary.
38-
12. Celebrate your success after your PR gets merged. The Codex Astartes supports this action.
47+
12. Celebrate your success after your PR gets merged. The Codex Astartes
48+
supports this action.
3949

40-
## Development Environment
50+
## Development Environment
4151

4252
You will need the following tools to develop NanoAPI:
4353

4454
- [Node.js](https://nodejs.org/en/) version 22 or higher.
4555

4656
### Environment Set Up
4757

48-
We use the fork-and-pull model for contributions. Here’s how you can set up your development environment:
58+
We use the fork-and-pull model for contributions. Here’s how you can set up your
59+
development environment:
4960

5061
1. Fork the repository.
5162
2. Clone your fork locally:
52-
63+
5364
```bash
5465
$ git clone https://github.com/<your_username>/napi.git
5566
```
5667

5768
3. Enter the folder:
58-
69+
5970
```bash
6071
$ cd napi
6172
```
6273

6374
4. Add the original repository as a remote:
64-
75+
6576
```bash
6677
$ git remote add upstream https://github.com/nanoapi-io/napi.git
6778
```
6879

6980
5. Install the dependencies:
70-
81+
7182
```bash
7283
$ npm install
7384
```
7485

7586
> [!NOTE]
76-
> You may encounter issues on a second or third install of dependencies. If this happens, install with `npm i --no-cache --force` to fix these issues.
87+
> You may encounter issues on a second or third install of dependencies. If this
88+
> happens, install with `npm i --no-cache --force` to fix these issues.
7789
7890
### Running the Project
7991

80-
When running locally, the shared libraries and the UI must be built before the CLI can be run.
92+
When running locally, the shared libraries and the UI must be built before the
93+
CLI can be run.
8194

8295
To build them:
8396

8497
```bash
8598
$ npm run build
8699
```
87100

88-
Next, we want to run the CLI and the UI with hot reload. You will need two terminal windows for this.
101+
Next, we want to run the CLI and the UI with hot reload. You will need two
102+
terminal windows for this.
89103

90-
1. In the first terminal, run the CLI. This command should be run in the `napi` directory with a `workdir` pointing to the project you want to work on. For example, if you want to work on Apache Airflow, run:
104+
1. In the first terminal, run the CLI. This command should be run in the `napi`
105+
directory with a `workdir` pointing to the project you want to work on. For
106+
example, if you want to work on Apache Airflow, run:
91107

92108
```bash
93109
$ npm run dev:cli -- audit view -- --workdir=/path/to/airflow
94110
```
95111

96-
Running the `audit view` command from the CLI will spin up a web server on your localhost. You can access the UI by navigating to `http://localhost:3000`.
112+
Running the `audit view` command from the CLI will spin up a web server on your
113+
localhost. You can access the UI by navigating to `http://localhost:3000`.
97114

98115
> [!NOTE]
99-
> In case of port collisions, the UI will automatically switch to the next available port.
116+
> In case of port collisions, the UI will automatically switch to the next
117+
> available port.
100118
101-
2. In the second terminal, run the UI. This command should be run in the `napi` directory as well:
119+
2. In the second terminal, run the UI. This command should be run in the `napi`
120+
directory as well:
102121

103122
```bash
104123
$ npm run dev:app
105124
```
106125

107-
This controls the hot reload functionality for the UI. You can now make changes to the UI and see them reflected in real-time.
126+
This controls the hot reload functionality for the UI. You can now make changes
127+
to the UI and see them reflected in real-time.
108128

109129
> [!IMPORTANT]
110-
> The react UI elements (sidebar, header, etc.) will automatically reload when you make changes. However any Cytoscape elements will not. You will need to refresh the page to see those changes.
130+
> The react UI elements (sidebar, header, etc.) will automatically reload when
131+
> you make changes. However any Cytoscape elements will not. You will need to
132+
> refresh the page to see those changes.
111133
112134
### Project Setup
113135

114-
You can use any project (in a supported language) to test the CLI. There are some steps that must be taken to set up the project:
136+
You can use any project (in a supported language) to test the CLI. There are
137+
some steps that must be taken to set up the project:
138+
139+
1. Clone or CD to the repo you want to work on/test with. For this example we'll
140+
use Apache Airflow.
115141

116-
1. Clone or CD to the repo you want to work on/test with. For this example we'll use Apache Airflow.
117142
```bash
118143
git clone https://github.com/apache/airflow.git
119144
cd airflow
120145
```
121146

122-
2. From the `napi` repo initialize the project using the CLI, which will create a `.napirc` file in the project root. This file contains the configuration for the project and is required for the CLI to work.:
147+
2. From the `napi` repo initialize the project using the CLI, which will create
148+
a `.napirc` file in the project root. This file contains the configuration
149+
for the project and is required for the CLI to work.:
150+
123151
```bash
124152
cd /path/to/napi # or just use a different terminal
125153
npm start -- init -- --workdir=/path/to/airflow
126154
```
127155

128156
> [!NOTE]
129-
> If you encounter any issues with the config file, you can [check the reference for the file on our documentation](https://docs.nanoapi.io/default-guide/reference/napirc).
157+
> If you encounter any issues with the config file, you can
158+
> [check the reference for the file on our documentation](https://docs.nanoapi.io/default-guide/reference/napirc).
130159
131160
### Testing
132161

@@ -142,15 +171,21 @@ $ npm run lint
142171

143172
### Release Process
144173

145-
We are currently formalizing the release process. For now, the NanoAPI team will handle making regular releases.
174+
We are currently formalizing the release process. For now, the NanoAPI team will
175+
handle making regular releases.
146176

147-
To ensure releases run smoothly, put the content of your changes in our [CHANGELOG](/packages/cli/CHANGELOG.md) file.
177+
To ensure releases run smoothly, put the content of your changes in our
178+
[CHANGELOG](/packages/cli/CHANGELOG.md) file.
148179

149180
### Documentation
150181

151-
We are also building on the documentation process. For now, include any documentation changes in your PRs and we will add them into the main documentation.
182+
We are also building on the documentation process. For now, include any
183+
documentation changes in your PRs and we will add them into the main
184+
documentation.
185+
186+
The critical documentation to maintain is for any changes that impact the
187+
following:
152188

153-
The critical documentation to maintain is for any changes that impact the following:
154189
- CLI commands
155190
- Configuration file
156191
- Local development setup
@@ -160,9 +195,10 @@ The critical documentation to maintain is for any changes that impact the follow
160195

161196
### Discussions vs Issues
162197

163-
We use GitHub Discussions for general questions, ideas, and feedback. If you have a question, please use the Discussions tab. If you have a bug report or feature request, please use the Issues tab.
198+
We use GitHub Discussions for general questions, ideas, and feedback. If you
199+
have a question, please use the Discussions tab. If you have a bug report or
200+
feature request, please use the Issues tab.
164201

165-
------
202+
---
166203

167204
That's it for this guide for now. So long, and thanks for all the fish! 🚀
168-

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,40 +9,50 @@ assignees: ''
99
<!--- Provide a general summary of the issue in the Title above -->
1010

1111
## Description
12+
1213
<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->
1314

1415
## Expected Behavior
16+
1517
<!--- Tell us what should happen -->
1618

1719
## Actual Behavior
20+
1821
<!--- Tell us what happens instead -->
1922

2023
## Possible Fix
24+
2125
<!--- Not obligatory, but suggest a fix or reason for the bug -->
2226

2327
## Steps to Reproduce
28+
2429
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
2530
<!--- reproduce this bug. Include code to reproduce, if relevant -->
31+
2632
1.
2733
2.
2834
3.
2935
4.
3036

3137
## Context
38+
3239
<!--- How has this bug affected you? What were you trying to accomplish? -->
3340

3441
## Your Environment
42+
3543
<!--- Include as many relevant details about the environment you experienced the bug in -->
36-
* Version used:
37-
* Environment name and version (e.g. Chrome 39, node.js 5.4):
38-
* Operating System and version (desktop or mobile):
39-
* Link to your project:
40-
44+
45+
- Version used:
46+
- Environment name and version (e.g. Chrome 39, node.js 5.4):
47+
- Operating System and version (desktop or mobile):
48+
- Link to your project:
49+
4150
### Config File
4251

4352
Paste your `.napirc` below
53+
4454
```json
4555
{
4656
"your": "config"
4757
}
48-
```
58+
```

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,33 @@ assignees: ''
99
<!--- Provide a general summary of the issue in the Title above -->
1010

1111
## Detailed Description
12+
1213
<!--- Provide a detailed description of the change or addition you are proposing -->
1314

1415
## Context
16+
1517
<!--- Why is this change important to you? How would you use it? -->
1618
<!--- How can it benefit other users? -->
1719

1820
## Possible Implementation
21+
1922
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
2023

2124
## Your Environment
25+
2226
<!--- Include as many relevant details about the environment you experienced the bug in -->
23-
* Version used:
24-
* Environment name and version (e.g. Chrome 39, node.js 5.4):
25-
* Operating System and version (desktop or mobile):
26-
* Link to your project:
27+
28+
- Version used:
29+
- Environment name and version (e.g. Chrome 39, node.js 5.4):
30+
- Operating System and version (desktop or mobile):
31+
- Link to your project:
2732

2833
### Config File
2934

3035
Paste your `.napirc` below
36+
3137
```json
3238
{
3339
"your": "config"
3440
}
35-
```
41+
```

0 commit comments

Comments
 (0)