Skip to content
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
4 changes: 4 additions & 0 deletions .config/typedoc.config.mjs
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC

import {footnote} from "@mdit/plugin-footnote"
import {tasklist} from "@mdit/plugin-tasklist";
import typedoc from "typedoc/package.json" with { type: "json" }
Expand Down
4 changes: 4 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
#
# SPDX-License-Identifier: ISC

# This is EditorConfig, utilized by many editors.
# It also defines some of rules like line endings for this project.
#
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/node.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
#
# SPDX-License-Identifier: ISC

name: Node.js CI/CD

on:
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/typedoc.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
#
# SPDX-License-Identifier: ISC

# Simple workflow for deploying TypeDoc to GitHub Pages
name: Deploy TypeDoc to Pages

Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
#
# SPDX-License-Identifier: ISC

# Ignore modules downloaded by package manager
node_modules/
# Ignore generated files
Expand All @@ -10,6 +14,7 @@ cache/
# Ignore lockfiles other than NPM ones
*lock*
!package-lock.json
!package-lock.json.license
# Ignore local packages
*.tgz
# Ignore typedoc files
Expand Down
4 changes: 4 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
#
# SPDX-License-Identifier: ISC

.*/
docs/
test/
Expand Down
4 changes: 4 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
; SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
;
; SPDX-License-Identifier: ISC

