Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scaffdog/scaffdog
:dog: scaffdog is Markdown driven scaffolding tool.
https://github.com/scaffdog/scaffdog
cli generator markdown nodejs scaffdog scaffold template
Last synced: 8 days ago
JSON representation
:dog: scaffdog is Markdown driven scaffolding tool.
- Host: GitHub
- URL: https://github.com/scaffdog/scaffdog
- Owner: scaffdog
- License: mit
- Created: 2019-01-06T08:36:18.000Z (almost 6 years ago)
- Default Branch: canary
- Last Pushed: 2024-07-25T19:03:59.000Z (3 months ago)
- Last Synced: 2024-08-04T09:09:29.606Z (3 months ago)
- Topics: cli, generator, markdown, nodejs, scaffdog, scaffold, template
- Language: TypeScript
- Homepage: https://scaff.dog
- Size: 19.2 MB
- Stars: 686
- Watchers: 2
- Forks: 24
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - scaffdog/scaffdog - :dog: scaffdog is Markdown driven scaffolding tool. (TypeScript)
- project-awesome - scaffdog/scaffdog - :dog: scaffdog is Markdown driven scaffolding tool. (TypeScript)
README
scaffdog is Markdown driven scaffolding tool.
# scaffdog
[](https://asciinema.org/a/Az6hGIB1NWBZlKs3hhpYYu3XX)
Multiple files can be output in a document, and flexible scaffolding is possible with a simple but powerful template syntax :dog2:
## Documentation
Visit https://scaff.dog to view the full documentation.
## Features
- :pencil: **Markdown driven**
- You can define a template with `
` and code block.
- It will be a Documetable template !
- Define meta information with extended syntax using [Front Matter](https://jekyllrb.com/docs/front-matter/).
- :spiral_notepad: **Intuitive template**
- It provides a simple yet powerful template engine inspired by [ECMAScript](https://tc39.es/ecma262/) and [Go text/template](https://pkg.go.dev/text/template).
- Many built-in helper functions required to define templates are also provided.
- :rocket: **Ready to use**
- You can quickly start using `$ scaffdog init`.
- Other useful commands are provided for immediate scaffolding.
- :nail_care: **Prettier Integration**
- Markdown works very well with Prettier, and the templates maintain beautiful code.
- We also offer a Prettier Plugin for scaffdog's template engine.
## Requirements
- Node.js v18.0.0+
## Getting Started
### Installation
`scaffdog` can be installed globally, but we recommend installing it locally on the project.
```bash
$ npm install --save-dev scaffdog
```
### Quick Start
In the following tutorial you can start using `scaffdog` immediately !
#### Setup
By default, it stores the document file and configuration file in the `.scaffdog` directory.
Creating directories, configuration file and initial documents can be done with the `init` subcommand.
```bash
$ npx scaffdog init
? Please enter a document name. component
Setup of scaffdog 🐶 is complete!
✔ .scaffdog/config.js
✔ .scaffdog/component.md
Now you can do scaffold by running `$ scaffdog generate`.
Please refer to the following documents and customize it.
https://scaff.dog/docs/templates
```
After running the command, the `.scaffdog/component.md` file should have been generated. Rewrite that file as follows:
````markdown
---
name: 'component'
root: '.'
output: '.'
questions:
name: 'Please enter a component name.'
---
# `{{ inputs.name | pascal }}/index.ts`
```typescript
export * from './{{ inputs.name }}';
```
# `{{ inputs.name | pascal }}/{{ inputs.name | pascal }}.tsx`
```typescript
export type Props = React.PropsWithChildren<{}>;
export const {{ inputs.name | pascal }}: React.FC = ({ children }) => {
return (
{children}
);
};
```
````
Let's scaffold using the `component` document!
```bash
$ npx scaffdog generate
? Please select a document. component
ℹ Output destination directory: "."
? Please enter a component name. PrettyDog
🐶 Generated 2 files!
✔ PrettyDog/index.ts
✔ PrettyDog/PrettyDog.tsx
```
Congratulations :tada:
The first file was generated.
```bash
$ cat PrettyDog/index.ts
export * from './PrettyDog';
$ cat PrettyDog/PrettyDog.tsx
export type Props = React.PropsWithChildren<{}>;
export const PrettyDog: React.FC = ({ children }) => {
return (
{children}
);
};
```
Check out our [documentation site](https://scaff.dog/docs/templates) to customize your documentation :+1:
## Migration
There are important changes in the major update.
- [To v4 from v3](/MIGRATION.md#to-v4-from-v3)
- [To v3 from v2](/MIGRATION.md#to-v3-from-v2)
- [To v2 from v1](/MIGRATION.md#to-v2-from-v1)
- [To v1 from v0](/MIGRATION.md#to-v1-from-v0)
See [Migration Guide](/MIGRATION.md).
## Contributing
See [CONTRIBUTING.md](/CONTRIBUTING.md).
## CHANGELOG
See [CHANGELOG.md](/packages/scaffdog/CHANGELOG.md).
## License
[MIT © wadackel](/LICENSE)
