Compare commits

..

22 Commits

Author SHA1 Message Date
30ad1d2b65 4.0.16 2025-04-15 21:52:08 +00:00
99e2d08a83 fix(dependencies): Update dependency references and bump version numbers; adjust workflow and template commands 2025-04-15 21:52:08 +00:00
27ef8f28a0 update description 2024-05-29 14:16:04 +02:00
3138ec130d update tsconfig 2024-04-14 18:16:55 +02:00
7449d5e316 update tsconfig 2024-04-01 21:40:52 +02:00
c4505a9a57 update npmextra.json: githost 2024-04-01 19:59:35 +02:00
c8c4c8c18a update npmextra.json: githost 2024-03-30 21:48:35 +01:00
297e44a5e3 4.0.15 2023-08-18 13:00:37 +02:00
757bf763df fix(core): update 2023-08-18 13:00:37 +02:00
4c158ba0ea 4.0.14 2023-07-25 17:35:14 +02:00
831ab25a6f fix(core): update 2023-07-25 17:35:13 +02:00
8fb95634df switch to new org scheme 2023-07-10 10:18:08 +02:00
c8eeb4b8e6 4.0.13 2023-06-25 13:48:54 +02:00
56df0d3246 fix(core): update 2023-06-25 13:48:54 +02:00
883ecff182 4.0.12 2023-06-25 13:39:43 +02:00
9589ad6146 fix(core): update 2023-06-25 13:39:42 +02:00
c2d4f9684c 4.0.11 2023-06-25 13:25:54 +02:00
d2b325889d fix(core): update 2023-06-25 13:25:53 +02:00
f6cd3c245b 4.0.10 2023-06-25 13:24:33 +02:00
1529ac12e4 fix(core): update 2023-06-25 13:24:32 +02:00
b4b5e52799 4.0.9 2023-06-25 12:45:44 +02:00
7de1cfbb6f fix(core): update 2023-06-25 12:45:44 +02:00
16 changed files with 9422 additions and 3384 deletions

View File

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

View File

@ -1,107 +0,0 @@
name: CI Pipeline
on: push
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm prepare
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
npmci command npm run buildDocs
- name: Upload artifacts
uses: actions/upload-artifact@v2
with:
name: public
path: public
retention-days: 7

237
changelog.md Normal file
View File

