Skip to main
Table of Contents

⌨️ Synticore Website Compiler - Terminal Task Reference

🧭 Command Pattern

Primary pattern:

npm run gulp <task>

Equivalent direct Gulp invocation:

npx gulp <task>

npm run gulp is preferred because this repo already defines the script alias in package.json.


🧩 Task Groups (Current)

The task groups below reflect the current createTask(...) registrations in gulpfile.js.

General

  • default - run full build group
  • watch - run build, then watch + browser reload
  • browser - start BrowserSync only (no build/watch)
  • plan - print planned build task sequence without mutating output/cache
  • package - package output according to config
  • sort_config - normalize/sort project config file
  • about - print compiler/project metadata

Build

  • build
  • build_audio
  • build_brand
  • build_config
  • build_data
  • build_favicon
  • build_file
  • build_font
  • build_font_icon
  • build_highlight_syntax
  • build_html_config
  • build_html_include
  • build_html
  • build_image
  • build_javascript
  • build_mirror
  • build_module
  • build_stylesheet
  • build_video

Rebuild

(Reset cache/output for scope, then build scope)

  • rebuild
  • rebuild_audio
  • rebuild_brand
  • rebuild_config
  • rebuild_data
  • rebuild_favicon
  • rebuild_file
  • rebuild_font
  • rebuild_font_icon
  • rebuild_highlight_syntax
  • rebuild_html_config
  • rebuild_html
  • rebuild_image
  • rebuild_javascript
  • rebuild_mirror
  • rebuild_module
  • rebuild_stylesheet
  • rebuild_video

Reset

(Clear cache/output for scope)

  • reset
  • reset_audio
  • reset_brand
  • reset_config
  • reset_data
  • reset_favicon
  • reset_file
  • reset_font
  • reset_font_icon
  • reset_highlight_syntax
  • reset_html_config
  • reset_html
  • reset_image
  • reset_javascript
  • reset_mirror
  • reset_module
  • reset_stylesheet
  • reset_video

Maintenance

  • project_normalize_paths
  • project_update_full
  • project_update_directed
  • compiler_update_caniuse
  • compiler_update_baseline

Test (Development-Focused)

  • test_config
  • test_file_match
  • test_ansi_standard
  • test_ansi_color256
  • test_ansi_screen
  • test_ansi_cursor
  • test_ansi_reveal
  • test_ansi_clean
  • test_ansi_all
  • test_log_type
  • test_log_hook_console
  • test_log_hook_process_warning
  • test_log_hook_error_uncaught_exception
  • test_log_hook_error_unhandled_rejection
  • test_log_hook_error_async_throw
  • test_log_hook_error_late_catch
  • test_log_hook_error_next_tick
  • test_log_hook_error_immediate
  • test_log_hook_signal_sigint
  • test_log_hook_signal_sigterm

🔁 Practical Workflows

Standard Local Dev Loop

npm run gulp watch
  • Builds project
  • Starts file watchers
  • Auto-runs relevant build tasks on changes
  • Auto-runs additional dependent build tasks when references are impacted (for example, image/svg changes triggering HTML rebuild)
  • Reloads browser after watch delays in config

Browser Preview Only (No Build)

npm run gulp browser
  • Starts BrowserSync server only
  • Useful for validating output that was built in a prior step

Plan Task Resolution (Dry-Run)

npm run gulp plan
  • Prints resolved task execution order
  • Does not clear cache or rewrite output artifacts

Clean Build From Scratch

npm run gulp reset
npm run gulp build

Targeted Rebuild For One Subsystem

npm run gulp rebuild_stylesheet
npm run gulp rebuild_javascript

Prepare Deploy Artifacts

npm run gulp build
npm run gulp package

📝 Notes And Recommendations

  • Run tasks from repository root.
  • Keep project selection current via GUI or config/settings.json dir_recent[0].
  • Use about when debugging path/config/project version mismatches.
  • For stale-cache behavior, start with rebuild or targeted rebuild_* tasks before deeper debugging.

Explore More

Home Download Wiki Report Issue License