simonecorsi / skaffoldo

🏗 Universal project generator! Recursively copy directory and replace variables (if any)!

skaffoldo

Recursively copy provided source, while replacing variables (if any).

This project is meant to be used as a skaffold anything. Just provide a source directory/file and an output folder and this will walk recursively, when a variables in a file is found matching a variable in your environment or in the provided json (optional) it will logic-lessly be replaced.

Table of Content

• Usage
• Options
• Contributing
• License
• Contact

Usage

npx skaffoldo --source my-boilerplate --output my-new-project --jsonvars '{"CUSTOM_VAR": "MyValue"}'
# Enjoy

Variables

⚠️ This is a logic-less replace, this is not a template engine. Only variables found in templates are replaced.

By default process.env will be used, if the flag --jsonvars is provided with a valid JSON string it will be merge with process.env variables.

You can use variables inside your files or filenames following these formats:

• files: {{ MY_VARIABLE }}
• filenames: [MY_VARIABLE]_filename.ts

MY_VAR=123 skaffoldo ...
# All OS level variables are also used

Options

flag	description
--source -s	The source directory or file
--output -o	The output destination
--verbose -v	Add more info to errors
--dryRun -d	Output operation to console without writing
--ignore -i	Ignore paths, can be used multiple times, eg: **/.git/**
--jsonvars -j	Accept a json with variables in addition to the environment ones

Contributing

Project is pretty simple and straight forward for what is my needs, but if you have any idea you're welcome.

This projects uses commitlint with Angular configuration so be sure to use standard commit format or PR won't be accepted.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat(scope): some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Simone Corsi - @im_simonecorsi