Skip to content

Commit

Permalink
Update for node 22
Browse files Browse the repository at this point in the history
  • Loading branch information
raub committed Nov 2, 2024
1 parent 8dc4412 commit 5e30cac
Show file tree
Hide file tree
Showing 14 changed files with 419 additions and 280 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] ___ doesn't work"
labels: bug
assignees: raub

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. ___
2. ___
3. ___

**Expected behavior**
Description of what you expected to happen.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEAT] ____"
labels: new
assignees: raub

---

**Describe the solution you'd like**
Description of what you want to happen.

**Describe alternatives you've considered**
Description of alternative solutions or features you've considered.
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Description
<!-- A concise description of what the PR does. -->


## Test Plan
<!-- How can a reviewer test the changes included in this PR? -->
1.
2.
3.


## Checklist
<!-- Ensure that your PR fulfills the following requirements -->
- [ ] I've followed the code style.
- [ ] I've tried running the code with my changes.
- [ ] The docs and TS declarations are in sync with code changes.
- [ ] (optional) I've added unit tests for my changes.
8 changes: 4 additions & 4 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 20.14.0
node-version: 22.9.0
cache: 'npm'

- name: Get Package Version
Expand All @@ -47,7 +47,7 @@ jobs:
name: Build
strategy:
matrix:
os: [ubuntu-22.04, windows-2022, macos-12, macos-14, [self-hosted, linux, ARM64]]
os: [ubuntu-22.04, windows-2022, macos-14, [self-hosted, linux, ARM64]]

runs-on: ${{ matrix.os }}

Expand All @@ -61,14 +61,14 @@ jobs:
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 20.14.0
node-version: 22.9.0
cache: 'npm'

- name: Install Modules
run: npm ci

- name: Fix Python
if: matrix.os == 'macos-12' || matrix.os == 'macos-14'
if: matrix.os == 'macos-14'
run: pip install setuptools

- name: Build Current Binary
Expand Down
7 changes: 1 addition & 6 deletions .github/workflows/cpplint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,12 @@ jobs:
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 20.14.0
node-version: 22.9.0
cache: 'npm'

- name: Install Modules
run: npm ci

- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.12'

- name: Install Cpplint
run: pip install cpplint

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/eslint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 20.14.0
node-version: 22.9.0
cache: 'npm'

- name: Install Modules
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 20.14.0
node-version: 22.9.0
cache: 'npm'

- name: Get Package Version
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
name: Unit Tests
strategy:
matrix:
os: [ubuntu-22.04, windows-2022, macos-12, macos-14, [self-hosted, linux, ARM64]]
os: [ubuntu-22.04, windows-2022, macos-14, [self-hosted, linux, ARM64]]

runs-on: ${{ matrix.os }}

Expand All @@ -30,14 +30,14 @@ jobs:
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 20.14.0
node-version: 22.9.0
cache: 'npm'

- name: Install Modules
run: npm ci

- name: Fix Python
if: matrix.os == 'macos-12' || matrix.os == 'macos-14'
if: matrix.os == 'macos-14'
run: pip install setuptools

- name: Build Current Binary
Expand Down
18 changes: 18 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Code of Conduct

We pledge to act and interact in ways that contribute to an open and healthy community.

## Our Standards

Examples of unacceptable behavior:

* The use of sexualized language or imagery
* Trolling, insulting or derogatory comments
* Public or private harassment
* Publishing others' private information
* Other unprofessional conduct

## Enforcement

Community leaders will remove, edit, or reject
contributions that are not aligned to this Code of Conduct.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contributing

Bugs and enhancements are tracked as GitHub issues.

## Issues

* Use a clear and descriptive title.
* Describe the desired enhancement / problem.
* Provide examples to demonstrate the issue.
* If the problem involves a crash, provide its trace log.

## Pull Requests

* Do not include issue numbers in the PR title.
* Commits use the present tense (`"Add feature"` not `"Added feature"`).
* Commits use the imperative mood (`"Move cursor to..."` not `"Moves cursor to..."`).
* File System
* Prefer kebab-lowercase (`my-dir/example-file-name.js`).
* Place an empty `.keep` file to keep an empty directory.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ npm i -s glfw-raub

**Node.js** addon with **GLFW3** bindings.

> Note: this **addon uses N-API**, and therefore is ABI-compatible across different
Node.js versions. Addon binaries are precompiled and **there is no compilation**
step during the `npm i` command.

![Example](examples/screenshot.jpg)

* **GLFW** version **3.4.0** backend.
Expand All @@ -26,6 +22,10 @@ step during the `npm i` command.
* Has `Window` class, simplifying low-level interactions.
* Has `Document` class, capable of tricking other libs, as if we are in a browser.

> Note: this **addon uses N-API**, and therefore is ABI-compatible across different
Node.js versions. Addon binaries are precompiled and **there is no compilation**
step during the `npm i` command.


## GLFW

Expand Down
11 changes: 11 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Security Policy

## Supported Versions

Latest major version.

## Reporting a Vulnerability

Email: [email protected].

Telegram: [luisblanco_0](https://t.me/luisblanco_0)
Loading

0 comments on commit 5e30cac

Please sign in to comment.