lockfile-version=3
3 changes: 3 additions & 0 deletions .oxlintrc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC
{
"$schema": "./node_modules/oxlint/configuration_schema.json",
"plugins": [
Expand Down
20 changes: 0 additions & 20 deletions COPYING

This file was deleted.

2 changes: 1 addition & 1 deletion shared/tsconfig/LICENSE → LICENSE.ISC
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ISC License

Copyright (C) 2025 Dawid Papiewski "SpacingBat3"
Copyright (C) 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
Expand Down
2 changes: 1 addition & 1 deletion example/LICENSE → LICENSE.Unlicense
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>
For more information, please refer to <https://unlicense.org/>
1 change: 1 addition & 0 deletions LICENSES/ISC.txt
1 change: 1 addition & 0 deletions LICENSES/Unlicense.txt
21 changes: 15 additions & 6 deletions docs/Readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

SPDX-License-Identifier: ISC
-->

<div align="right">

[![CodeCov](https://codecov.io/gh/SpacingBat3/ReForged/graph/badge.svg?token=83BCHPFQHS)](https://codecov.io/gh/SpacingBat3/ReForged)
Expand Down Expand Up @@ -39,12 +45,15 @@ project are:

## License

For information on which software licenses may the ReForged project be
distributed, see [`COPYING`](../COPYING) file.
This project follows [REUSE] specification to match copyrighted material
to software licenses and copyright. You might see overall list of
licenses used in this project in [`LICENSES/`] folder.

[^1]: Partially implemented; no official Forge API for representation yet.

[AppImage]: https://appimage.org
[forge]: https://github.com/electron/forge
[maker1]: https://www.npmjs.com/package/@reforged/maker-appimage
[plugin1]: https://www.npmjs.com/package/@reforged/plugin-launcher
[AppImage]: https://appimage.org
[forge]: https://github.com/electron/forge
[maker1]: https://www.npmjs.com/package/@reforged/maker-appimage
[plugin1]: https://www.npmjs.com/package/@reforged/plugin-launcher
[REUSE]: https://reuse.software/
[`LICENSES/`]: ../LICENSES/
6 changes: 6 additions & 0 deletions docs/Troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

SPDX-License-Identifier: ISC
-->

# Troubleshooting ReForged project

This document describes necessary steps to properly troubleshoot ReForged
Expand Down
5 changes: 5 additions & 0 deletions example/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: NONE
# SPDX-FileContributor: SpacingBat3 <spacingbat3@gmail.com>
#
# SPDX-License-Identifier: Unlicense

### Generated by electron-forge template

# Logs
Expand Down
5 changes: 5 additions & 0 deletions example/forge.config.mts
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
// SPDX-FileCopyrightText: NONE
// SPDX-FileContributor: SpacingBat3 <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: Unlicense

import type { ForgeConfig } from "@electron-forge/shared-types";
import MakerAppImage from "@reforged/maker-appimage";
import PluginLauncher from "@reforged/plugin-launcher";
Expand Down
2 changes: 1 addition & 1 deletion example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"lint": "oxlint"
},
"author": "SpacingBat3 <git@spacingbat3.anonaddy.com> (https://github.com/SpacingBat3)",
"license": "UNLICENSE",
"license": "Unlicense",
"repository": {
"type": "git",
"url": "git+https://github.com/SpacingBat3/ReForged.git"
Expand Down
4 changes: 4 additions & 0 deletions example/package.json.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
SPDX-FileCopyrightText: NONE
SPDX-FileContributor: SpacingBat3 <spacingbat3@gmail.com>

SPDX-License-Identifier: Unlicense
7 changes: 7 additions & 0 deletions example/src/index.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
/*
* SPDX-FileCopyrightText: NONE
* SPDX-FileContributor: SpacingBat3 <spacingbat3@gmail.com>
*
* SPDX-License-Identifier: Unlicense
*/

body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica,
Arial, sans-serif;
Expand Down
7 changes: 7 additions & 0 deletions example/src/index.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
<!--
SPDX-FileCopyrightText: NONE
SPDX-FileContributor: SpacingBat3 <spacingbat3@gmail.com>

SPDX-License-Identifier: Unlicense
-->

<!DOCTYPE html>
<html>
<head>
Expand Down
5 changes: 5 additions & 0 deletions example/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
// SPDX-FileCopyrightText: NONE
// SPDX-FileContributor: SpacingBat3 <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: Unlicense

import Electron = require('electron');
import path = require('node:path');

Expand Down
4 changes: 4 additions & 0 deletions example/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: NONE
// SPDX-FileContributor: SpacingBat3 <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: Unlicense
{
"extends": "@reforged/tsconfig",
"compilerOptions": {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ISC License

Copyright (C) 2025 Dawid Papiewski "SpacingBat3"
Copyright (C) 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
Expand Down
6 changes: 6 additions & 0 deletions makers/appimage/Readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

SPDX-License-Identifier: ISC
-->

# `@reforged/maker-appimage`

A simple, asynchronous [AppImage][5] maker for the [Electron Forge][1].
Expand Down
3 changes: 3 additions & 0 deletions makers/appimage/package.json.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

SPDX-License-Identifier: ISC
4 changes: 4 additions & 0 deletions makers/appimage/src/image.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC

import type {IconSet, MakerUnixOptions} from "@reforged/maker-types"
import { copyFile, mkdir, readFile, symlink } from "node:fs/promises";
import { extname, join, relative } from "node:path";
Expand Down
4 changes: 4 additions & 0 deletions makers/appimage/src/main.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC

(process as {setSourceMapsEnabled?:(arg0:boolean)=>void}).setSourceMapsEnabled?.(true);

import { resolve, relative, basename } from "path";
Expand Down
4 changes: 4 additions & 0 deletions makers/appimage/src/utils.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC

import EventEmitter from "events";
import { existsSync } from "fs";
import { mkdtemp, readFile, rm } from "fs/promises";
Expand Down
4 changes: 4 additions & 0 deletions makers/appimage/test/make.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC

/*
* Test current maker from perspective of 'make' process.
* ---
Expand Down
3 changes: 3 additions & 0 deletions makers/appimage/test/res/empty_1024x1024.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

SPDX-License-Identifier: ISC
5 changes: 5 additions & 0 deletions makers/appimage/test/res/empty_scalable.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions makers/appimage/test/struct.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC

/*
* Test current maker from perspective of its structure, aiding what's
* currently tested by TypeScript and precising the expectancies in APIs
Expand Down
3 changes: 3 additions & 0 deletions makers/appimage/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC
{
"extends": "@reforged/tsconfig",
"compilerOptions": {
Expand Down
4 changes: 4 additions & 0 deletions makers/appimage/tsconfig.test.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC

{
"extends": "@reforged/tsconfig",
"compilerOptions": {
Expand Down
4 changes: 4 additions & 0 deletions makers/appimage/types/config.d.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC

import {MakerConfig, MakerUnixOptions} from "@reforged/maker-types"

interface MakerAppImageConfigOptions extends MakerUnixOptions {
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

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

3 changes: 3 additions & 0 deletions package-lock.json.license

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

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@
"@electron/rebuild": "^4.0.0",
"extract-zip": "npm:@electron-internal/extract-zip@latest"
},
"license": "(ISC AND UNLICENSE)"
"license": "(ISC AND Unlicense)"
}
3 changes: 3 additions & 0 deletions package.json.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2022-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

SPDX-License-Identifier: ISC
3 changes: 3 additions & 0 deletions plugins/launcher/.config/typedoc.mjs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2025-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC

import { OptionDefaults } from "typedoc"
/** @type {import("typedoc").TypeDocOptions}*/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ISC License

Copyright (C) 2022-2025 Dawid Papiewski "SpacingBat3"
Copyright (C) 2025-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
Expand Down
6 changes: 6 additions & 0 deletions plugins/launcher/Readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2025-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

SPDX-License-Identifier: ISC
-->

# `@reforged/plugin-launcher`

An [Electron Forge][1] plugin to wrap [Electron][2] applications into
Expand Down
3 changes: 3 additions & 0 deletions plugins/launcher/package.json.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2025-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>

SPDX-License-Identifier: ISC
4 changes: 4 additions & 0 deletions plugins/launcher/src/main.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// SPDX-FileCopyrightText: 2025-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC

import { PluginBase } from "@electron-forge/plugin-base";
import type PluginLauncherConfig from "../types/config.d.ts";
import type { ForgeMultiHookMap } from "@electron-forge/shared-types";
Expand Down
3 changes: 3 additions & 0 deletions plugins/launcher/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2025-2026 Dawid Papiewski "SpacingBat3" <spacingbat3@gmail.com>
//
// SPDX-License-Identifier: ISC
{
"extends": "@reforged/tsconfig",
"compilerOptions": {
Expand Down
Loading