Skip to content

Commit

Permalink
refactor(port-hooks): move to deno 2 and refactor usages
Browse files Browse the repository at this point in the history
  • Loading branch information
TillaTheHun0 committed Oct 10, 2024
1 parent 85ff0a3 commit 64668d4
Show file tree
Hide file tree
Showing 11 changed files with 110 additions and 42 deletions.
22 changes: 15 additions & 7 deletions .github/workflows/port-hooks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,20 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
deno-version: [1.x]
deno-version: [2.x]

steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: 🦕 Setup Deno
uses: denoland/setup-deno@v1
uses: denoland/setup-deno@v2
with:
deno-version: ${{ matrix.deno-version }}

- name: ⚡ Run Tests
working-directory: packages/port-hooks
run: |
cd packages/port-hooks
deno task test
env:
CI: true
Expand All @@ -41,14 +41,22 @@ jobs:
if: startsWith(github.ref, 'refs/tags/hyper-port-hooks@')
needs: [test]
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: 🦕 Setup Deno
uses: denoland/setup-deno@v1
uses: denoland/setup-deno@v2
with:
deno-version: v1.x
deno-version: v2.x

- name: ✨ Publish to JSR
working-directory: packages/port-hooks
run: |
deno publish --allow-slow-types
# - name: 🥚 Setup Eggs CLI
# run: |
Expand Down
34 changes: 28 additions & 6 deletions packages/port-hooks/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,33 @@
# hyper63 hooks port
<h1 align="center">hyper-port-hooks</h1>
<p align="center">Port for the Hooks Service in the <a href="https://hyper.io/">hyper</a> Service Framework</p>
</p>
<p align="center">
<a href="https://nest.land/package/hyper-port-hooks"><img src="https://nest.land/badge.svg" alt="Nest Badge" /></a>
<a href="https://jsr.io/@hyper63/port-hooks"><img src="https://jsr.io/badges/@hyper63/port-hooks" alt="" /></a>
<a href="https://github.com/hyper63/hyper63/actions/workflows/port-hooks.yml"><img src="https://github.com/hyper63/hyper63/actions/workflows/port-hooks.yml/badge.svg" alt="Test" /></a>
</p>

A hyper63 port is a schema validator for implementation details. These implementation details exist
in the adapter. Using a port you can make sure that the adapter properly implements the port
correctly.
---

hyper63 port is a module that validates the schema of an adapter. In this case the hooks port
validates the schema of a hooks adapter.

<!-- toc -->

- [Usage](#usage)
- [Test](#test)
- [License](#license)

<!-- tocstop -->

## Usage

## Testing
## Test

```sh
deno task test
```

## License

## Documentation
Apache-2.0
36 changes: 36 additions & 0 deletions packages/port-hooks/deno.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"name": "@hyper63/port-hooks",
"version": "2.0.0",
"exports": "./mod.ts",
"tasks": {
"test": "deno lint && deno fmt --check && deno test --no-check",
"cache": "deno install --entrypoint mod.ts"
},
"imports": {
"zod": "npm:[email protected]",
"@std/assert": "jsr:@std/assert@1"
},
"fmt": {
"include": [
"./"
],
"lineWidth": 100,
"singleQuote": true,
"semiColons": false
},
"lint": {
"rules": {
"exclude": [
"no-slow-types"
]
}
},
"publish": {
"include": [
"*"
],
"exclude": [
"**/*.test.ts"
]
}
}
16 changes: 0 additions & 16 deletions packages/port-hooks/deno.jsonc

This file was deleted.

33 changes: 27 additions & 6 deletions packages/port-hooks/deno.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion packages/port-hooks/deps.ts

This file was deleted.

1 change: 0 additions & 1 deletion packages/port-hooks/dev_deps.ts

This file was deleted.

2 changes: 1 addition & 1 deletion packages/port-hooks/egg.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "https://x.nest.land/[email protected]/src/schema.json",
"name": "hyper-port-hooks",
"entry": "./mod.ts",
"description": "Hyper service framework port for Hooks adapters",
"description": "Port for the Hooks Service in the hyper Service Framework",
"homepage": "https://github.com/hyper63/hyper",
"repo": "https://github.com/hyper63/hyper",
"version": "2.0.0",
Expand Down
1 change: 0 additions & 1 deletion packages/port-hooks/mod.js

This file was deleted.

2 changes: 1 addition & 1 deletion packages/port-hooks/mod.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { assert } from './dev_deps.ts'
import { assert } from '@std/assert'

Deno.test('hooks', async () => {
await assert(true)
Expand Down
4 changes: 2 additions & 2 deletions packages/port-hooks/port.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { z } from './deps.ts'
import { z } from 'zod'

export const port = z.object({
// TODO: add port methods
})
}).passthrough()

export type HooksPort = z.infer<typeof port>

0 comments on commit 64668d4

Please sign in to comment.