@antora/playbook-builder - npm Package Compare versions

Comparing version 1.0.0-alpha.1 to 1.0.0-alpha.2

lib/build-playbook.js

@@ -9,3 +9,3 @@ 'use strict'
 const json = require('json5')
-const path = require('path')
+const ospath = require('path')
 const yaml = require('js-yaml')
@@ -37,4 +37,4 @@
   if (specFileRelPath) {
-    let specFileAbsPath = path.resolve(process.cwd(), specFileRelPath)
-    if (path.extname(specFileAbsPath)) {
+    let specFileAbsPath = ospath.resolve(specFileRelPath)
+    if (ospath.extname(specFileAbsPath)) {
       if (!fs.existsSync(specFileAbsPath)) throw new Error('playbook spec file does not exist')
@@ -67,3 +67,3 @@ } else if (fs.existsSync(specFileAbsPath + '.yml')) {
 
-  switch (path.extname(specFilePath)) {
+  switch (ospath.extname(specFilePath)) {
     case '.yml':
@@ -70,0 +70,0 @@ return yaml.safeLoad(data)

lib/config/schema.js

@@ -0,1 +1,3 @@
+'use strict'
+
 module.exports = {
@@ -11,3 +13,3 @@ playbook: {
     url: {
-      doc: 'The base URL of the published site. Should not include a trailing slash.',
+      doc: 'The base URL of the published site. Should not include trailing slash.',
       format: String,
@@ -55,2 +57,7 @@ default: undefined,
   content: {
+    branches: {
+      doc: 'The default branch pattern to use when no specific pattern is provided',
+      format: Array,
+      default: ['v*', 'master'],
+    },
     sources: {
@@ -60,9 +67,3 @@ doc: 'The list of git repositories + branch patterns to use.',
       default: [],
-      env: 'CONTENT_SOURCES',
     },
-    branches: {
-      doc: 'The default branch pattern to use when no specific pattern is provided',
-      format: Array,
-      default: ['v*', 'master'],
-    },
   },
@@ -126,2 +127,21 @@ ui: {
   },
+  output: {
+    clean: {
+      doc: 'Remove destination path before publishing (fs only).',
+      format: Boolean,
+      default: false,
+      arg: 'clean',
+    },
+    dir: {
+      doc: 'The directory where the site should be published. (default: build/site)',
+      format: String,
+      default: undefined,
+      arg: 'to-dir',
+    },
+    destinations: {
+      doc: 'A list of destinations where the generated site should be published.',
+      format: Array,
+      default: undefined,
+    },
+  },
 }

package.json

 {
   "name": "@antora/playbook-builder",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.2",
   "description": "Builds a playbook object from user input for configuring successive documentation components in an Antora pipeline.",
   "license": "MPL-2.0",
-  "author": {
-    "name": "OpenDevise Inc.",
-    "url": "https://opendevise.com"
-  },
+  "author": "OpenDevise Inc. (https://opendevise.com)",
+  "contributors": [
+    "Dan Allen <[e-mail]>",
+    "Sarah White <[e-mail]>",
+    "Hubert SABLONNIÈRE <[e-mail]>"
+  ],
   "homepage": "https://antora.org",
@@ -19,5 +21,6 @@ "repository": "gitlab:antora/antora",
     "convict": "^4.0.2",
-    "cson-parser": "^2.0.0",
+    "cson-parser": "^2.0.1",
     "deep-freeze": "^0.0.1",
-    "js-yaml": "^3.10.0"
+    "js-yaml": "^3.10.0",
+    "json5": "^0.5.1"
   },
@@ -24,0 +27,0 @@ "engines": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9767

increased by10.2%

Lines of code

258

increased by7.95%

Number of lines in readme file

13

increased by85.71%

Worsened metrics

Dependency count

6

increased by20%

Dependency changes

• + Addedjson5@^0.5.1

• + Addedjson5@0.5.1(transitive)

• Updatedcson-parser@^2.0.1