@gesslar/bedoc 1.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/package.json +1 -1
- package/src/core/Configuration.js +6 -0
package/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
# BeDoc
|
|
2
|
-
|
|
3
1
|
[](https://github.com/gesslar/BeDoc/actions/workflows/codeql.yml)
|
|
4
2
|
[](https://github.com/gesslar/BeDoc/actions/workflows/dependabot/dependabot-updates)
|
|
5
3
|
[](https://github.com/gesslar/BeDoc/actions/workflows/autopr-dev.yml)
|
|
6
4
|
|
|
7
|
-
|
|
8
5
|
# BeDoc
|
|
9
6
|
|
|
10
|
-
**BeDoc** is a powerful, pluggable documentation generator designed to handle
|
|
7
|
+
**BeDoc** is a powerful, pluggable documentation generator designed to handle
|
|
8
|
+
any programming language and output format. With its extensible framework, you
|
|
9
|
+
can easily create custom parsers and printers to generate structured
|
|
10
|
+
documentation for your projects.
|
|
11
11
|
|
|
12
12
|
---
|
|
13
13
|
|
|
@@ -35,13 +35,13 @@
|
|
|
35
35
|
Install BeDoc globally using NPM:
|
|
36
36
|
|
|
37
37
|
```bash
|
|
38
|
-
npm
|
|
38
|
+
npm i -g @gesslar/bedoc
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
Or add it to your project as a dev dependency:
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
|
-
npm
|
|
44
|
+
npm i -D @gesslar/bedoc
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
---
|
package/package.json
CHANGED
|
@@ -159,6 +159,12 @@ export default class Configuration {
|
|
|
159
159
|
options.packageJson = {value: jsonObj, source}
|
|
160
160
|
}
|
|
161
161
|
|
|
162
|
+
// Add defaults which are missing
|
|
163
|
+
for(const [key, param] of Object.entries(ConfigurationParameters)) {
|
|
164
|
+
if(options[key] === undefined && param.default !== undefined)
|
|
165
|
+
options[key] = {value: param.default, source: "default"}
|
|
166
|
+
}
|
|
167
|
+
|
|
162
168
|
return options
|
|
163
169
|
}
|
|
164
170
|
|