Skaffe—building block for hybrid scaffolding tools
This library provides a simple way to copy around files that were shipped with your hybrid Deno/Node scaffolding CLI.
You can easily try this library from Deno.
deno run -A https://raw.githubusercontent.com/KnorpelSenf/skaffe/main/example.ts
This will demo the scaffolding by copying the example file itself into the current working directory.
Deno Example
Use the following code.
import { scaffold } from "https://deno.land/x/[email protected]/mod.ts";
const thisFile = import.meta.url;
const targetDirectory = Deno.cwd(); // using a dir will infer the file name
// Will copy this very source file into the working directory
await scaffold(thisFile, targetDirectory);
Node Example
Run
npm i skaffe
and use the following code.
const { scaffold } = require("skaffe");
const thisFile = __filename;
const targetDirectory = process.cwd(); // using a dir will infer the file name
// Will copy this very source file into the working directory
scaffold(thisFile, targetDirectory);
Why?
Deno modules can be on a remote host. They can also be local files. Node modules are always local.
Writing files works differently on Deno and Node, too.
When you are writing a scaffolding tool that ships a number of config files and source files, you can use skaffe to simply copy these files into the user's working directory. The library will download the file from a remote host if you're running a Deno script from remote, and it will copy over the files if you're running a local Deno script or if you're using Node.
As a result, you can focus on building an intuitive scaffolding tool for Deno and Node, and let skaffe do the nasty part.
What's in a Name?
The word skaffe is Norwegian and means provide. It also looks similar to the prefix of scaffolding.
4 May 3, 2022
14 Jan 3, 2023
2 Oct 12, 2022
8 May 10, 2023
3 Jan 24, 2022
675 Dec 22, 2022
23 Nov 15, 2022
1.7k Nov 25, 2022
12.9k Jan 5, 2023
1.5k Dec 31, 2022