Skip to content

cli.md

Latest commit

 

History

History
143 lines (91 loc) · 3.91 KB

cli.md

File metadata and controls

143 lines (91 loc) · 3.91 KB

🕮 Table of contents

🦚 References :

Command Line Interface

site: Managing Websites

Add a Site

npm run site:add my-new-site

Register a new site called "my-new-site", and scaffolds the default site structure and a demo website in a dedicated folder : src/sites/my-new-site/.

ℹ️ To remove a site just delete the corresponding folder in src/sites/

🟆 Website Name Rules :

  • If a website with the same name have already been created, the operation will fail
  • Site names are expected to be kebab-case and only alphanumerical, non allowed formats will be refused
Site Name
my-site-name ✅ Ok
site2 ✅ Ok
-my-site-name 🚫 Cannot start or end with '-'
my@-site-name 🚫 Can only include alphanumerical characters and "-"
my--site-name 🚫 Cannot have multiple consecutive "-"

Build & Bundle Ressources

This operation compiles ts code and optimises assets for production.

🟆 For a Specific Site

npm run site:build my-new-site

Builds and bundles the ressources only for the site called my-new-site

🟆 For All Registered Sites

npm run site:build-all

Builds and bundles the ressources for all registered sites

Clean All Built Ressources

npm run site:clean-outdir

Deletes the content of the sites outdir (root dist/ dir)

server: Starting a Server

ℹ️ see server config

Dev Server

npm run server:dev

Will serve the lastest versions of your pages and assets directly from the src folder, with hot module replacement.

Preview Server

npm run server:preview

Will serve pages and bundled assets from the dist folder.

ℹ️ It behaves exactly like the production server, the only difference is that it will accept to serve static assets.

ℹ️ For the preview server to work, the lastest ressources of the targetted site must have been built (using the site:build or site:build-all command)

Production Server

npm run server

Will serve pages from the dist folder, but does not handle static file requests: see serving static assets in production

ℹ️ For the production server to work, the lastest ressources of the targetted site must have been built (using the site:build or site:build-all command)

core: Paon Core

Building Core Scripts

npm run core:build

This operation compiles the core scripts of Paon (server, cli scripts etc..) into JavaScript.

Cleaning Core Outdir

npm run core:clean-outdir

This operation will delete all the core compiled scripts of Paon (server, cli scripts etc..). You need to run npm run core:build to compile them again.

Running Core Tests

npm run core:test

Runs tests

Display Command Manual with help Argument

npm run site:add help

Calling some commands with a help argument will display a short manual directly in the console.

Command Accepts help arg
site:add ✅
site:build ✅
site:build-all ✅
site:clean-outdir ✅
server:dev 🚫
server:preview 🚫
server 🚫
core:clean-outdir ✅
core:build 🚫
core:test 🚫