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: get mode #900

Merged
merged 31 commits into from
Jul 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
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
3 changes: 2 additions & 1 deletion .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ jobs:
with:
node-version: "20.2.0"
cache: "npm"
- run: corepack enable
- run: npm ci
- run: npm run fmt
- run: npm run lnt
- run: npm link
- run: npm link nw-builder
- run: npm run test:unit
- run: npm run test:e2e
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ coverage
cache
dist
doc/api*.md
doc/mode-get.md
out
tmp
58 changes: 58 additions & 0 deletions cfg/jsdoc.config.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
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/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);
});
16 changes: 10 additions & 6 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,39 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

## Changed

- Refactor `get` mode into a single file.

## [4.3.3] - 2023-07-25

## Changed
### Changed

- Set `NSHumanReadableCopyright` property in `*.app/Resources/en.lproj/InfoPlist.strings` to update copyright

## Removed
### Removed

- `NSHumanReadableCopyright` from `Info.plist`

## [4.3.2] - 2023-07-11

## Added
### Added

- Descriptions and argument types for remaining cli arguments.

## [4.3.1] - 2023-07-07

## Changed
### Changed

- Replace the icon at `nwjs.app/Contents/Resources/app.icns` with the icon at `options.app.icon` file path.

## Removed
### Removed

- `xattr` package. The `com.apple.quarantine` flag should be handled by the developer.

## [4.3.0] - 2023-07-03

## Added
### Added

- Compress `outDir` to `zip`, `tar` and `tgz` formats.
- Specify log level via `options.logLevel`.
Expand Down
124 changes: 0 additions & 124 deletions doc/mode-get.md

This file was deleted.

Loading