{"id":13432950,"url":"https://github.com/scaffdog/scaffdog","last_synced_at":"2025-03-17T10:33:04.217Z","repository":{"id":37493319,"uuid":"164289576","full_name":"scaffdog/scaffdog","owner":"scaffdog","description":":dog: scaffdog is Markdown driven scaffolding tool.","archived":false,"fork":false,"pushed_at":"2024-07-25T19:03:59.000Z","size":20185,"stargazers_count":686,"open_issues_count":33,"forks_count":24,"subscribers_count":2,"default_branch":"canary","last_synced_at":"2024-08-04T09:09:29.606Z","etag":null,"topics":["cli","generator","markdown","nodejs","scaffdog","scaffold","template"],"latest_commit_sha":null,"homepage":"https://scaff.dog","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scaffdog.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-06T08:36:18.000Z","updated_at":"2024-08-04T00:21:02.000Z","dependencies_parsed_at":"2023-02-16T15:15:57.365Z","dependency_job_id":"e6cbb66b-1310-495e-a257-635945e3fbb0","html_url":"https://github.com/scaffdog/scaffdog","commit_stats":{"total_commits":715,"total_committers":12,"mean_commits":"59.583333333333336","dds":0.6153846153846154,"last_synced_commit":"e2257c1727fb08d846e1682f836f469ca0e55e71"},"previous_names":["cats-oss/scaffdog"],"tags_count":137,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaffdog%2Fscaffdog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaffdog%2Fscaffdog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaffdog%2Fscaffdog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaffdog%2Fscaffdog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scaffdog","download_url":"https://codeload.github.com/scaffdog/scaffdog/tar.gz/refs/heads/canary","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221675279,"owners_count":16861860,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","generator","markdown","nodejs","scaffdog","scaffold","template"],"created_at":"2024-07-31T02:01:18.921Z","updated_at":"2024-10-27T12:31:49.382Z","avatar_url":"https://github.com/scaffdog.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","cli","🛠️ Developer Tools"],"sub_categories":[],"readme":"![scaffdog](https://github.com/scaffdog/artwork/raw/main/repo-banner.png)\n\n\u003cp align=\"center\"\u003e\n  scaffdog is Markdown driven scaffolding tool.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/scaffdog/scaffdog/actions?workflow=CI\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/scaffdog/scaffdog/ci.yml?branch=canary\u0026logo=github\u0026style=flat-square\" alt=\"GitHub Workflow Status\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://npmcharts.com/compare/scaffdog?minimal=true\"\u003e\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/dm/scaffdog?style=flat-square\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/scaffdog\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/scaffdog?style=flat-square\" alt=\"npm\" /\u003e\u003c/a\u003e\n  \u003ca href=\"./LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/scaffdog/scaffdog?label=license\u0026style=flat-square\" alt=\"MIT LICENSE\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# scaffdog\n\n[![asciicast](https://asciinema.org/a/Az6hGIB1NWBZlKs3hhpYYu3XX.svg)](https://asciinema.org/a/Az6hGIB1NWBZlKs3hhpYYu3XX)\n\nMultiple files can be output in a document, and flexible scaffolding is possible with a simple but powerful template syntax :dog2:\n\n## Documentation\n\nVisit https://scaff.dog to view the full documentation.\n\n## Features\n\n- :pencil: **Markdown driven**\n  - You can define a template with `\u003ch1\u003e` and code block.\n  - It will be a Documetable template !\n  - Define meta information with extended syntax using [Front Matter](https://jekyllrb.com/docs/front-matter/).\n- :spiral_notepad: **Intuitive template**\n  - 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).\n  - Many built-in helper functions required to define templates are also provided.\n- :rocket: **Ready to use**\n  - You can quickly start using `$ scaffdog init`.\n  - Other useful commands are provided for immediate scaffolding.\n- :nail_care: **Prettier Integration**\n  - Markdown works very well with Prettier, and the templates maintain beautiful code.\n  - We also offer a Prettier Plugin for scaffdog's template engine.\n\n## Requirements\n\n- Node.js v18.0.0+\n\n## Getting Started\n\n### Installation\n\n`scaffdog` can be installed globally, but we recommend installing it locally on the project.\n\n```bash\n$ npm install --save-dev scaffdog\n```\n\n### Quick Start\n\nIn the following tutorial you can start using `scaffdog` immediately !\n\n#### Setup\n\nBy default, it stores the document file and configuration file in the `.scaffdog` directory.\n\nCreating directories, configuration file and initial documents can be done with the `init` subcommand.\n\n```bash\n$ npx scaffdog init\n\n? Please enter a document name. component\n\nSetup of scaffdog 🐶 is complete!\n\n  ✔ .scaffdog/config.js\n  ✔ .scaffdog/component.md\n\nNow you can do scaffold by running `$ scaffdog generate`.\n\nPlease refer to the following documents and customize it.\nhttps://scaff.dog/docs/templates\n```\n\nAfter running the command, the `.scaffdog/component.md` file should have been generated. Rewrite that file as follows:\n\n````markdown\n---\nname: 'component'\nroot: '.'\noutput: '.'\nquestions:\n  name: 'Please enter a component name.'\n---\n\n# `{{ inputs.name | pascal }}/index.ts`\n\n```typescript\nexport * from './{{ inputs.name }}';\n```\n\n# `{{ inputs.name | pascal }}/{{ inputs.name | pascal }}.tsx`\n\n```typescript\nexport type Props = React.PropsWithChildren\u003c{}\u003e;\n\nexport const {{ inputs.name | pascal }}: React.FC\u003cProps\u003e = ({ children }) =\u003e {\n  return (\n    \u003cdiv\u003e{children}\u003c/div\u003e\n  );\n};\n```\n````\n\nLet's scaffold using the `component` document!\n\n```bash\n$ npx scaffdog generate\n\n? Please select a document. component\nℹ Output destination directory: \".\"\n? Please enter a component name. PrettyDog\n\n🐶 Generated 2 files!\n\n     ✔ PrettyDog/index.ts\n     ✔ PrettyDog/PrettyDog.tsx\n```\n\nCongratulations :tada:\n\nThe first file was generated.\n\n```bash\n$ cat PrettyDog/index.ts\nexport * from './PrettyDog';\n\n$ cat PrettyDog/PrettyDog.tsx\nexport type Props = React.PropsWithChildren\u003c{}\u003e;\n\nexport const PrettyDog: React.FC\u003cProps\u003e = ({ children }) =\u003e {\n  return (\n    \u003cdiv\u003e{children}\u003c/div\u003e\n  );\n};\n```\n\nCheck out our [documentation site](https://scaff.dog/docs/templates) to customize your documentation :+1:\n\n## Migration\n\nThere are important changes in the major update.\n\n- [To v4 from v3](/MIGRATION.md#to-v4-from-v3)\n- [To v3 from v2](/MIGRATION.md#to-v3-from-v2)\n- [To v2 from v1](/MIGRATION.md#to-v2-from-v1)\n- [To v1 from v0](/MIGRATION.md#to-v1-from-v0)\n\nSee [Migration Guide](/MIGRATION.md).\n\n## Contributing\n\nSee [CONTRIBUTING.md](/CONTRIBUTING.md).\n\n## CHANGELOG\n\nSee [CHANGELOG.md](/packages/scaffdog/CHANGELOG.md).\n\n## License\n\n[MIT © wadackel](/LICENSE)\n\n![Thank you for reading!](https://github.com/scaffdog/artwork/raw/main/repo-footer.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscaffdog%2Fscaffdog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscaffdog%2Fscaffdog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscaffdog%2Fscaffdog/lists"}