Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maintenance upgrade #17

Merged
merged 14 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/depandabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "weekly"

- package-ecosystem: "github-actions"
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
directory: "/"
schedule:
interval: "weekly"
29 changes: 16 additions & 13 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,27 @@ on:
- pull_request

jobs:
tests:
strategy:
matrix:
node:
- 16.x
check-and-test:
runs-on: ubuntu-20.04

runs-on: ubuntu-latest
name: Node.js ${{ matrix.node }}
steps:
- uses: actions/checkout@v3
- name: Checkout repository
uses: actions/checkout@v4

- name: Use Node.js ${{ matrix.node }}
uses: actions/setup-node@v3
- name: Use Node.js from .nvmrc
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node }}
- uses: actions/cache@v3
node-version-file: ".nvmrc"

- name: Get npm cache directory
id: npm-cache-dir
shell: bash
run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}

- uses: actions/cache@v4
id: npm-cache # use this to check for `cache-hit` ==> if: steps.npm-cache.outputs.cache-hit != 'true'
with:
path: ~/.npm
path: ${{ steps.npm-cache-dir.outputs.dir }}
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
Expand Down
35 changes: 35 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Build JsfeatNext
on:
- push
- pull_request

jobs:
check-and-test:
runs-on: ubuntu-20.04
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Use Node.js from .nvmrc
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"

- name: Get npm cache directory
id: npm-cache-dir
shell: bash
run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}

- uses: actions/cache@v4
id: npm-cache # use this to check for `cache-hit` ==> if: steps.npm-cache.outputs.cache-hit != 'true'
with:
path: ${{ steps.npm-cache-dir.outputs.dir }}
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-

- name: Install
run: |
npm install
- name: Build
run: npm run build-ts
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v20.18.0
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
![github stars](https://flat.badgen.net/github/stars/webarkit/jsfeatNext)
![github forks](https://flat.badgen.net/github/forks/webarkit/jsfeatNext)
![npm package version](https://flat.badgen.net/npm/v/@webarkit/jsfeat-next)
![Dependabot Badge](https://flat.badgen.net/dependabot/thepracticaldev/dev.to?icon=dependabot)
![Dependabot Badge](https://flat.badgen.net/dependabot/@webarkit/jsfeat-next?icon=dependabot)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![CI](https://github.com/webarkit/ARnft/actions/workflows/CI.yml/badge.svg)](https://github.com/webarkit/jsfeatNext/actions/workflows/CI.yml)
![twitter](https://flat.badgen.net/twitter/follow/WebarkitO)

# jsfeatNext
# jsfeatNext 🚀

A testing repository to develop a ES6 version of [jsfeat](https://github.com/inspirit/jsfeat) for the WebARKit project. Consider that this is a test and many things may changes during the development. I will provide some examples for testing.

## List of features
## List of features

- Typescript definitions

Expand All @@ -21,7 +21,7 @@ A testing repository to develop a ES6 version of [jsfeat](https://github.com/ins

- npm package

## Classes
## Classes 📚
These public classes were implemented:
- cache
- fast_corners
Expand All @@ -40,17 +40,17 @@ These public classes were implemented:
- yape
- yape06

## npm package
## npm package 📦
You can install the package with:

`npm install @webarkit/jsfeat-next`

Consider that the package is not well tested and many bugs may arise...

## Future features
## Future features 🔮
Not all the original classes from jsfeat are yet implemented, this will be done in a near future.

## Examples
## Examples 🧪
Go in the examples folder to test some of them.

working = ✔️ not working = ⚠️
Expand Down Expand Up @@ -78,10 +78,10 @@ working = ✔️ not working = ⚠️
- sample_yape.html ✔️
- sample_yape06.html ✔️

## Typescript examples
## Typescript examples 📝

You can find some Typescript examples in this repository [jsfeatNext-examples](https://github.com/webarkit/jsfeatNext-examples).

## Documentation
## Documentation 📖

There is not yet an official JsfeatNext documentation but you can read the [original jsfeat docs](https://inspirit.github.io/jsfeat/) to have an idea of classes and functions. We tried to be much close as possible to the original code, so if it works on **jsfeat** it will works on **jsfeatNext**.
2 changes: 1 addition & 1 deletion dist/jsfeatNext.js

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions dist/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@
},
"homepage": "https://github.com/webarkit/jsfeatNext#readme",
"devDependencies": {
"@babel/core": "^7.21.0",
"@babel/plugin-transform-runtime": "^7.21.0",
"@babel/preset-env": "^7.20.2",
"babel-loader": "^9.1.2",
"rimraf": "^4.1.3",
"typescript": "^4.9.5",
"webpack": "^5.75.0",
"webpack-cli": "^5.0.1"
"@babel/core": "^7.26.0",
"@babel/plugin-transform-runtime": "^7.25.9",
"@babel/preset-env": "^7.26.0",
"babel-loader": "^9.2.1",
"rimraf": "^6.0.1",
"typescript": "^5.6.3",
"webpack": "5.96.1",
"webpack-cli": "^5.1.4"
},
"dependencies": {
"@babel/runtime": "^7.20.1",
"prettier": "^2.8.4",
"ts-loader": "^9.4.2"
"@babel/runtime": "^7.26.0",
"prettier": "^3.3.3",
"ts-loader": "^9.5.1"
}
}
6 changes: 3 additions & 3 deletions dist/src/cache/cache.js

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

2 changes: 1 addition & 1 deletion dist/src/cache/cache.js.map

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

2 changes: 1 addition & 1 deletion dist/src/data_type/data_type.js.map

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

4 changes: 2 additions & 2 deletions dist/src/fast_corners/fast_private.js

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

2 changes: 1 addition & 1 deletion dist/src/fast_corners/fast_private.js.map

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

8 changes: 4 additions & 4 deletions dist/src/imgproc/convol.js

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

Loading