simple-scaffold

GitHub | Documentation | NPM | casraf.dev

Looking to streamline your workflow and get your projects up and running quickly? Look no further than Simple Scaffold - the easy-to-use NPM package that simplifies the process of organizing and copying your commonly-created files.

With its agnostic and un-opinionated approach, Simple Scaffold can handle anything from a few simple files to an entire app boilerplate setup. Plus, with the power of Handlebars.js syntax, you can easily replace custom data and personalize your files to fit your exact needs. But that's not all - you can also use it to loop through data, use conditions, and write custom functions using helpers.

Don't waste any more time manually copying and pasting files - let Simple Scaffold do the heavy lifting for you and start building your projects faster and more efficiently today!

---

Documentation

See full documentation here.

• Command Line Interface (CLI) usage
• Node.js usage
• Templates
• Configuration Files
• Migration

Getting Started

Cheat Sheet

A quick rundown of common usage scenarios:

• Remote template config file on GitHub:

  npx simple-scaffold -g username/repository -c scaffold.js -k component NewComponentName

• Local template config file:

  npx simple-scaffold -c scaffold.js -k component NewComponentName

• Local one-time usage:

  npx simple-scaffold -t templates/component -o src/components NewComponentName

Remote Configurations

The fastest way to get started is to is to re-use someone else's (or your own) work using a template repository.

A remote config can be loaded in one of these ways:

• For templates hosted on GitHub, the syntax is -g user/repository_name
• For other Git platforms like GitLab, use -g https://example.com/user/repository_name.git

These remote configurations support multiple scaffold groups, which can be specified using the --key or -k argument:

$ npx simple-scaffold \
  -g chenasraf/simple-scaffold \
  -k component \
  PageWrapper

# equivalent to:
$ npx simple-scaffold \
  -g https://github.com/chenasraf/simple-scaffold.git \
  -c scaffold.config.js \
  -k component \
  PageWrapper

By default, the template name is set to default when the --key option is not provided.

See information about each option and flag using the --help flag, or read the CLI documentation. For information about how configuration files work, see below.

Configuration Files

You can use a config file to more easily maintain all your scaffold definitions.

scaffold.config.js

module.exports = {
  // use "default" to avoid needing to specify key
  // in this case the key is "component"
  component: {
    templates: ["templates/component"],
    output: "src/components",
    data: {
      // ...
    },
  },
}

Then call your scaffold like this:

$ npx simple-scaffold -c scaffold.config.js PageWrapper

This will allow you to avoid needing to remember which configs are needed or to store them in a one-liner in package.json which can get pretty long and messy, and harder to maintain.

Also, this allows you to define more complex scaffolds with logic without having to use the Node.js API directly. (Of course you always have the option to still do so if you wish)

More information can be found at the Configuration Files documentation.

Templates Structure

Templates are any file in the a directory given to --templates.

Simple Scaffold will maintain any file and directory structure you try to generate, while replacing any tokens such as {{ name }} or other custom-data using Handlebars.js.

templates/component/{{ pascalName name }}.tsx

// Created: {{ now 'yyyy-MM-dd' }}
import React from 'react'

export default {{pascalCase name}}: React.FC = (props) => {
  return (
    <div className="{{camelCase name}}">{{pascalCase name}} Component</div>
  )
}

To generate the template output once without saving a configuration file, run:

# generate single component
$ npx simple-scaffold \
  -t templates/component \
  -o src/components \
  PageWrapper

This will immediately create the following file: src/components/PageWrapper.tsx

// Created: 2077-01-01
import React from 'react'

export default PageWrapper: React.FC = (props) => {
  return (
    <div className="pageWrapper">PageWrapper Component</div>
  )
}

Contributing

I am developing this package on my free time, so any support, whether code, issues, or just stars is very helpful to sustaining its life. If you are feeling incredibly generous and would like to donate just a small amount to help sustain this project, I would be very very thankful!

I welcome any issues or pull requests on GitHub. If you find a bug, or would like a new feature, don't hesitate to open an appropriate issue and I will do my best to reply promptly.

If you are a developer and want to contribute code, here are some starting tips:

1. Fork this repository
2. Run pnpm install
3. Run pnpm dev to start file watch mode
4. Make any changes you would like
5. Create tests for your changes
6. Update the relevant documentation (readme, code comments, type comments)
7. Create a PR on upstream

Some tips on getting around the code:

• Use pnpm cmd to use the CLI feature of Simple Scaffold from within the root directory, enabling you to test different behaviors. See pnpm cmd -h for more information.
• Use pnpm test to run tests
• Use pnpm docs:build to build the documentation once
• Use pnpm docs:watch to start docs in watch mode
• Use pnpm build to build the output