mirror of
https://github.com/publiclab/image-sequencer.git
synced 2025-12-16 13:20:01 +01:00
Compare commits
1 Commits
dependabot
...
remove-geo
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ed6c4e2acb |
16
.github/workflows/tests.yml
vendored
16
.github/workflows/tests.yml
vendored
@@ -8,7 +8,7 @@ jobs:
|
|||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
node-version: '14'
|
node-version: '12'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
- name: Cache node modules
|
- name: Cache node modules
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
@@ -33,7 +33,7 @@ jobs:
|
|||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
node-version: '14'
|
node-version: '12'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
- name: Cache node modules
|
- name: Cache node modules
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
@@ -58,7 +58,7 @@ jobs:
|
|||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
node-version: '14'
|
node-version: '12'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
- name: Cache node modules
|
- name: Cache node modules
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
@@ -83,7 +83,7 @@ jobs:
|
|||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
node-version: '14'
|
node-version: '12'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
- name: Cache node modules
|
- name: Cache node modules
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
@@ -109,7 +109,7 @@ jobs:
|
|||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
node-version: '14'
|
node-version: '12'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
- name: Cache node modules
|
- name: Cache node modules
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
@@ -134,7 +134,7 @@ jobs:
|
|||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
node-version: '14'
|
node-version: '12'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
- name: Cache node modules
|
- name: Cache node modules
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
@@ -159,7 +159,7 @@ jobs:
|
|||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
node-version: '14'
|
node-version: '12'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
- name: Cache node modules
|
- name: Cache node modules
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
@@ -184,7 +184,7 @@ jobs:
|
|||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v2
|
uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
node-version: '14'
|
node-version: '12'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
- name: Cache node modules
|
- name: Cache node modules
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
|
|||||||
@@ -118,9 +118,9 @@ function ModuleName(options,UI) {
|
|||||||
];
|
];
|
||||||
```
|
```
|
||||||
### Running a browser-only module in node
|
### Running a browser-only module in node
|
||||||
If your module has browser specific code or you are consuming a dependency which does the `gl-context` API. We designed this api especially for web-based modules but since it runs the module in a headless browser, it supports all browser specific APIs.
|
If your module has browser specific code or you are consuming a dependency which does the `gl-context` api. We designed this api especially for webl based modules but since it runs the module in a headless browser, ti supports all browser specific APIs.
|
||||||
|
|
||||||
The API must be used in the following format
|
The api must be used in the following format
|
||||||
```js
|
```js
|
||||||
var step = this;
|
var step = this;
|
||||||
|
|
||||||
@@ -197,7 +197,7 @@ There are four events in all:
|
|||||||
* `UI.onComplete(options.step)` must be emitted whenever the output of a draw call
|
* `UI.onComplete(options.step)` must be emitted whenever the output of a draw call
|
||||||
is ready. An argument, that is the DataURL of the output image must be passed in.
|
is ready. An argument, that is the DataURL of the output image must be passed in.
|
||||||
* `UI.onRemove(options.step)` is emitted automatically and the module should not emit it.
|
* `UI.onRemove(options.step)` is emitted automatically and the module should not emit it.
|
||||||
* `UI.notify(msg,id)` must be emitted when a notification has to be produced.
|
* `UI.notify(msg,id)` must be emmited when a notification has to be produced.
|
||||||
|
|
||||||
### Name and description
|
### Name and description
|
||||||
|
|
||||||
@@ -244,7 +244,7 @@ Also, A module may have output values. These must be defined as shown above.
|
|||||||
|
|
||||||
### Progress reporting
|
### Progress reporting
|
||||||
|
|
||||||
The default "loading spinner" can be optionally overridden with a custom progress object to draw progress on the CLI, following is a basic module format for the same:
|
The default "loading spinner" can be optionally overriden with a custom progress object to draw progress on the CLI, following is a basic module format for the same:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
module.exports = function ModuleName(options,UI) {
|
module.exports = function ModuleName(options,UI) {
|
||||||
@@ -279,7 +279,7 @@ module.exports = function ModuleName(options,UI) {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `progressObj` parameter of `draw()` is not consumed unless a custom progress bar needs to be drawn, for which this default spinner should be stopped with `progressObj.stop()` and image-sequencer is informed about the custom progress bar with `progressObj.overrideFlag = true;` following which this object can be overridden with custom progress object.
|
The `progressObj` parameter of `draw()` is not consumed unless a custom progress bar needs to be drawn, for which this default spinner should be stopped with `progressObj.stop()` and image-sequencer is informed about the custom progress bar with `progressObj.overrideFlag = true;` following which this object can be overriden with custom progress object.
|
||||||
|
|
||||||
|
|
||||||
### Module example
|
### Module example
|
||||||
@@ -292,7 +292,7 @@ For help integrating, please open an issue.
|
|||||||
|
|
||||||
## Meta Module
|
## Meta Module
|
||||||
|
|
||||||
IMAGE SEQUENCER supports "meta modules" -- modules made of other modules. The syntax and structure of these meta modules is very similar to standard modules. Sequencer can also generate meta modules dynamically with the function `createMetaModule` which can be called in the following ways
|
IMAGE SEQUENCER supports "meta modules" -- modules made of other modules. The syntax and structure of these meta modules is very similar to standard modules. Sequencer can also genarate meta modules dynamically with the function `createMetaModule` which can be called in the following ways
|
||||||
|
|
||||||
```js
|
```js
|
||||||
|
|
||||||
@@ -479,13 +479,3 @@ The following shell scripts are present in the `scripts/` directory.
|
|||||||
This script is safe to use directly because it separately clones the repo in a temporary directory.
|
This script is safe to use directly because it separately clones the repo in a temporary directory.
|
||||||
|
|
||||||
Arguments: None since it is a an *interactive* script, ie it asks the user for input.
|
Arguments: None since it is a an *interactive* script, ie it asks the user for input.
|
||||||
|
|
||||||
****
|
|
||||||
|
|
||||||
# Comments
|
|
||||||
|
|
||||||
1. Methods must be described using [JSDoc comments](https://devdocs.io/jsdoc/)
|
|
||||||
2. Misc code comments should be inline unless it is a long sentence.
|
|
||||||
3. No use of continuous tenses, no pronouns.
|
|
||||||
4. No redundant comments.
|
|
||||||
5. Each comment should start with an uppercase letter and end with a full stop.
|
|
||||||
|
|||||||
10316
package-lock.json
generated
10316
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
14
package.json
14
package.json
@@ -43,7 +43,7 @@
|
|||||||
"buffer": "~6.0.2",
|
"buffer": "~6.0.2",
|
||||||
"commander": "^9.0.0",
|
"commander": "^9.0.0",
|
||||||
"compressorjs": "^1.0.5",
|
"compressorjs": "^1.0.5",
|
||||||
"data-uri-to-buffer": "^4.0.1",
|
"data-uri-to-buffer": "^3.0.0",
|
||||||
"downloadjs": "^1.4.7",
|
"downloadjs": "^1.4.7",
|
||||||
"eslint": "^8.0.0",
|
"eslint": "^8.0.0",
|
||||||
"expr-eval": "^2.0.2",
|
"expr-eval": "^2.0.2",
|
||||||
@@ -61,9 +61,9 @@
|
|||||||
"imagemin-pngquant": "^9.0.1",
|
"imagemin-pngquant": "^9.0.1",
|
||||||
"istanbul": "^0.4.5",
|
"istanbul": "^0.4.5",
|
||||||
"jasmine": "^4.0.2",
|
"jasmine": "^4.0.2",
|
||||||
"jpegtran-bin": "^7.0.0",
|
"jpegtran-bin": "^6.0.1",
|
||||||
"jquery": "^3.3.1",
|
"jquery": "^3.3.1",
|
||||||
"jsdom": "^20.0.0",
|
"jsdom": "^19.0.0",
|
||||||
"jspdf": "^2.1.1",
|
"jspdf": "^2.1.1",
|
||||||
"jsqr": "^1.1.1",
|
"jsqr": "^1.1.1",
|
||||||
"lodash": "^4.17.11",
|
"lodash": "^4.17.11",
|
||||||
@@ -96,21 +96,21 @@
|
|||||||
"grunt-contrib-uglify-es": "^3.3.0",
|
"grunt-contrib-uglify-es": "^3.3.0",
|
||||||
"grunt-contrib-watch": "^1.1.0",
|
"grunt-contrib-watch": "^1.1.0",
|
||||||
"grunt-text-replace": "^0.4.0",
|
"grunt-text-replace": "^0.4.0",
|
||||||
"husky": "^8.0.1",
|
"husky": "^7.0.0",
|
||||||
"image-filter-core": "~2.0.2",
|
"image-filter-core": "~2.0.2",
|
||||||
"image-filter-threshold": "~2.0.1",
|
"image-filter-threshold": "~2.0.1",
|
||||||
"jasmine-core": "^4.0.0",
|
"jasmine-core": "^4.0.0",
|
||||||
"jasmine-jquery": "^2.1.1",
|
"jasmine-jquery": "^2.1.1",
|
||||||
"jasmine-spec-reporter": "^7.0.0",
|
"jasmine-spec-reporter": "^7.0.0",
|
||||||
"jest": "^29.0.0",
|
"jest": "^27.0.1",
|
||||||
"jest-puppeteer": "^6.0.0",
|
"jest-puppeteer": "^6.0.0",
|
||||||
"lint-staged": "^13.0.0",
|
"lint-staged": "^12.1.3",
|
||||||
"looks-same": "^7.0.0",
|
"looks-same": "^7.0.0",
|
||||||
"matchdep": "^2.0.0",
|
"matchdep": "^2.0.0",
|
||||||
"resemblejs": "^4.0.1",
|
"resemblejs": "^4.0.1",
|
||||||
"tap-spec": "^5.0.0",
|
"tap-spec": "^5.0.0",
|
||||||
"tape": "^5.2.0",
|
"tape": "^5.2.0",
|
||||||
"tape-run": "^10.0.0",
|
"tape-run": "^9.0.0",
|
||||||
"uglify-es": "^3.3.7"
|
"uglify-es": "^3.3.7"
|
||||||
},
|
},
|
||||||
"husky": {
|
"husky": {
|
||||||
|
|||||||
Reference in New Issue
Block a user