@antora/playbook-builder - npm Package Compare versions

Comparing version 1.0.0-alpha.4 to 1.0.0-alpha.5

lib/build-playbook.js

@@ -49,4 +49,3 @@ 'use strict'
     config.load(parseSpecFile(specFileAbsPath))
-  } else {
-    throw new Error('playbook spec file was not specified')
+    if (specFileRelPath !== specFileAbsPath) config.set('playbook', specFileAbsPath)
   }
@@ -56,3 +55,3 @@
 
-  return exportPlaybookModel(config)
+  return exportModel(config)
 }
@@ -79,5 +78,5 @@
 
-function exportPlaybookModel (config) {
+function exportModel (config) {
   const playbook = camelCaseKeys(config.getProperties(), { deep: true })
-  // playbook property is private; should not leak
+  playbook.dir = playbook.playbook ? ospath.dirname((playbook.file = playbook.playbook)) : process.cwd()
   delete playbook.playbook
@@ -84,0 +83,0 @@ return freezeDeep(playbook)

lib/config/schema.js

@@ -7,3 +7,3 @@ 'use strict'
     format: String,
-    default: 'site.yml',
+    default: undefined,
     env: 'PLAYBOOK',
@@ -13,8 +13,7 @@ arg: 'playbook',
   site: {
-    url: {
-      doc: 'The base URL of the published site. Should not include trailing slash.',
+    start_page: {
+      doc: 'The start page for the site, redirected from the site index.',
       format: String,
       default: undefined,
-      env: 'URL',
-      arg: 'url',
+      arg: 'start-page',
     },
@@ -27,17 +26,24 @@ title: {
     },
-    root: {
-      doc: 'The name of the component to use as the root of the site.',
+    url: {
+      doc: 'The base URL of the published site. Should not include trailing slash.',
       format: String,
       default: undefined,
+      env: 'URL',
+      arg: 'url',
     },
-    aspect: {
-      doc: 'The name of the aspect navigation to make available on every page in the site.',
-      format: String,
-      default: undefined,
-    },
-    nav: {
-      doc: 'The list of descriptors which define the aspect navigation domains.',
-      format: Array,
-      default: undefined,
-    },
+    //root: {
+    //  doc: 'The name of the component to use as the root of the site.',
+    //  format: String,
+    //  default: undefined,
+    //},
+    //aspect: {
+    //  doc: 'The name of the aspect navigation to make available on every page in the site.',
+    //  format: String,
+    //  default: undefined,
+    //},
+    //nav: {
+    //  doc: 'The list of descriptors which define the aspect navigation domains.',
+    //  format: Array,
+    //  default: undefined,
+    //},
     keys: {
@@ -78,3 +84,3 @@ google_analytics: {
     start_path: {
-      doc: 'The root relative start path inside the bundle from which to take files.',
+      doc: 'The relative path inside the bundle from which to start reading files.',
       format: String,
@@ -81,0 +87,0 @@ default: '',

package.json

 {
   "name": "@antora/playbook-builder",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-alpha.5",
   "description": "Builds a playbook object from user input for configuring successive documentation components in an Antora pipeline.",
@@ -5,0 +5,0 @@ "license": "MPL-2.0",

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

9900

increased by2.61%

Lines of code

263

increased by1.94%

No dependency changes