casraf/simple-scaffold
1
0
Fork 0
mirror of https://github.com/chenasraf/simple-scaffold.git synced 2026-05-18 01:29:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
v1.7.0-develop.2
simple-scaffold/pages/migration.md
Chen Asraf 9b86499a04 docs: use js for typedoc config
2023-04-25 10:26:24 +03:00

1.2 KiB
Raw Permalink Blame History

In Simple Scaffold v1.0, the entire codebase was overhauled, yet usage remains mostly the same between versions. With these notable exceptions:

  • Some of the argument names have changed
  • Template syntax has been improved
  • The command to run Scaffold has been simplified from new SimpleScaffold(opts).run() to SimpleScaffold(opts), which now returns a promise that you can await to know when the process has been completed.

Argument changes

  • locals has been renamed to data. The appropriate command line args have been updated as well to --data | -d.
  • Additional options have been added to both CLI and Node interfaces. See Command Line Interface (CLI) usage and Node.js usage for more information.

Template syntax changes

Simple Scaffold still uses Handlebars.js to handle template content and file names. However, helpers have been added to remove the need for you to pre-process the template data on simple use-cases such as case type manipulation (converting to camel case, snake case, etc)

See the readme for the full information on how to use these helpers and which are available.