build(git): resolve merge conflicts

nwutils · Oct 3, 2023 · d95db9d · d95db9d
2 parents f125be4 + 78903c4
commit d95db9d
Show file tree

Hide file tree

Showing 33 changed files with 1,559 additions and 1,436 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -3,8 +3,19 @@ updates:
   - package-ecosystem: "npm"
     directory: "."
     schedule:
-      interval: "daily"
+      interval: "weekly"
+      day: "saturday"
+    versioning-strategy: increase
+    groups:
+      npm:
+        patterns:
+          - "*"
   - package-ecosystem: "github-actions"
-    directory: ".github/"
+    directory: ".github/workflows"
     schedule:
-      interval: "daily"
+      interval: "weekly"
+      day: "saturday"
+    groups:
+      gha:
+        patterns:
+          - "*"
diff --git a/cfg/eslint.config.cjs → .github/eslint.config.cjs b/cfg/eslint.config.cjs → .github/eslint.config.cjs
@@ -8,6 +8,7 @@ module.exports = {
     node: true,
   },
   extends: ["eslint:recommended", "tjw-jsdoc"],
+  ignorePatterns: ["node_modules", "build", "cache", "dist", "out"],
   rules: {
     "jsdoc/require-file-overview": "off",
     "jsdoc/require-returns-description": "off",

diff --git a/cfg/fswatch.config.js → .github/fswatch.config.js b/cfg/fswatch.config.js → .github/fswatch.config.js
@@ -8,7 +8,7 @@ try {
 
   for await (const event of watcher) {
     if (event) {
-      exec("node cfg/jsdoc.config.cjs");
+      exec("node .github/jsdoc.config.cjs");
     }
   }
 } catch (e) {

diff --git a/cfg/jsdoc.config.cjs → .github/jsdoc.config.cjs b/cfg/jsdoc.config.cjs → .github/jsdoc.config.cjs
@@ -1,69 +1,47 @@
-const { writeFile } = require("node:fs/promises");
-
-const jsdoc2md = require("jsdoc-to-markdown");
-
-jsdoc2md
-    .render({
-        files: "src/get.js",
-    })
-    .then(async (output) => {
-        await writeFile("doc/mode-get.md", output);
-    })
-    .catch((error) => {
-        console.log(error);
-    });
-
-jsdoc2md
-    .render({
-        files: "src/run.js",
-    })
-    .then(async (output) => {
-        await writeFile("doc/mode-run.md", output);
-    })
-    .catch((error) => {
-        console.log(error);
-    });
-
-jsdoc2md
-    .render({
-        files: "src/index.js",
-    })
-    .then(async (output) => {
-        await writeFile("doc/api.md", output);
-    })
-    .catch((error) => {
-        console.log(error);
-    });
-
-jsdoc2md
-    .render({
-        files: "src/bld/linuxCfg.js",
-    })
-    .then(async (output) => {
-        await writeFile("doc/api-nux.md", output);
-    })
-    .catch((error) => {
-        console.log(error);
-    });
-
-jsdoc2md
-    .render({
-        files: "src/bld/winCfg.js",
-    })
-    .then(async (output) => {
-        await writeFile("doc/api-win.md", output);
-    })
-    .catch((error) => {
-        console.log(error);
-    });
-
-jsdoc2md
-    .render({
-        files: "src/bld/osxCfg.js",
-    })
-    .then(async (output) => {
-        await writeFile("doc/api-osx.md", output);
-    })
-    .catch((error) => {
-        console.log(error);
-    });
+const { writeFile } = require("node:fs/promises");
+
+const jsdoc2md = require("jsdoc-to-markdown");
+
+jsdoc2md
+    .render({
+        files: "src/index.js",
+    })
+    .then(async (output) => {
+        await writeFile("doc/index.md", output);
+    })
+    .catch((error) => {
+        console.log(error);
+    });
+
+jsdoc2md
+    .render({
+        files: "src/build.js",
+    })
+    .then(async (output) => {
+        await writeFile("doc/mode-build.md", output);
+    })
+    .catch((error) => {
+        console.log(error);
+    });
+
+jsdoc2md
+    .render({
+        files: "src/get.js",
+    })
+    .then(async (output) => {
+        await writeFile("doc/mode-get.md", output);
+    })
+    .catch((error) => {
+        console.log(error);
+    });
+
+jsdoc2md
+    .render({
+        files: "src/run.js",
+    })
+    .then(async (output) => {
+        await writeFile("doc/mode-run.md", output);
+    })
+    .catch((error) => {
+        console.log(error);
+    });
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -8,14 +8,14 @@ jobs:
   doc:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3.3.0
-      - uses: actions/setup-node@v3.6.0
+      - uses: actions/checkout@v4.1.0
+      - uses: actions/setup-node@v3.8.1
         with:
-          node-version: "20.5.0"
+          node-version: 18
       - name: Install Node modules
         run: npm ci
       - name: Convert JSDoc to Markdown
-        run: node cfg/jsdoc.config.cjs
+        run: node .github/jsdoc.config.cjs
       - name: Build documentation
         run: npm run doc:bld
       - name: Publish documentation to GitHub Pages

diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
@@ -4,32 +4,37 @@ on:
   pull_request:
     branches: [main]
 
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   e2e:
     strategy:
       matrix:
-        include:
-          - { os: macos-12, shell: bash }
-          - { os: ubuntu-22.04, shell: bash }
-          - { os: windows-2022, shell: powershell }
-          # https://github.com/orgs/community/discussions/27143
+        os: [macos-12, ubuntu-22.04, windows-2022]
+        node: [16, 18, 20]
       fail-fast: false
     runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        shell: ${{ matrix.shell }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3.3.0
+        uses: actions/checkout@v4.1.0
       - name: Setup Node
-        uses: actions/setup-node@v3.6.0
+        uses: actions/setup-node@v3.8.1
         with:
-          node-version: "20.5.0"
+          node-version: ${{ matrix.node }}
           cache: "npm"
-      - run: corepack enable
-      - run: npm ci
-      - run: npm run ci:fmt
-      - run: npm run ci:lnt
-      - run: npm link nw-builder
-      - run: npm run test:unit
-      - run: npm run test:e2e
+      - name: Enable corepack
+        run: corepack enable
+      - name: Install dependencies
+        run: npm ci
+      - name: Check for formatting errors
+        run: npm run ci:fmt
+      - name: Check for linting errors
+        run: npm run ci:lnt
+      - name: Link module
+        run: npm link nw-builder
+      - name: Run unit tests
+        run: npm run test:unit
+      - name: Run Selenium tests
+        run: npm run test:e2e
diff --git a/.github/workflows/npm.yml b/.github/workflows/npm.yml
@@ -8,12 +8,12 @@ jobs:
   npm:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3.3.0
-      - uses: actions/setup-node@v3.6.0
+      - uses: actions/checkout@v4.1.0
+      - uses: actions/setup-node@v3.8.1
         with:
-          node-version: "20.5.0"
+          node-version: 18
 
       - run: npm ci
-      - uses: JS-DevTools/[email protected].1
+      - uses: JS-DevTools/[email protected].2
         with:
           token: ${{ secrets.NPM_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,5 @@ coverage
 cache
 build
 dist
-doc/api*.md
-doc/mode-get.md
+doc/*.md
 out
diff --git a/changelog.md → CHANGELOG.md b/changelog.md → CHANGELOG.md
@@ -7,6 +7,34 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Changed
+
+- Auto generate docs from JSDoc comments.
+- Improve TypeScript type definitions.
+- Fix get mode.
+- Refactor build mode.
+- Generate markdown docs from JSDocs.
+
+## [4.4.1] - 2023-09-06
+
+### Changed
+
+- Improve debug logging.
+- Fixed handling of argv.
+
+## [4.4.0] - 2023-09-05
+
+### Added
+
+- Cache community FFmpeg.
+- Move FFmpeg decompress function to relevant location
+
+## [4.3.11] - 2023-09-05
+
+### Changed
+
+- Separate download logic for NW.js and FFmpeg.
+
 ## [4.3.10] - 2023-08-21
 
 ### Removed

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Steffen Müller
+Copyright (c) 2021-2023 NW.js Utilities
+Copyright (c) 2014-2021 Steffen Müller
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in