@ -0,0 +1,237 @@
# Changelog
## 2025-04-15 - 4.0.16 - fix(dependencies)
Update dependency references and bump version numbers; adjust workflow and template commands
- Bump versions for devDependencies (@git.zone/tsbuild, @git.zone/tsrun, @git.zone/tstest, @push.rocks/tapbundle, and @types/node) and dependencies (@push.rocks/lik, @push.rocks/smartfile, @push.rocks/smartfm, @push.rocks/smarthbs, @push.rocks/smartinteract, @push.rocks/smartobject, @push.rocks/smartpromise, @push.rocks/smartshell, and @push.rocks/smartyaml)
- Replace smartparam with smartobject in both plugins and core modules
- Fix workflow install command by renaming '@gitzone/tsdoc' to '@git.zone/tsdoc'
- Update template runafter command from 'npm install' to 'echo "runafter"'
## 2024-05-29 - 4.0.15 - configuration updates
Updates to the projects configuration files, description and build settings.
- Updated description.
- Updated tsconfig (applied in multiple commits).
- Updated npmextra.json (githost).
## 2023-08-18 - 4.0.14 - core
Improved core functionality.
- Fixed core update.
## 2023-07-25 - 4.0.13 - core & organization
Enhancements in core behavior and organizational structure.
- Fixed core update.
- Switched to new organization scheme.
## 2023-06-25 - 4.0.12 - core
Core improvements.
- Fixed core update.
## 2023-06-25 - 4.0.11 - core
Core improvements.
- Fixed core update.
## 2023-06-25 - 4.0.10 - core
Core improvements.
- Fixed core update.
## 2023-06-25 - 4.0.9 - core
Core improvements.
- Fixed core update.
## 2023-06-25 - 4.0.8 - core
Core improvements.
- Fixed core update.
## 2023-06-25 - 4.0.7 - core
Core improvements.
- Fixed core update.
## 2023-06-25 - 4.0.6 - core
Core improvements.
- Fixed core update.
## 2023-06-25 - 4.0.5 - core
Core improvements.
- Fixed core update.
## 2023-06-24 - 4.0.4 - core
Core improvements.
- Fixed core update.
## 2023-06-24 - 4.0.3 - core
Core improvements.
- Fixed core update.
## 2022-06-25 - 4.0.2 - core
Core improvements.
- Fixed core update.
## 2022-06-25 - 4.0.1 - core
Core improvements.
- Fixed core update.
## 2022-06-25 - 4.0.0 - core
Core improvements.
- Fixed core update.
## 2022-06-25 - 3.0.10 - core (breaking)
A breaking change was introduced affecting the module format.
- BREAKING CHANGE (core): switched to ESM.
## 2020-01-31 - 3.0.9 - core
Routine core update.
- Fixed core update.
## 2019-10-11 - 3.0.8 - core
Routine core update.
- Fixed core update.
## 2019-10-02 - 3.0.7 - core
Routine core update.
- Fixed core update.
## 2019-09-10 - 3.0.6 - core
Routine core update.
- Fixed core update.
## 2019-09-10 - 3.0.5 - core
Routine core update.
- Fixed core update.
## 2019-09-10 - 3.0.4 - core
Routine core update.
- Fixed core update.
## 2019-09-10 - 3.0.3 - general updates
Updates to project dependencies and general code improvements.
- Performed update.
- Updated dependencies.
## 2019-02-17 - 3.0.2 - core
Routine core update.
- Fixed core update.
## 2019-01-27 - 3.0.1 - core
Routine core update.
- Fixed core update.
## 2018-10-04 - 3.0.0 - core
Changes from merging and core improvements.
- Fixed core update.
- Merged master branch changes and performed additional updates.
## 2018-08-30 - 2.0.2 - structure (breaking)
A breaking change in the projects structure.
- BREAKING CHANGE (structure): templates now take their path within the constructor.
## 2018-08-27 - 2.0.1 - minor
Versions in this range involved only version bump commits with no significant changes.
- No significant changes.
## 2017-08-09 - 1.0.14 - scope (breaking)
A breaking change in the package scope was applied.
- BREAKING CHANGE (scope): switched to new @pushrocks scope.
## 2017-08-09 - 1.0.13 - core
Improvements to variable handling.
- Fixed variable distribution.
## 2017-07-28 - 1.0.12 - dependencies
Dependency updates.
- Updated dependencies.
## 2017-06-01 - 1.0.11 - dependencies
Dependency updates.
- Updated dependencies.
## 2017-06-01 - 1.0.10 - CLI improvements
Enhanced CLI error prevention.
- Prevented error due to empty defaults.yml.
## 2017-05-27 - 1.0.9 - dependencies
Dependency updates.
- Updated dependencies.
## 2017-05-27 - 1.0.8 - templating
Improved file templating support.
- Added support for frontmatter for advanced file templating.
## 2017-05-27 - 1.0.7 - documentation
Documentation improvements.
- Added docs.
## 2017-05-27 - 1.0.6 - fixes
Minor fixes.
- Fixed deep add.
## 2017-05-26 - 1.0.5 - smartfile updates
Smartfile updates.
- Updated smartfile.
## 2017-05-26 - 1.0.4 - tests
Test fixes.
- Fixed tests.
## 2017-05-26 - 1.0.3 - smartfile updates
Smartfile updates.
- Updated smartfile.
## 2017-05-25 - 1.0.2 - functionality
Minor functionality improvements.
- Ensured proper functionality.
## 2017-05-25 - 1.0.1 - core
Core fixes.
- Fixed working issues.
## 2017-05-06 - 1.0.0 - initial release and CLI integration
The initial release introducing CLI support and project setup.
- Added CLI to prompt for missing variables.
- Started CLI integration.
- Added readme and CI tslint configuration.
- Performed initial setup and various update tasks.

View File

