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

refactor: build mode #951

Merged
merged 18 commits into from
Sep 22, 2023
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ cache
build
dist
doc/api*.md
doc/mode-get.md
doc/mode-*.md
out
43 changes: 5 additions & 38 deletions cfg/jsdoc.config.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ const jsdoc2md = require("jsdoc-to-markdown");

jsdoc2md
.render({
files: "src/get_nwjs.js",
files: "src/build.js",
})
.then(async (output) => {
await writeFile("doc/mode-get-nwjs.md", output);
await writeFile("doc/mode-build.md", output);
})
.catch((error) => {
console.log(error);
});

jsdoc2md
jsdoc2md
.render({
files: "src/get_ffmpeg.js",
files: "src/get.js",
})
.then(async (output) => {
await writeFile("doc/mode-get-ffmpeg.md", output);
await writeFile("doc/mode-get.md", output);
})
.catch((error) => {
console.log(error);
Expand All @@ -45,36 +45,3 @@ jsdoc2md
.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);
});
17 changes: 10 additions & 7 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,24 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

## [4.4.1] - 2023-09-06
### Changed

## Changed
- Refactor build mode.
- Generate markdown docs from JSDocs.

- improve debug logging
- move ffmpeg decompress to relevant location
- fixed handling of argv
## [4.4.1] - 2023-09-06

- Cache community FFmpeg.
### Changed

- Improve debug logging.
- Fixed handling of argv.

## [4.4.0] - 2023-09-05

## Added
### Added

- Cache community FFmpeg.
- Move FFmpeg decompress function to relevant location

## [4.3.11] - 2023-09-05

Expand Down
5 changes: 4 additions & 1 deletion doc/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ export default defineConfig({
text: "Code of Conduct",
link: "https://github.com/nwutils/.github/blob/main/CODE_OF_CONDUCT.md",
},
{ text: "License", link: "https://github.com/nwutils/nw-builder/blob/main/LICENSE" },
{
text: "License",
link: "https://github.com/nwutils/nw-builder/blob/main/LICENSE",
},
],

sidebar: [
Expand Down
77 changes: 0 additions & 77 deletions doc/mode-build.md

This file was deleted.

Loading