@sheetbase/server-scripts

Scripts for Sheetbase server modules and apps.

• Install
  • Global
  • Local
• Ayedocs plugins
  • Sheetbase template
  • Sheetbase installation template
  • Sheetbase routing template
• Command overview
• Command reference
  • build
  • deploy
  • help
• Detail API reference

Install

Global

$ npm install -g @sheetbase/server-scripts

Command: sheetbase-server-scripts

Local

$ npm install --save-dev @sheetbase/server-scripts

Add these lines to the project package.json.

{
  "scripts": {
    "build": "sheetbase-server-scripts build"
  }
}

Ayedocs plugins

This package provides Ayedocs templates and converts for conviniently document generation for Sheetbase server modules.

Sheetbase template

Included all sections:

• Installation
• Options
• Main properties & methods
• Routing

const sheetbaseTemplate = require("@sheetbase/server-scripts/ayedocs-plugins/sheetbase.template");

module.exports = {
  fileRender: {
    "sheetbase.md": sheetbaseTemplate(),
    "sheetbase-full.md": sheetbaseTemplate(true),
  },
};

Sheetbase installation template

Common installation & basic usage section.

const sheetbaseInstallationTemplate = require("@sheetbase/server-scripts/ayedocs-plugins/sheetbase-installation.template");

module.exports = {
  fileRender: {
    "sheetbase-installation.md": sheetbaseInstallationTemplate(),
    "sheetbase-installation-full.md": sheetbaseInstallationTemplate(true),
  },
};

Sheetbase routing template

Showing endpoint, default disabled routes, routing errors and the list of routes.

const sheetbaseRoutingTemplate = require("@sheetbase/server-scripts/ayedocs-plugins/sheetbase-routing.template");

module.exports = {
  fileRender: {
    "sheetbase-routing.md": sheetbaseRoutingTemplate(),
    "sheetbase-routing-full.md": sheetbaseRoutingTemplate(true),
  },
};

Command overview

Scripts for Sheetbase server modules and apps.

• sheetbase-server-scripts build
• sheetbase-server-scripts deploy --dry-run --copy [value] --vendor [value]
• sheetbase-server-scripts help

Command reference

build

Build distribution package.

deploy

Push to the Apps Script server.

Options

• -d, --dry-run: Staging only.
• --copy [value]: Copied resources, comma-seperated.
• --vendor [value]: Files for @vendor.js, comma-seperated.

help

Display help.

License

@sheetbase/server-scripts is released under the MIT license.

---

⚡️ This document is generated automatically using @lamnhan/ayedocs.