@ -9,12 +9,25 @@
"gitzone": { "gitzone": {
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartscaf", "gitrepo": "smartscaf",
"description": "scaffold projects quickly", "description": "A project aimed at quickly scaffolding projects with support for TypeScript, smart file handling, and template rendering.",
"npmPackagename": "@pushrocks/smartscaf", "npmPackagename": "@push.rocks/smartscaf",
"license": "MIT" "license": "MIT",
"keywords": [
"typescript",
"scaffolding",
"template rendering",
"file handling",
"project setup",
"smart interaction",
"yaml",
"cli tool"
]
} }
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
} }
} }

View File

@ -1,8 +1,8 @@
{ {
"name": "@pushrocks/smartscaf", "name": "@push.rocks/smartscaf",
"version": "4.0.8", "version": "4.0.16",
"private": false, "private": false,
"description": "scaffold projects quickly", "description": "A project aimed at quickly scaffolding projects with support for TypeScript, smart file handling, and template rendering.",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"scripts": { "scripts": {
@ -12,36 +12,41 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+ssh://git@gitlab.com/pushrocks/smartscaf.git" "url": "https://code.foss.global/push.rocks/smartscaf.git"
}, },
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://gitlab.com/pushrocks/smartscaf/issues" "url": "https://gitlab.com/pushrocks/smartscaf/issues"
}, },
"homepage": "https://gitlab.com/pushrocks/smartscaf#README", "homepage": "https://code.foss.global/push.rocks/smartscaf",
"keywords": [ "keywords": [
"scaffold", "typescript",
"polymer", "scaffolding",
"npm" "template rendering",
"file handling",
"project setup",
"smart interaction",
"yaml",
"cli tool"
], ],
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.66", "@git.zone/tsbuild": "^2.3.2",
"@gitzone/tsrun": "^1.2.42", "@git.zone/tsrun": "^1.3.3",
"@gitzone/tstest": "^1.0.74", "@git.zone/tstest": "^1.0.96",
"@pushrocks/tapbundle": "^5.0.8", "@push.rocks/tapbundle": "^5.6.3",
"@types/node": "^20.3.1" "@types/node": "^22.14.1"
}, },
"dependencies": { "dependencies": {
"@pushrocks/lik": "^6.0.2", "@push.rocks/lik": "^6.1.0",
"@pushrocks/smartfile": "^10.0.17", "@push.rocks/smartfile": "^11.2.0",
"@pushrocks/smartfm": "^2.0.4", "@push.rocks/smartfm": "^2.2.2",
"@pushrocks/smarthbs": "^3.0.3", "@push.rocks/smarthbs": "^3.0.3",
"@pushrocks/smartinteract": "^2.0.11", "@push.rocks/smartinteract": "^2.0.16",
"@pushrocks/smartparam": "^1.1.6", "@push.rocks/smartobject": "^1.0.12",
"@pushrocks/smartpromise": "^4.0.2", "@push.rocks/smartpromise": "^4.2.3",
"@pushrocks/smartshell": "^3.0.3", "@push.rocks/smartshell": "^3.2.3",
"@pushrocks/smartyaml": "^2.0.5" "@push.rocks/smartyaml": "^3.0.4"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
@ -58,5 +63,6 @@
"type": "module", "type": "module",
"browserslist": [ "browserslist": [
"last 1 chrome versions" "last 1 chrome versions"
] ],
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6"
} }

12026
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

115
readme.md
View File

@ -1,44 +1,97 @@
# @pushrocks/smartscaf # @push.rocks/smartscaf
scaffold projects quickly scaffold projects quickly
## Availabililty and Links ## Install
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartscaf) To install `@push.rocks/smartscaf`, run the following command in your project directory:
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartscaf)
* [github.com (source mirror)](https://github.com/pushrocks/smartscaf)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartscaf/)
## Status for master ```bash
npm install @push.rocks/smartscaf --save
Status Category | Status Badge ```
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartscaf/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartscaf/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartscaf)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartscaf)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartscaf)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartscaf)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartscaf)](https://lossless.cloud)
## Usage ## Usage
Use TypeScript for best in class instellisense. Smartscaf provides a streamlined approach to quickly scaffold projects with predefined templates. It leverages modern TypeScript and ESM syntax to offer a flexible and powerful toolchain for project initialization. This guide will walk you through utilizing Smartscaf to its full potential, including setting up templates, customizing scaffolding processes, and programmatically controlling scaffolding operations.
For further information read the linked docs at the top of this README. ### Setting Up Your First Template
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) A Smartscaf template is essentially a directory with a set of files that you want to reuse across projects. It can include source code files, configuration files, and a special `.smartscaf.yml` file for defining template variables and dependencies.
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://) 1. **Create a Template Directory**: This directory should contain all the files and folders representing your template.
## Contribution 2. **Define Template Variables in `.smartscaf.yml`**: This YAML file contains metadata about your template, such as default values for variables, dependency templates to merge, and scripts to run after scaffolding. Here's a basic example:
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :) ```yml
defaults:
projectName: "My Awesome Project"
dependencies:
merge: []
runafter:
- "npm install"
```
For further information read the linked docs at the top of this readme. 3. **Utilize Handlebars Syntax for Dynamic Content**: Files in your template can use the Handlebars syntax (`{{variableName}}`) for dynamic content that will be replaced during the scaffolding process.
## Legal ### Scaffolding a New Project
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) Once you have a template ready, you can scaffold a new project by programmatically creating and manipulating a `ScafTemplate` instance from Smartscaf.
1. **Import Smartscaf and Create a New Instance**:
```typescript
import { ScafTemplate } from '@push.rocks/smartscaf';
async function scaffoldProject() {
const myTemplate = await ScafTemplate.createTemplateFromDir('<path-to-your-template>');
await myTemplate.readTemplateFromDir(); // Load the template
// Supply any additional variables or override defaults
await myTemplate.supplyVariables({
projectName: 'My New Project'
});
// Optionally, interactively ask for missing variables
// await myTemplate.askCliForMissingVariables();
await myTemplate.writeToDisk('<destination-path>'); // Scaffold!
}
scaffoldProject().then(() => console.log('Project scaffolded successfully!'));
```
2. **Customizing the Scaffolding Process**: You can customize the scaffolding process by defining additional logic to manipulate files, directories, or template variables before writing to disk.
### Advanced Features
- **Merging Templates**: Smartscaf allows you to compose complex templates by specifying dependencies in the `.smartscaf.yml` file. This enables you to merge multiple templates into one scaffolded project.
- **Running Scripts After Scaffolding**: Specify an array of shell commands in the `runafter` section of your `.smartscaf.yml` to be executed after the project is scaffolded. This is useful for running installations or initial builds.
- **Programmatic API**: Smartscaf's flexible API allows for programmatically controlling every aspect of the scaffolding process, making it suitable for integrating into build tools, command line utilities, or CI/CD pipelines.
### Complete Feature Set and Use Cases
The usage scenarios outlined above merely scratch the surface of what Smartscaf can do. With its comprehensive API, you can manage complex scaffolding tasks, including but not limited to:
- Creating project templates with varying levels of complexity and customization.
- Dynamically adjusting project structures based on user input or external parameters.
- Integrating scaffolding steps into larger automation workflows, significantly reducing manual setup time for new projects.
In conclusion, Smartscaf empowers developers to streamline their project initialization process, ensuring consistency, reducing boilerplate, and allowing more time to be spent on development rather than setup. Its flexibility and broad feature set make it a valuable tool in a modern developer's toolkit.
For further information and a deeper dive into Smartscaf's capabilities, please refer to the [official documentation](https://gitlab.com/push.rocks/smartscaf#README) and explore the [source code](https://gitlab.com/push.rocks/smartscaf) for advanced use cases and customization options.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

View File

@ -1,4 +1,4 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as path from 'path'; import * as path from 'path';
import * as smartscaf from '../ts/index.js'; import * as smartscaf from '../ts/index.js';

View File

@ -1,3 +0,0 @@
# this is a wow
# this is a here
# this is a undefined variable

View File

@ -10,4 +10,4 @@ dependencies:
- ../test_template_2 - ../test_template_2
runafter: runafter:
- npm install - echo 'runafter'

View File

@ -1,8 +1,8 @@
/** /**
* autocreated commitinfo by @pushrocks/commitinfo * autocreated commitinfo by @push.rocks/commitinfo
*/ */
export const commitinfo = { export const commitinfo = {
name: '@pushrocks/smartscaf', name: '@push.rocks/smartscaf',
version: '4.0.8', version: '4.0.16',
description: 'scaffold projects quickly' description: 'A project aimed at quickly scaffolding projects with support for TypeScript, smart file handling, and template rendering.'
} }

View File

@ -1,9 +1,6 @@
import * as plugins from './smartscaf.plugins.js'; import * as plugins from './smartscaf.plugins.js';
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces/index.js';
// interfaces
import { Smartfile } from '@pushrocks/smartfile';
export interface ScafTemplateContructorOptions { export interface ScafTemplateContructorOptions {
name?: string; name?: string;
description?: string; description?: string;
@ -39,7 +36,7 @@ export class ScafTemplate {
/** /**
* the files of the template as array of Smartfiles * the files of the template as array of Smartfiles
*/ */
public templateSmartfileArray: Smartfile[]; public templateSmartfileArray: plugins.smartfile.SmartFile[];
public requiredVariables: string[]; public requiredVariables: string[];
public defaultVariables: any; public defaultVariables: any;
public suppliedVariables: any = {}; public suppliedVariables: any = {};
@ -121,7 +118,7 @@ export class ScafTemplate {
const answerBucket = await localSmartInteract.runQueue(); const answerBucket = await localSmartInteract.runQueue();
const answers = answerBucket.getAllAnswers(); const answers = answerBucket.getAllAnswers();
for (const answer of answers) { for (const answer of answers) {
await plugins.smartparam.smartAdd(this.suppliedVariables, answer.name, answer.value); await plugins.smartobject.smartAdd(this.suppliedVariables, answer.name, answer.value);
} }
} }
@ -131,7 +128,7 @@ export class ScafTemplate {
*/ */
public async writeToDisk(destinationDirArg) { public async writeToDisk(destinationDirArg) {
this.destinationPath = destinationDirArg; this.destinationPath = destinationDirArg;
const smartfileArrayToWrite: Smartfile[] = []; const smartfileArrayToWrite: plugins.smartfile.SmartFile[] = [];
for (const smartfile of this.templateSmartfileArray) { for (const smartfile of this.templateSmartfileArray) {
// lets filter out template files // lets filter out template files
if (smartfile.path === '.smartscaf.yml') { if (smartfile.path === '.smartscaf.yml') {

View File

@ -1,13 +1,13 @@
import * as path from 'path'; import * as path from 'path';
import * as lik from '@pushrocks/lik'; import * as lik from '@push.rocks/lik';
import * as smartfile from '@pushrocks/smartfile'; import * as smartfile from '@push.rocks/smartfile';
import * as smartfm from '@pushrocks/smartfm'; import * as smartfm from '@push.rocks/smartfm';
import * as smarthbs from '@pushrocks/smarthbs'; import * as smarthbs from '@push.rocks/smarthbs';
import * as smartinteract from '@pushrocks/smartinteract'; import * as smartinteract from '@push.rocks/smartinteract';
import * as smartparam from '@pushrocks/smartparam'; import * as smartobject from '@push.rocks/smartobject';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartyaml from '@pushrocks/smartyaml'; import * as smartyaml from '@push.rocks/smartyaml';
import * as smartshell from '@pushrocks/smartshell'; import * as smartshell from '@push.rocks/smartshell';
export { export {
path, path,
@ -16,7 +16,7 @@ export {
smartfm, smartfm,
smarthbs, smarthbs,
smartinteract, smartinteract,
smartparam, smartobject,
smartpromise, smartpromise,
smartyaml, smartyaml,
smartshell, smartshell,

View File

@ -3,7 +3,12 @@
"experimentalDecorators": true, "experimentalDecorators": true,
"useDefineForClassFields": false, "useDefineForClassFields": false,
"target": "ES2022", "target": "ES2022",
"module": "ES2022", "module": "NodeNext",
"moduleResolution": "nodenext" "moduleResolution": "NodeNext",
} "esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
} }