Compare commits

...

84 Commits

Author SHA1 Message Date
9e88f62e7e 4.0.19
Some checks failed
Default (tags) / security (push) Successful in 45s
Default (tags) / test (push) Successful in 59s
Default (tags) / release (push) Failing after 57s
Default (tags) / metadata (push) Successful in 1m11s
2025-08-17 16:27:16 +00:00
78bbbb2060 fix(readme): Update README with comprehensive quick start, usage examples, API reference and advanced guides 2025-08-17 16:27:16 +00:00
b262106bd7 4.0.18
Some checks failed
Default (tags) / security (push) Successful in 48s
Default (tags) / test (push) Successful in 59s
Default (tags) / release (push) Failing after 58s
Default (tags) / metadata (push) Successful in 1m12s
2025-08-17 15:56:11 +00:00
abc7cbc5ea fix(ScafTemplate): Use interactive shell for post-scaffold scripts; update CI workflows and package metadata 2025-08-17 15:56:11 +00:00
b2ba770b78 4.0.17
Some checks failed
Default (tags) / security (push) Failing after 22s
Default (tags) / test (push) Failing after 13s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2025-08-17 15:42:32 +00:00
23e4ff62a3 fix(ScafTemplate): Use interactive shell for post-scaffold scripts; update test/build config and dependency versions 2025-08-17 15:42:32 +00:00
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
f426e110f0 4.0.8 2023-06-25 12:33:14 +02:00
02e9cdff98 fix(core): update 2023-06-25 12:33:13 +02:00
576ee88283 4.0.7 2023-06-25 12:27:17 +02:00
d1886a0966 fix(core): update 2023-06-25 12:27:17 +02:00
9f8b14c6fe 4.0.6 2023-06-25 12:26:39 +02:00
e64e610092 fix(core): update 2023-06-25 12:26:39 +02:00
86f19de7d8 4.0.5 2023-06-25 00:59:37 +02:00
1b6b45f15f fix(core): update 2023-06-25 00:59:36 +02:00
a8d2954689 4.0.4 2023-06-25 00:50:25 +02:00
6071ae5de3 fix(core): update 2023-06-25 00:50:25 +02:00
a664f3da76 4.0.3 2022-06-26 00:31:58 +02:00
5d3b4585b0 fix(core): update 2022-06-26 00:31:57 +02:00
11abf9aafd 4.0.2 2022-06-25 03:23:08 +02:00
1b86228bc4 fix(core): update 2022-06-25 03:23:08 +02:00
8a5097ba50 4.0.1 2022-06-25 03:19:43 +02:00
2dae7b1200 fix(core): update 2022-06-25 03:19:43 +02:00
909cceb1a5 4.0.0 2022-06-25 03:19:16 +02:00
5f1bc8dc29 BREAKING CHANGE(core): switch to esm 2022-06-25 03:19:16 +02:00
d33f943fc6 3.0.10 2020-01-31 14:51:06 +00:00
e4c2d86dbc fix(core): update 2020-01-31 14:51:05 +00:00
088bed779f 3.0.9 2019-10-11 21:56:11 +02:00
1cecba6f13 fix(core): update 2019-10-11 21:56:11 +02:00
324b93a419 3.0.8 2019-10-02 12:50:14 +02:00
4be3fc27b3 fix(core): update 2019-10-02 12:50:14 +02:00
655a8a72ff 3.0.7 2019-09-10 18:23:53 +02:00
80a77d5f06 fix(core): update 2019-09-10 18:23:53 +02:00
6296411b50 3.0.6 2019-09-10 18:18:30 +02:00
e7690d4020 fix(core): update 2019-09-10 18:18:30 +02:00
b85a29cfc1 3.0.5 2019-09-10 18:03:33 +02:00
d559b0f402 fix(core): update 2019-09-10 18:03:33 +02:00
7433c1dba4 3.0.4 2019-09-10 18:00:13 +02:00
c8f6b0296d update 2019-09-10 18:00:03 +02:00
0cffae9eaa update dependencies 2019-09-10 17:59:29 +02:00
d50c8a1260 3.0.3 2019-02-17 17:17:47 +01:00
b3702d56bc fix(core): update 2019-02-17 17:17:47 +01:00
ff0faa719b 3.0.2 2019-01-27 18:55:39 +01:00
400e228ffc fix(core): update 2019-01-27 18:55:38 +01:00
25871fc970 3.0.1 2018-10-04 17:00:33 +02:00
eb990a8ec2 fix(core): update 2018-10-04 17:00:33 +02:00
Phil Kunz
f5194b76bd Merge branch 'master' into 'master'
update

See merge request pushrocks/smartscaf!1
2018-10-04 14:48:20 +00:00
6b5e9ac617 update 2018-10-04 16:04:42 +02:00
60854250eb 3.0.0 2018-08-30 22:43:22 +02:00
53de92ac1a BREAKING CHANGE(structure): templates now take their path within the constructor 2018-08-30 22:43:22 +02:00
6cb4fff0a5 2.0.2 2018-08-28 23:57:06 +02:00
45710ded00 2.0.1 2018-08-28 00:20:02 +02:00
aa87ed9427 fix(dependencies): resolve dependencies 2018-08-28 00:20:02 +02:00
f3594447ac 2.0.0 2018-08-27 23:55:14 +02:00
a3f18c17ed BREAKING CHANGE(scope): switch to new @pushrocks scope 2018-08-27 23:55:14 +02:00
c5ec7e9c24 1.0.14 2017-08-09 16:57:39 +02:00
98875a2ece fix variable distribution 2017-08-09 16:57:32 +02:00
5b42cf93cb 1.0.13 2017-08-09 15:31:39 +02:00
e0ab34c466 update dependencies 2017-08-09 15:31:35 +02:00
beb3013e2c 1.0.12 2017-07-28 14:47:46 +02:00
5d1c0a6f1e update dependencies 2017-07-28 14:47:43 +02:00
fc450816e6 1.0.11 2017-06-02 01:03:27 +02:00
5fac35c75f prevent empty defaults.yml causing error 2017-06-02 01:03:24 +02:00
47 changed files with 12233 additions and 1732 deletions

View File

@@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{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 @ship.zone/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: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{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 @ship.zone/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 @ship.zone/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 @ship.zone/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 @ship.zone/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

22
.gitignore vendored
View File

@@ -1,3 +1,23 @@
node_modules/
.nogit/
# artifacts
coverage/
public/
# installs
node_modules/
# caches
.yarn/
.cache/
.rpt2_cache
# builds
dist/
dist_*/
# AI
.claude/
.serena/
#------# custom

View File

@@ -1,71 +0,0 @@
# gitzone standard
image: hosttoday/ht-docker-node:npmci
cache:
paths:
- .yarn/
key: "$CI_BUILD_STAGE"
stages:
- test
- release
- trigger
- pages
testLEGACY:
stage: test
script:
- npmci test legacy
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
allow_failure: true
testLTS:
stage: test
script:
- npmci test lts
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testSTABLE:
stage: test
script:
- npmci test stable
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci publish
only:
- tags
tags:
- docker
trigger:
stage: trigger
script:
- npmci trigger
only:
- tags
tags:
- docker
pages:
image: hosttoday/ht-docker-node:npmci
stage: pages
script:
- npmci command yarn global add npmpage
- npmci command npmpage
tags:
- docker
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public

11
.vscode/launch.json vendored Normal file
View File

@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"type": "node-terminal"
}
]
}

26
.vscode/settings.json vendored Normal file
View File

@@ -0,0 +1,26 @@
{
"json.schemas": [
{
"fileMatch": ["/npmextra.json"],
"schema": {
"type": "object",
"properties": {
"npmci": {
"type": "object",
"description": "settings for npmci"
},
"gitzone": {
"type": "object",
"description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
}
}
}
}
]
}

313
changelog.md Normal file
View File

@@ -0,0 +1,313 @@
# Changelog
## 2025-08-17 - 4.0.19 - fix(readme)
Update README with comprehensive quick start, usage examples, API reference and advanced guides
- Expanded README with a detailed Quick Start guide and installation instructions
- Added examples for creating templates, supplying variables, and scaffolding projects programmatically
- Documented core features: smart variable system, template composition, dynamic file naming, interactive CLI, and post-scaffold scripts
- Included advanced usage, CI/CD integration, template validation, and real-world example templates
- Improved formatting and added code snippets for API reference and ScafTemplate usage
## 2025-08-17 - 4.0.18 - fix(ScafTemplate)
Use interactive shell for post-scaffold scripts; update CI workflows and package metadata
- Switched ScafTemplate.runScripts to use smartshell.execInteractive so post-scaffold 'runafter' commands can run interactively
- Updated Gitea workflow environment: replaced CI image with code.foss.global/host.today/ht-docker-node:npmci and adjusted NPMCI_COMPUTED_REPOURL
- Changed CI install target from @shipzone/npmci to @ship.zone/npmci
- Updated package.json metadata (bugs URL and homepage now point to code.foss.global) and added a pnpm.overrides entry
- Minor TypeScript code cleanups and formatting (consistent trailing commas, safer string handling when parsing templates/frontmatter, improved concatenation when merging template files)
- tsconfig adjustments: enabled emitDecoratorMetadata and added baseUrl/paths entries
- Normalized README and template/test output files; updated .gitignore to ignore AI agent directories
- Updated changelog and commitinfo metadata
## 2025-08-17 - 4.0.17 - fix(ScafTemplate)
Use interactive shell for post-scaffold scripts; update test/build config and dependency versions
- Switched from smartshell.exec to smartshell.execInteractive when running smartscaf 'runafter' commands to allow interactive commands during post-scaffold execution (ScafTemplate.runScripts).
- Updated package.json scripts: test now runs with additional flags (--verbose --logfile --timeout 60). Added typings entry pointing to dist_ts/index.d.ts.
- Bumped devDependencies: @git.zone/tsbuild -> ^2.6.4, @git.zone/tstest -> ^2.3.4, @push.rocks/tapbundle -> ^6.0.3.
- Updated runtime dependency versions: @push.rocks/lik -> ^6.2.2, @push.rocks/smartfile -> ^11.2.5, @push.rocks/smartshell -> ^3.3.0 (other deps kept or minor bumps).
- Added pnpm-workspace.yaml with onlyBuiltDependencies configuration (esbuild, mongodb-memory-server, puppeteer).
## 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.

1
dist/index.d.ts vendored
View File

@@ -1 +0,0 @@
export * from './smartscaf.classes.smartscaf';

7
dist/index.js vendored
View File

@@ -1,7 +0,0 @@
"use strict";
function __export(m) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
Object.defineProperty(exports, "__esModule", { value: true });
__export(require("./smartscaf.classes.smartscaf"));
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLG1EQUE2QyJ9

View File

@@ -1,51 +0,0 @@
import { Smartfile } from 'smartfile';
export interface ScafTemplateContructorOptions {
name?: string;
description?: string;
sourceDir?: string;
}
export declare class ScafTemplate {
name: string;
description: string;
templateSmartfileArray: Smartfile[];
requiredVariables: string[];
defaultVariables: any;
suppliedVariables: any;
missingVariables: string[];
/**
* read a template from a directory
*/
readTemplateFromDir(dirPathArg: string): Promise<void>;
/**
* supply the variables to render the teplate with
* @param variablesArg gets merged with this.suppliedVariables
*/
supplyVariables(variablesArg: any): Promise<void>;
/**
* Will ask for the missing variables by cli interaction
*/
askCliForMissingVariables(): Promise<void>;
writeToDisk(destinationDirArg: any): Promise<void>;
/**
* finds all variables in a Template in as string
* e.g. myobject.someKey and myobject.someOtherKey
*/
private _findVariablesInTemplate();
/**
* checks if supplied Variables satisfy the template
*/
private _checkSuppliedVariables();
/**
* checks the default.yml at the root of a template for default variables
* allows 2 ways of notation in YAML:
* >> myObject.myKey.someDeeperKey: someValue
* >> myObject.yourKey.yourDeeperKey: yourValue
* or
* >> myObject:
* >> - someKey:
* >> - someDeeperKey: someValue
* >> - yourKey:
* >> - yourDeeperKey: yourValue
*/
private _checkDefaultVariables();
}

View File

@@ -1,141 +0,0 @@
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
const plugins = require("./smartscaf.plugins");
const helpers = require("./smartscaf.helpers");
class ScafTemplate {
constructor() {
this.suppliedVariables = {};
this.missingVariables = [];
}
/**
* read a template from a directory
*/
readTemplateFromDir(dirPathArg) {
return __awaiter(this, void 0, void 0, function* () {
let dirPath = plugins.path.resolve(dirPathArg);
this.templateSmartfileArray = yield plugins.smartfile.fs.fileTreeToObject(dirPath, '**/*');
yield this._findVariablesInTemplate();
yield this._checkSuppliedVariables();
yield this._checkDefaultVariables();
});
}
/**
* supply the variables to render the teplate with
* @param variablesArg gets merged with this.suppliedVariables
*/
supplyVariables(variablesArg) {
return __awaiter(this, void 0, void 0, function* () {
this.suppliedVariables = plugins.lodash.merge(this.suppliedVariables, variablesArg);
this.missingVariables = yield this._checkSuppliedVariables();
});
}
/**
* Will ask for the missing variables by cli interaction
*/
askCliForMissingVariables() {
return __awaiter(this, void 0, void 0, function* () {
this.missingVariables = yield this._checkSuppliedVariables();
let localSmartInteract = new plugins.smartinteract.SmartInteract();
for (let missingVariable of this.missingVariables) {
localSmartInteract.addQuestions([{
name: missingVariable,
type: 'input',
default: (() => {
if (this.defaultVariables[missingVariable]) {
return this.defaultVariables[missingVariable];
}
else {
return 'undefined variable';
}
})(),
message: `What is the value of ${missingVariable}?`
}]);
}
let answerBucket = yield localSmartInteract.runQueue();
answerBucket.answerMap.forEach((answer) => __awaiter(this, void 0, void 0, function* () {
yield helpers.deepAddToObject(this.suppliedVariables, answer.name, answer.value);
}));
});
}
writeToDisk(destinationDirArg) {
return __awaiter(this, void 0, void 0, function* () {
let smartfileArrayToWrite = plugins.lodash.cloneDeep(this.templateSmartfileArray);
for (let smartfile of smartfileArrayToWrite) {
// render the template
let template = yield plugins.smarthbs.getTemplateForString(smartfile.contents.toString());
let renderedTemplateString = template(this.suppliedVariables);
// handle frontmatter
let parsedTemplate = plugins.smartfm.parse(renderedTemplateString);
if (parsedTemplate.data.fileName) {
smartfile.updateFileName(parsedTemplate.data.fileName);
}
smartfile.contents = Buffer.from(parsedTemplate.content);
}
yield plugins.smartfile.memory.smartfileArrayToFs(smartfileArrayToWrite, destinationDirArg);
});
}
/**
* finds all variables in a Template in as string
* e.g. myobject.someKey and myobject.someOtherKey
*/
_findVariablesInTemplate() {
return __awaiter(this, void 0, void 0, function* () {
let templateVariables = [];
for (let templateSmartfile of this.templateSmartfileArray) {
let localTemplateVariables = yield plugins.smarthbs.findVarsInHbsString(templateSmartfile.contents.toString());
templateVariables = plugins.lodash.concat(templateVariables, localTemplateVariables);
}
templateVariables = plugins.lodash.uniq(templateVariables);
});
}
/**
* checks if supplied Variables satisfy the template
*/
_checkSuppliedVariables() {
return __awaiter(this, void 0, void 0, function* () {
let missingVars = [];
for (let templateSmartfile of this.templateSmartfileArray) {
let localMissingVars = yield plugins.smarthbs.checkVarsSatisfaction(templateSmartfile.contents.toString(), this.suppliedVariables);
missingVars = plugins.lodash.concat(missingVars, localMissingVars);
}
missingVars = plugins.lodash.uniq(missingVars);
return missingVars;
});
}
/**
* checks the default.yml at the root of a template for default variables
* allows 2 ways of notation in YAML:
* >> myObject.myKey.someDeeperKey: someValue
* >> myObject.yourKey.yourDeeperKey: yourValue
* or
* >> myObject:
* >> - someKey:
* >> - someDeeperKey: someValue
* >> - yourKey:
* >> - yourDeeperKey: yourValue
*/
_checkDefaultVariables() {
return __awaiter(this, void 0, void 0, function* () {
let defaultsSmartfile = this.templateSmartfileArray.filter(smartfileArg => {
return smartfileArg.parsedPath.base === 'defaults.yml';
})[0];
if (defaultsSmartfile) {
let defaultObject = yield plugins.smartyaml.yamlStringToObject(defaultsSmartfile.contents.toString());
this.defaultVariables = defaultObject;
}
else {
this.defaultVariables = {};
}
});
}
}
exports.ScafTemplate = ScafTemplate;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLmNsYXNzZXMuc21hcnRzY2FmLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRzY2FmLmNsYXNzZXMuc21hcnRzY2FmLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFBQSwrQ0FBOEM7QUFDOUMsK0NBQThDO0FBVzlDO0lBQUE7UUFNRSxzQkFBaUIsR0FBUSxFQUFFLENBQUE7UUFDM0IscUJBQWdCLEdBQWEsRUFBRSxDQUFBO0lBOEhqQyxDQUFDO0lBNUhDOztPQUVHO0lBQ0csbUJBQW1CLENBQUUsVUFBa0I7O1lBQzNDLElBQUksT0FBTyxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1lBQzlDLElBQUksQ0FBQyxzQkFBc0IsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGdCQUFnQixDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsQ0FBQTtZQUMxRixNQUFNLElBQUksQ0FBQyx3QkFBd0IsRUFBRSxDQUFBO1lBQ3JDLE1BQU0sSUFBSSxDQUFDLHVCQUF1QixFQUFFLENBQUE7WUFDcEMsTUFBTSxJQUFJLENBQUMsc0JBQXNCLEVBQUUsQ0FBQTtRQUNyQyxDQUFDO0tBQUE7SUFFRDs7O09BR0c7SUFDRyxlQUFlLENBQUUsWUFBWTs7WUFDakMsSUFBSSxDQUFDLGlCQUFpQixHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxpQkFBaUIsRUFBRSxZQUFZLENBQUMsQ0FBQTtZQUNuRixJQUFJLENBQUMsZ0JBQWdCLEdBQUcsTUFBTSxJQUFJLENBQUMsdUJBQXVCLEVBQUUsQ0FBQTtRQUM5RCxDQUFDO0tBQUE7SUFFRDs7T0FFRztJQUNHLHlCQUF5Qjs7WUFDN0IsSUFBSSxDQUFDLGdCQUFnQixHQUFHLE1BQU0sSUFBSSxDQUFDLHVCQUF1QixFQUFFLENBQUE7WUFDNUQsSUFBSSxrQkFBa0IsR0FBRyxJQUFJLE9BQU8sQ0FBQyxhQUFhLENBQUMsYUFBYSxFQUFFLENBQUE7WUFDbEUsR0FBRyxDQUFDLENBQUMsSUFBSSxlQUFlLElBQUksSUFBSSxDQUFDLGdCQUFnQixDQUFDLENBQUMsQ0FBQztnQkFDbEQsa0JBQWtCLENBQUMsWUFBWSxDQUFDLENBQUM7d0JBQy9CLElBQUksRUFBRSxlQUFlO3dCQUNyQixJQUFJLEVBQUUsT0FBTzt3QkFDYixPQUFPLEVBQUUsQ0FBQzs0QkFDUixFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLENBQUMsZUFBZSxDQUFDLENBQUMsQ0FBQyxDQUFDO2dDQUMzQyxNQUFNLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLGVBQWUsQ0FBQyxDQUFBOzRCQUMvQyxDQUFDOzRCQUFDLElBQUksQ0FBQyxDQUFDO2dDQUNOLE1BQU0sQ0FBQyxvQkFBb0IsQ0FBQTs0QkFDN0IsQ0FBQzt3QkFDSCxDQUFDLENBQUMsRUFBRTt3QkFDSixPQUFPLEVBQUUsd0JBQXdCLGVBQWUsR0FBRztxQkFDcEQsQ0FBQyxDQUFDLENBQUE7WUFDTCxDQUFDO1lBQ0QsSUFBSSxZQUFZLEdBQUcsTUFBTSxrQkFBa0IsQ0FBQyxRQUFRLEVBQUUsQ0FBQTtZQUN0RCxZQUFZLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxDQUFNLE1BQU07Z0JBQ3pDLE1BQU0sT0FBTyxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsaUJBQWlCLEVBQUUsTUFBTSxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUE7WUFDbEYsQ0FBQyxDQUFBLENBQUMsQ0FBQTtRQUVKLENBQUM7S0FBQTtJQUVLLFdBQVcsQ0FBRSxpQkFBaUI7O1lBQ2xDLElBQUkscUJBQXFCLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLHNCQUFzQixDQUFDLENBQUE7WUFDakYsR0FBRyxDQUFDLENBQUMsSUFBSSxTQUFTLElBQUkscUJBQXFCLENBQUMsQ0FBQyxDQUFDO2dCQUU1QyxzQkFBc0I7Z0JBQ3RCLElBQUksUUFBUSxHQUFHLE1BQU0sT0FBTyxDQUFDLFFBQVEsQ0FBQyxvQkFBb0IsQ0FDeEQsU0FBUyxDQUFDLFFBQVEsQ0FBQyxRQUFRLEVBQUUsQ0FDOUIsQ0FBQTtnQkFDRCxJQUFJLHNCQUFzQixHQUFHLFFBQVEsQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsQ0FBQTtnQkFFN0QscUJBQXFCO2dCQUNyQixJQUFJLGNBQWMsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxzQkFBc0IsQ0FBQyxDQUFBO2dCQUNsRSxFQUFFLENBQUMsQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUM7b0JBQ2pDLFNBQVMsQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQTtnQkFDeEQsQ0FBQztnQkFFRCxTQUFTLENBQUMsUUFBUSxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLE9BQU8sQ0FBQyxDQUFBO1lBQzFELENBQUM7WUFFRCxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLGtCQUFrQixDQUFDLHFCQUFxQixFQUFFLGlCQUFpQixDQUFDLENBQUE7UUFDN0YsQ0FBQztLQUFBO0lBRUQ7OztPQUdHO0lBQ1csd0JBQXdCOztZQUNwQyxJQUFJLGlCQUFpQixHQUFhLEVBQUUsQ0FBQTtZQUNwQyxHQUFHLENBQUMsQ0FBQyxJQUFJLGlCQUFpQixJQUFJLElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDLENBQUM7Z0JBQzFELElBQUksc0JBQXNCLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLG1CQUFtQixDQUFDLGlCQUFpQixDQUFDLFFBQVEsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFBO2dCQUM5RyxpQkFBaUIsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxpQkFBaUIsRUFBRSxzQkFBc0IsQ0FBQyxDQUFBO1lBQ3RGLENBQUM7WUFDRCxpQkFBaUIsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxDQUFBO1FBQzVELENBQUM7S0FBQTtJQUVEOztPQUVHO0lBQ1csdUJBQXVCOztZQUNuQyxJQUFJLFdBQVcsR0FBYSxFQUFFLENBQUE7WUFDOUIsR0FBRyxDQUFDLENBQUMsSUFBSSxpQkFBaUIsSUFBSSxJQUFJLENBQUMsc0JBQXNCLENBQUMsQ0FBQyxDQUFDO2dCQUMxRCxJQUFJLGdCQUFnQixHQUFHLE1BQU0sT0FBTyxDQUFDLFFBQVEsQ0FBQyxxQkFBcUIsQ0FDakUsaUJBQWlCLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxFQUNyQyxJQUFJLENBQUMsaUJBQWlCLENBQ3ZCLENBQUE7Z0JBQ0QsV0FBVyxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLFdBQVcsRUFBRSxnQkFBZ0IsQ0FBQyxDQUFBO1lBQ3BFLENBQUM7WUFDRCxXQUFXLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUE7WUFDOUMsTUFBTSxDQUFDLFdBQVcsQ0FBQTtRQUNwQixDQUFDO0tBQUE7SUFFRDs7Ozs7Ozs7Ozs7T0FXRztJQUNXLHNCQUFzQjs7WUFDbEMsSUFBSSxpQkFBaUIsR0FBRyxJQUFJLENBQUMsc0JBQXNCLENBQUMsTUFBTSxDQUFDLFlBQVk7Z0JBQ3JFLE1BQU0sQ0FBQyxZQUFZLENBQUMsVUFBVSxDQUFDLElBQUksS0FBSyxjQUFjLENBQUE7WUFDeEQsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUE7WUFFTCxFQUFFLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQyxDQUFDLENBQUM7Z0JBQ3RCLElBQUksYUFBYSxHQUFHLE1BQU0sT0FBTyxDQUFDLFNBQVMsQ0FBQyxrQkFBa0IsQ0FDNUQsaUJBQWlCLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUN0QyxDQUFBO2dCQUNELElBQUksQ0FBQyxnQkFBZ0IsR0FBRyxhQUFhLENBQUE7WUFDdkMsQ0FBQztZQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNOLElBQUksQ0FBQyxnQkFBZ0IsR0FBRyxFQUFFLENBQUE7WUFDNUIsQ0FBQztRQUNILENBQUM7S0FBQTtDQUNGO0FBcklELG9DQXFJQyJ9

View File

@@ -1,4 +0,0 @@
/**
* adds a variable in string dot notation to an already more or less expanded object
*/
export declare let deepAddToObject: (objectArg: any, varStringArg: string, valueArg: string) => Promise<void>;

View File

@@ -1,43 +0,0 @@
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
/**
* adds a variable in string dot notation to an already more or less expanded object
*/
exports.deepAddToObject = (objectArg, varStringArg, valueArg) => __awaiter(this, void 0, void 0, function* () {
let varNamesArray = varStringArg.split('.');
let referencePointer = objectArg;
for (let i = 0; i !== varNamesArray.length; i++) {
let varName = varNamesArray[i];
// is there a next variable ?
let varNameNext = (() => {
if (varNamesArray[i + 1]) {
return varNamesArray[i + 1];
}
return null;
})();
// build the tree in suppliedVariables
if (!referencePointer[varName] && !varNameNext) {
referencePointer[varName] = valueArg;
referencePointer = null;
}
else if (!referencePointer[varName] && varNameNext) {
referencePointer[varName] = {};
referencePointer = referencePointer[varName];
}
else if (referencePointer[varName] && varNameNext) {
referencePointer = referencePointer[varName];
}
else {
throw new Error('Something is strange!');
}
}
});
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLmhlbHBlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHNjYWYuaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBRUE7O0dBRUc7QUFDUSxRQUFBLGVBQWUsR0FBRyxDQUFPLFNBQVMsRUFBRSxZQUFvQixFQUFFLFFBQWdCO0lBQ25GLElBQUksYUFBYSxHQUFHLFlBQVksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUE7SUFDM0MsSUFBSSxnQkFBZ0IsR0FBRyxTQUFTLENBQUE7SUFDaEMsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsS0FBSyxhQUFhLENBQUMsTUFBTSxFQUFFLENBQUMsRUFBRSxFQUFFLENBQUM7UUFDaEQsSUFBSSxPQUFPLEdBQUcsYUFBYSxDQUFDLENBQUMsQ0FBQyxDQUFBO1FBRTlCLDZCQUE2QjtRQUM3QixJQUFJLFdBQVcsR0FBVyxDQUFDO1lBQ3pCLEVBQUUsQ0FBQyxDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUN6QixNQUFNLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQTtZQUM3QixDQUFDO1lBQ0QsTUFBTSxDQUFDLElBQUksQ0FBQTtRQUNiLENBQUMsQ0FBQyxFQUFFLENBQUE7UUFFSixzQ0FBc0M7UUFDdEMsRUFBRSxDQUFDLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDL0MsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLEdBQUcsUUFBUSxDQUFBO1lBQ3BDLGdCQUFnQixHQUFHLElBQUksQ0FBQTtRQUN6QixDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLElBQUksV0FBVyxDQUFDLENBQUMsQ0FBQztZQUNyRCxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUE7WUFDOUIsZ0JBQWdCLEdBQUcsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLENBQUE7UUFDOUMsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsSUFBSSxXQUFXLENBQUMsQ0FBQyxDQUFDO1lBQ3BELGdCQUFnQixHQUFHLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxDQUFBO1FBQzlDLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNOLE1BQU0sSUFBSSxLQUFLLENBQUMsdUJBQXVCLENBQUMsQ0FBQTtRQUMxQyxDQUFDO0lBQ0gsQ0FBQztBQUNILENBQUMsQ0FBQSxDQUFBIn0=

View File

@@ -1,10 +0,0 @@
import 'typings-global';
import * as lodash from 'lodash';
import * as path from 'path';
import * as smartfile from 'smartfile';
import * as smartfm from 'smartfm';
import * as smarthbs from 'smarthbs';
import * as smartinteract from 'smartinteract';
import * as smartq from 'smartq';
import * as smartyaml from 'smartyaml';
export { lodash, path, smartfile, smartfm, smarthbs, smartinteract, smartq, smartyaml };

View File

@@ -1,20 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
require("typings-global");
const lodash = require("lodash");
exports.lodash = lodash;
const path = require("path");
exports.path = path;
const smartfile = require("smartfile");
exports.smartfile = smartfile;
const smartfm = require("smartfm");
exports.smartfm = smartfm;
const smarthbs = require("smarthbs");
exports.smarthbs = smarthbs;
const smartinteract = require("smartinteract");
exports.smartinteract = smartinteract;
const smartq = require("smartq");
exports.smartq = smartq;
const smartyaml = require("smartyaml");
exports.smartyaml = smartyaml;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHNjYWYucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUN2QixpQ0FBZ0M7QUFVOUIsd0JBQU07QUFUUiw2QkFBNEI7QUFVMUIsb0JBQUk7QUFUTix1Q0FBc0M7QUFVcEMsOEJBQVM7QUFUWCxtQ0FBa0M7QUFVaEMsMEJBQU87QUFUVCxxQ0FBb0M7QUFVbEMsNEJBQVE7QUFUViwrQ0FBOEM7QUFVNUMsc0NBQWE7QUFUZixpQ0FBZ0M7QUFVOUIsd0JBQU07QUFUUix1Q0FBc0M7QUFVcEMsOEJBQVMifQ==

View File

@@ -1,29 +0,0 @@
# smartscaf
scaffold projects quickly
## Availabililty
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartscaf)
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartscaf)
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartscaf)
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartscaf/)
## Status for master
[![build status](https://GitLab.com/pushrocks/smartscaf/badges/master/build.svg)](https://GitLab.com/pushrocks/smartscaf/commits/master)
[![coverage report](https://GitLab.com/pushrocks/smartscaf/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartscaf/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/smartscaf.svg)](https://www.npmjs.com/package/smartscaf)
[![Dependency Status](https://david-dm.org/pushrocks/smartscaf.svg)](https://david-dm.org/pushrocks/smartscaf)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartscaf/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartscaf/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartscaf/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartscaf)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## Usage
Use TypeScript for best in class instellisense.
For further information read the linked docs at the top of this README.
> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
| 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://)

View File

@@ -3,8 +3,31 @@
"coverageTreshold": 30
},
"npmci": {
"globalNpmTools": [
"npmts"
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"gitzone": {
"projectType": "npm",
"module": {
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "smartscaf",
"description": "A project aimed at quickly scaffolding projects with support for TypeScript, smart file handling, and template rendering.",
"npmPackagename": "@push.rocks/smartscaf",
"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,39 +1,71 @@
{
"name": "smartscaf",
"version": "1.0.10",
"description": "scaffold projects quickly",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"name": "@push.rocks/smartscaf",
"version": "4.0.19",
"private": false,
"description": "A project aimed at quickly scaffolding projects with support for TypeScript, smart file handling, and template rendering.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"scripts": {
"test": "(npmts)"
"test": "(tstest test/ --verbose --logfile --timeout 60)",
"build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "tsdoc"
},
"repository": {
"type": "git",
"url": "git+ssh://git@gitlab.com/pushrocks/smartscaf.git"
"url": "https://code.foss.global/push.rocks/smartscaf.git"
},
"author": "Lossless GmbH",
"license": "MIT",
"bugs": {
"url": "https://gitlab.com/pushrocks/smartscaf/issues"
"url": "https://code.foss.global/push.rocks/smartscaf/issues"
},
"homepage": "https://gitlab.com/pushrocks/smartscaf#README",
"homepage": "https://code.foss.global/push.rocks/smartscaf#readme",
"keywords": [
"scaffold",
"polymer",
"npm"
"typescript",
"scaffolding",
"template rendering",
"file handling",
"project setup",
"smart interaction",
"yaml",
"cli tool"
],
"devDependencies": {
"tapbundle": "^1.0.13"
"@git.zone/tsbuild": "^2.6.4",
"@git.zone/tsrun": "^1.3.3",
"@git.zone/tstest": "^2.3.4",
"@push.rocks/tapbundle": "^6.0.3",
"@types/node": "^22.14.1"
},
"dependencies": {
"@types/lodash": "^4.14.64",
"lodash": "^4.17.4",
"smartfile": "^4.2.17",
"smartfm": "^1.0.5",
"smarthbs": "^1.0.15",
"smartinteract": "^1.0.4",
"smartq": "^1.1.1",
"smartyaml": "^1.0.2",
"typings-global": "^1.0.16"
"@push.rocks/lik": "^6.2.2",
"@push.rocks/smartfile": "^11.2.5",
"@push.rocks/smartfm": "^2.2.2",
"@push.rocks/smarthbs": "^3.0.3",
"@push.rocks/smartinteract": "^2.0.16",
"@push.rocks/smartobject": "^1.0.12",
"@push.rocks/smartpromise": "^4.2.3",
"@push.rocks/smartshell": "^3.3.0",
"@push.rocks/smartyaml": "^3.0.4"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"type": "module",
"browserslist": [
"last 1 chrome versions"
],
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6",
"pnpm": {
"overrides": {}
}
}

10833
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

4
pnpm-workspace.yaml Normal file
View File

@@ -0,0 +1,4 @@
onlyBuiltDependencies:
- esbuild
- mongodb-memory-server
- puppeteer

1
readme.hints.md Normal file
View File

@@ -0,0 +1 @@

438
readme.md
View File

@@ -1,29 +1,421 @@
# smartscaf
scaffold projects quickly
# @push.rocks/smartscaf 🚀
## Availabililty
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartscaf)
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartscaf)
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartscaf)
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartscaf/)
**Lightning-fast project scaffolding with smart templates and variable interpolation**
## Status for master
[![build status](https://GitLab.com/pushrocks/smartscaf/badges/master/build.svg)](https://GitLab.com/pushrocks/smartscaf/commits/master)
[![coverage report](https://GitLab.com/pushrocks/smartscaf/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartscaf/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/smartscaf.svg)](https://www.npmjs.com/package/smartscaf)
[![Dependency Status](https://david-dm.org/pushrocks/smartscaf.svg)](https://david-dm.org/pushrocks/smartscaf)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartscaf/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartscaf/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartscaf/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartscaf)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## What It Does
## Usage
Use TypeScript for best in class instellisense.
SmartScaf is a powerful TypeScript scaffolding engine that transforms template directories into fully configured projects in seconds. Think of it as your project's DNA replicator - define once, deploy anywhere with custom variables, dependency merging, and automated post-setup scripts.
For further information read the linked docs at the top of this README.
Perfect for:
- 🏗️ **Bootstrapping microservices** with consistent structure
- 📦 **Creating npm packages** with standard configurations
- 🎨 **Spinning up frontend projects** with your tech stack
- 🔧 **Standardizing team workflows** with company templates
-**Automating repetitive project setups**
> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
## Installation
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://)
```bash
# Install globally for CLI usage
npm install -g @push.rocks/smartscaf
# Or add to your project
npm install @push.rocks/smartscaf --save-dev
```
## Quick Start
### Create Your First Template
1. **Set up a template directory** with your project structure:
```
my-template/
├── .smartscaf.yml # Template configuration
├── package.json # With {{projectName}} variables
├── src/
│ └── index.ts # Your source files
├── readme.md # With {{description}} placeholder
└── .gitignore # Standard ignores
```
2. **Configure your template** in `.smartscaf.yml`:
```yaml
# Template defaults and configuration
defaults:
projectName: 'my-awesome-project'
description: 'A fantastic new project'
author: '{{gitName}}'
license: 'MIT'
nodeVersion: '20'
# Merge other templates (optional)
dependencies:
merge:
- ../shared-config-template
- ../company-standards-template
# Post-scaffold automation
runafter:
- 'npm install'
- 'git init'
- 'git add .'
- 'git commit -m "Initial commit from SmartScaf"'
```
3. **Use Handlebars syntax** in your template files:
```typescript
// src/index.ts
/**
* {{description}}
* @author {{author}}
* @license {{license}}
*/
export class {{className}} {
constructor() {
console.log('Welcome to {{projectName}}!');
}
}
```
### Scaffold a New Project
```typescript
import { ScafTemplate } from '@push.rocks/smartscaf';
async function createProject() {
// Load your template
const template = await ScafTemplate.createTemplateFromDir('./my-template');
await template.readTemplateFromDir();
// Supply variables (overrides defaults)
await template.supplyVariables({
projectName: 'super-api',
description: 'Revolutionary API service',
className: 'SuperAPI',
author: 'John Doe'
});
// Interactive mode - asks for any missing variables
await template.askCliForMissingVariables();
// Generate the project
await template.writeToDisk('./projects/super-api');
console.log('✨ Project scaffolded successfully!');
}
createProject();
```
## Core Features
### 🎯 Smart Variable System
SmartScaf intelligently manages template variables through multiple layers:
```typescript
const template = await ScafTemplate.createTemplateFromDir('./template');
await template.readTemplateFromDir();
// Access variable collections
console.log(template.defaultVariables); // From .smartscaf.yml defaults
console.log(template.requiredVariables); // Found in template files
console.log(template.suppliedVariables); // What you've provided
console.log(template.missingVariables); // What still needs values
```
### 🔀 Template Composition
Merge multiple templates to create complex project structures:
```yaml
# .smartscaf.yml
dependencies:
merge:
- ../base-template # Common structure
- ../auth-template # Authentication setup
- ../docker-template # Container configuration
```
Templates are merged in order, allowing you to build sophisticated scaffolds from modular components.
### 📝 Dynamic File Naming
Use frontmatter to dynamically rename files during scaffolding:
```markdown
---
fileName: {{projectName}}.config.js
---
module.exports = {
name: '{{projectName}}',
version: '{{version}}'
};
```
### 🤖 Interactive CLI Mode
Let SmartScaf prompt for missing variables:
```typescript
// Automatically prompts for any variables not yet supplied
await template.askCliForMissingVariables();
```
### 🚀 Post-Scaffold Scripts
Automate setup tasks after scaffolding:
```yaml
runafter:
- 'npm install' # Install dependencies
- 'npm run build' # Initial build
- 'npm test' # Verify setup
- 'code .' # Open in VS Code
```
Scripts run in order using an interactive shell, ensuring proper environment handling.
## Advanced Usage
### Programmatic Control
```typescript
import { ScafTemplate } from '@push.rocks/smartscaf';
class ProjectGenerator {
private template: ScafTemplate;
async initialize(templatePath: string) {
this.template = await ScafTemplate.createTemplateFromDir(templatePath);
await this.template.readTemplateFromDir();
}
async generate(config: any, outputPath: string) {
// Supply configuration
await this.template.supplyVariables(config);
// Check what's missing
if (this.template.missingVariables.length > 0) {
console.log('Missing:', this.template.missingVariables);
// Handle missing variables programmatically
// or use: await this.template.askCliForMissingVariables();
}
// Generate project
await this.template.writeToDisk(outputPath);
}
}
```
### Template Validation
```typescript
// Validate template before using
const template = await ScafTemplate.createTemplateFromDir('./template');
await template.readTemplateFromDir();
// Check template structure
if (template.templateSmartfileArray.length === 0) {
throw new Error('Template is empty!');
}
// Verify required variables
const required = template.requiredVariables;
const defaults = Object.keys(template.defaultVariables);
const missing = required.filter(v => !defaults.includes(v));
if (missing.length > 0) {
console.warn(`Template needs: ${missing.join(', ')}`);
}
```
### Complex Variable Structures
SmartScaf supports nested object variables:
```yaml
# .smartscaf.yml
defaults:
app.name: 'MyApp'
app.version: '1.0.0'
database.host: 'localhost'
database.port: 5432
api.endpoints.users: '/api/users'
api.endpoints.auth: '/api/auth'
```
Use in templates:
```javascript
// config.js
export default {
app: {
name: '{{app.name}}',
version: '{{app.version}}'
},
database: {
host: '{{database.host}}',
port: {{database.port}}
},
api: {
users: '{{api.endpoints.users}}',
auth: '{{api.endpoints.auth}}'
}
};
```
### CI/CD Integration
```typescript
// ci-scaffold.ts
import { ScafTemplate } from '@push.rocks/smartscaf';
async function scaffoldForCI() {
const template = await ScafTemplate.createTemplateFromDir(
process.env.TEMPLATE_PATH
);
await template.readTemplateFromDir();
// Get variables from environment
const vars = {
projectName: process.env.PROJECT_NAME,
environment: process.env.DEPLOY_ENV,
apiKey: process.env.API_KEY,
region: process.env.AWS_REGION
};
await template.supplyVariables(vars);
await template.writeToDisk(process.env.OUTPUT_PATH);
}
// Run in CI pipeline
scaffoldForCI().catch(console.error);
```
## Real-World Examples
### Microservice Template
```yaml
# .smartscaf.yml for microservice template
defaults:
serviceName: 'my-service'
port: 3000
dockerImage: 'node:20-alpine'
healthPath: '/health'
dependencies:
merge:
- ../shared/base-service
- ../shared/monitoring
- ../shared/logging
runafter:
- 'npm install'
- 'docker build -t {{serviceName}}:latest .'
- 'npm run test:integration'
```
### React Component Library
```yaml
# .smartscaf.yml for React library
defaults:
libraryName: 'ui-components'
componentPrefix: 'UI'
useTypeScript: true
useStorybook: true
testRunner: 'jest'
runafter:
- 'pnpm install'
- 'pnpm build'
- 'pnpm storybook:build'
- 'pnpm test'
```
## API Reference
### ScafTemplate Class
```typescript
class ScafTemplate {
// Factory method
static createTemplateFromDir(dirPath: string): Promise<ScafTemplate>
// Core methods
readTemplateFromDir(): Promise<void>
supplyVariables(variables: object): Promise<void>
askCliForMissingVariables(): Promise<void>
writeToDisk(destinationPath: string): Promise<void>
// Properties
name: string // Template name
description: string // Template description
templateSmartfileArray: SmartFile[] // Loaded template files
defaultVariables: object // Default values from .smartscaf.yml
requiredVariables: string[] // Variables found in templates
suppliedVariables: object // Variables you've provided
missingVariables: string[] // Variables still needed
}
```
## Best Practices
### 📁 Template Organization
```
company-templates/
├── base/ # Shared foundations
│ ├── typescript/ # TS configuration
│ ├── eslint/ # Linting setup
│ └── ci-cd/ # CI/CD pipelines
├── services/ # Service templates
│ ├── rest-api/
│ ├── graphql-api/
│ └── worker-service/
└── frontends/ # Frontend templates
├── react-app/
├── vue-app/
└── static-site/
```
### 🔒 Security Considerations
- Never commit sensitive data in templates
- Use environment variables for secrets
- Add `.smartscaf.yml` to `.gitignore` if it contains private defaults
- Validate user input when using in automation
### 🎨 Template Design Tips
1. **Start small** - Begin with minimal templates and grow them
2. **Use composition** - Build complex templates from simple ones
3. **Document variables** - Add comments in `.smartscaf.yml`
4. **Test templates** - Create test scaffolds before deploying
5. **Version templates** - Use git tags for template versions
## 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,33 +1,37 @@
import { expect, tap } from 'tapbundle'
import * as path from 'path'
import { expect, tap } from '@push.rocks/tapbundle';
import * as path from 'path';
import * as smartscaf from '../dist/index'
import * as smartscaf from '../ts/index.js';
process.env.CI = 'true'
process.env.CI = 'true';
let testScafTemplate: smartscaf.ScafTemplate
let testScafTemplate: smartscaf.ScafTemplate;
tap.test('should create new Smartscaf instance', async () => {
testScafTemplate = new smartscaf.ScafTemplate()
expect(testScafTemplate).to.be.instanceof(smartscaf.ScafTemplate)
})
testScafTemplate = new smartscaf.ScafTemplate('./test/test_template');
expect(testScafTemplate).toBeInstanceOf(smartscaf.ScafTemplate);
});
tap.test('Smartscaf instance -> should read a template directory', async () => {
await testScafTemplate.readTemplateFromDir('./test/test_template')
expect(testScafTemplate.templateSmartfileArray.length).to.equal(5)
})
await testScafTemplate.readTemplateFromDir();
expect(testScafTemplate.templateSmartfileArray.length).toEqual(6);
});
tap.test('smartfile -> should accept variables', async () => {
await testScafTemplate.supplyVariables({})
console.log(testScafTemplate.missingVariables)
})
await testScafTemplate.supplyVariables({});
console.log(testScafTemplate.missingVariables);
});
tap.test('ask cli', async () => {
await testScafTemplate.askCliForMissingVariables()
})
await testScafTemplate.askCliForMissingVariables();
});
tap.test('should have valid supplied variables', async () => {
console.log(testScafTemplate.suppliedVariables);
});
tap.test('should output ready rendered template', async () => {
await testScafTemplate.writeToDisk(path.resolve('./test/test_output'))
})
await testScafTemplate.writeToDisk(path.resolve('./test/test_output'));
});
tap.start()
tap.start();

View File

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

View File

@@ -1 +1,2 @@
# some undefined variable

View File

@@ -1,4 +0,0 @@
templateVar1: from default yaml
templateVar2: this is another value from yml
templateObject.value1: wow
templateObject.value2: here

View File

@@ -0,0 +1 @@
# param1 10

View File

@@ -1,3 +1,5 @@
# this is a from default yaml
# this is a this is another value from yml
# this is a undefined variable

View File

@@ -1 +0,0 @@
# some undefined variable

View File

@@ -0,0 +1,13 @@
defaults:
templateVar1: from default yaml
templateVar2: this is another value from yml
templateObject.value1: wow
templateObject.value2: here
node_version: '10'
dependencies:
merge:
- ../test_template_2
runafter:
- echo 'runafter'

View File

@@ -1,4 +0,0 @@
templateVar1: from default yaml
templateVar2: this is another value from yml
templateObject.value1: wow
templateObject.value2: here

View File

@@ -1,3 +1,9 @@
---
fileName: anothername.yml
---
# this is a {{templateObject.value1}}
# this is a {{templateObject.value2}}
# this is a {{templateVar3}}

View File

@@ -1,3 +1,5 @@
# this is a {{templateVar1}}
# this is a {{templateVar2}}
# this is a {{templateVar3}}

View File

@@ -1,4 +1,5 @@
---
fileName: changedname.md
---
# some {{wow}}

View File

@@ -0,0 +1 @@
# param1 {{node_version}}

8
ts/00_commitinfo_data.ts Normal file
View File

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

View File

@@ -1 +1 @@
export * from './smartscaf.classes.smartscaf'
export * from './smartscaf.classes.smartscaf.js';

1
ts/interfaces/index.ts Normal file
View File

@@ -0,0 +1 @@
export * from './smartscaf.js';

View File

@@ -0,0 +1,7 @@
export interface ISmartscafFile {
defaults: { [key: string]: string };
dependencies: {
merge: string[];
};
runafter: string[];
}

View File

@@ -1,91 +1,180 @@
import * as plugins from './smartscaf.plugins'
import * as helpers from './smartscaf.helpers'
// interfaces
import { Smartfile } from 'smartfile'
import * as plugins from './smartscaf.plugins.js';
import * as interfaces from './interfaces/index.js';
export interface ScafTemplateContructorOptions {
name?: string,
description?: string
sourceDir?: string
name?: string;
description?: string;
sourceDir?: string;
}
export class ScafTemplate {
name: string
description: string
templateSmartfileArray: Smartfile[]
requiredVariables: string[]
defaultVariables: any
suppliedVariables: any = {}
missingVariables: string[] = []
public static async createTemplateFromDir(dirPathArg: string) {
return new ScafTemplate(dirPathArg);
}
/**
* the name of the template
*/
public name: string;
/**
* the descriptions of the template
*/
public description: string;
/**
* the location on disk of the template
*/
public dirPath: string;
public destinationPath: string;
/**
* smartscafFile
*/
public smartscafFile: interfaces.ISmartscafFile;
/**
* the files of the template as array of Smartfiles
*/
public templateSmartfileArray: plugins.smartfile.SmartFile[];
public requiredVariables: string[];
public defaultVariables: any;
public suppliedVariables: any = {};
public missingVariables: string[] = [];
constructor(dirPathArg: string) {
this.dirPath = plugins.path.resolve(dirPathArg);
}
/**
* read a template from a directory
*/
async readTemplateFromDir (dirPathArg: string) {
let dirPath = plugins.path.resolve(dirPathArg)
this.templateSmartfileArray = await plugins.smartfile.fs.fileTreeToObject(dirPath, '**/*')
await this._findVariablesInTemplate()
await this._checkSuppliedVariables()
await this._checkDefaultVariables()
public async readTemplateFromDir() {
this.templateSmartfileArray = await plugins.smartfile.fs.fileTreeToObject(
this.dirPath,
'**/*',
);
// read .smartscaf.yml file
let smartscafFile: interfaces.ISmartscafFile = {
defaults: {},
dependencies: {
merge: [],
},
runafter: [],
};
const smartscafSmartfile = this.templateSmartfileArray.find(
(smartfileArg) => {
return smartfileArg.parsedPath.base === '.smartscaf.yml';
},
);
if (smartscafSmartfile) {
smartscafFile = {
...smartscafFile,
...(await plugins.smartyaml.yamlStringToObject(
smartscafSmartfile.contentBuffer.toString(),
)),
};
}
this.smartscafFile = smartscafFile;
await this._resolveTemplateDependencies();
await this._findVariablesInTemplate();
await this._checkSuppliedVariables();
await this._checkDefaultVariables();
}
/**
* supply the variables to render the teplate with
* @param variablesArg gets merged with this.suppliedVariables
*/
async supplyVariables (variablesArg) {
this.suppliedVariables = plugins.lodash.merge(this.suppliedVariables, variablesArg)
this.missingVariables = await this._checkSuppliedVariables()
public async supplyVariables(variablesArg) {
this.suppliedVariables = {
...this.suppliedVariables,
...variablesArg,
};
this.missingVariables = await this._checkSuppliedVariables();
}
/**
* Will ask for the missing variables by cli interaction
*/
async askCliForMissingVariables () {
this.missingVariables = await this._checkSuppliedVariables()
let localSmartInteract = new plugins.smartinteract.SmartInteract()
for (let missingVariable of this.missingVariables) {
localSmartInteract.addQuestions([{
public async askCliForMissingVariables() {
this.missingVariables = await this._checkSuppliedVariables();
const localSmartInteract = new plugins.smartinteract.SmartInteract();
for (const missingVariable of this.missingVariables) {
localSmartInteract.addQuestions([
{
name: missingVariable,
type: 'input',
default: (() => {
if (this.defaultVariables[missingVariable]) {
return this.defaultVariables[missingVariable]
if (
this.defaultVariables &&
this.defaultVariables[missingVariable]
) {
return this.defaultVariables[missingVariable];
} else {
return 'undefined variable'
return 'undefined variable';
}
})(),
message: `What is the value of ${missingVariable}?`
}])
message: `What is the value of ${missingVariable}?`,
},
]);
}
const answerBucket = await localSmartInteract.runQueue();
const answers = answerBucket.getAllAnswers();
for (const answer of answers) {
await plugins.smartobject.smartAdd(
this.suppliedVariables,
answer.name,
answer.value,
);
}
let answerBucket = await localSmartInteract.runQueue()
answerBucket.answerMap.forEach(async answer => {
await helpers.deepAddToObject(this.suppliedVariables, answer.name, answer.value)
})
}
async writeToDisk (destinationDirArg) {
let smartfileArrayToWrite = plugins.lodash.cloneDeep(this.templateSmartfileArray)
for (let smartfile of smartfileArrayToWrite) {
/**
* writes a file to disk
* @param destinationDirArg
*/
public async writeToDisk(destinationDirArg) {
this.destinationPath = destinationDirArg;
const smartfileArrayToWrite: plugins.smartfile.SmartFile[] = [];
for (const smartfile of this.templateSmartfileArray) {
// lets filter out template files
if (smartfile.path === '.smartscaf.yml') {
continue;
}
// render the template
let template = await plugins.smarthbs.getTemplateForString(
smartfile.contents.toString()
)
let renderedTemplateString = template(this.suppliedVariables)
const template = await plugins.smarthbs.getTemplateForString(
smartfile.contents.toString(),
);
const renderedTemplateString = template(this.suppliedVariables);
// handle frontmatter
let parsedTemplate = plugins.smartfm.parse(renderedTemplateString)
const smartfmInstance = new plugins.smartfm.Smartfm({
fmType: 'yaml',
});
const parsedTemplate = smartfmInstance.parse(
renderedTemplateString,
) as any;
if (parsedTemplate.data.fileName) {
smartfile.updateFileName(parsedTemplate.data.fileName)
smartfile.updateFileName(parsedTemplate.data.fileName);
}
smartfile.contents = Buffer.from(parsedTemplate.content)
smartfile.contents = Buffer.from(
await plugins.smarthbs.postprocess(parsedTemplate.content),
);
smartfileArrayToWrite.push(smartfile);
}
await plugins.smartfile.memory.smartfileArrayToFs(smartfileArrayToWrite, destinationDirArg)
await plugins.smartfile.memory.smartfileArrayToFs(
smartfileArrayToWrite,
destinationDirArg,
);
await this.runScripts();
}
/**
@@ -93,32 +182,42 @@ export class ScafTemplate {
* e.g. myobject.someKey and myobject.someOtherKey
*/
private async _findVariablesInTemplate() {
let templateVariables: string[] = []
for (let templateSmartfile of this.templateSmartfileArray) {
let localTemplateVariables = await plugins.smarthbs.findVarsInHbsString(templateSmartfile.contents.toString())
templateVariables = plugins.lodash.concat(templateVariables, localTemplateVariables)
let templateVariables: string[] = [];
for (const templateSmartfile of this.templateSmartfileArray) {
const localTemplateVariables = await plugins.smarthbs.findVarsInHbsString(
templateSmartfile.contents.toString(),
);
templateVariables = [...templateVariables, ...localTemplateVariables];
}
templateVariables = plugins.lodash.uniq(templateVariables)
templateVariables = templateVariables.filter((value, index, self) => {
return self.indexOf(value) === index;
});
}
/**
* checks if supplied Variables satisfy the template
*/
private async _checkSuppliedVariables() {
let missingVars: string[] = []
for (let templateSmartfile of this.templateSmartfileArray) {
let localMissingVars = await plugins.smarthbs.checkVarsSatisfaction(
let missingVars: string[] = [];
for (const templateSmartfile of this.templateSmartfileArray) {
const localMissingVars = await plugins.smarthbs.checkVarsSatisfaction(
templateSmartfile.contents.toString(),
this.suppliedVariables
)
missingVars = plugins.lodash.concat(missingVars, localMissingVars)
this.suppliedVariables,
);
// combine with other missingVars
missingVars = [...missingVars, ...localMissingVars];
}
missingVars = plugins.lodash.uniq(missingVars)
return missingVars
// dedupe
missingVars = missingVars.filter((value, index, self) => {
return self.indexOf(value) === index;
});
return missingVars;
}
/**
* checks the default.yml at the root of a template for default variables
* checks the smartscaf.yml default values at the root of a template
* allows 2 ways of notation in YAML:
* >> myObject.myKey.someDeeperKey: someValue
* >> myObject.yourKey.yourDeeperKey: yourValue
@@ -130,17 +229,63 @@ export class ScafTemplate {
* >> - yourDeeperKey: yourValue
*/
private async _checkDefaultVariables() {
let defaultsSmartfile = this.templateSmartfileArray.filter(smartfileArg => {
return smartfileArg.parsedPath.base === 'defaults.yml'
})[0]
const smartscafSmartfile = this.templateSmartfileArray.find(
(smartfileArg) => {
return smartfileArg.parsedPath.base === '.smartscaf.yml';
},
);
if (defaultsSmartfile) {
let defaultObject = await plugins.smartyaml.yamlStringToObject(
defaultsSmartfile.contents.toString()
)
this.defaultVariables = defaultObject
} else {
this.defaultVariables = {}
if (smartscafSmartfile) {
const smartscafObject = await plugins.smartyaml.yamlStringToObject(
smartscafSmartfile.contents.toString(),
);
const defaultObject = smartscafObject.defaults;
this.defaultVariables = defaultObject;
}
// safeguard against non existent defaults
if (!this.defaultVariables) {
console.log('this template does not specify defaults');
this.defaultVariables = {};
}
}
/**
* resolve template dependencies
*/
private async _resolveTemplateDependencies() {
console.log('looking at templates to merge!');
for (const dependency of this.smartscafFile.dependencies.merge) {
console.log(`Now resolving ${dependency}`);
const templatePathToMerge = plugins.path.join(this.dirPath, dependency);
if (!plugins.smartfile.fs.isDirectory(templatePathToMerge)) {
console.log(
`dependency ${dependency} resolves to ${templatePathToMerge} which ist NOT a directory`,
);
continue;
}
const templateSmartfileArray =
await plugins.smartfile.fs.fileTreeToObject(
templatePathToMerge,
'**/*',
);
this.templateSmartfileArray = this.templateSmartfileArray.concat(
templateSmartfileArray,
);
}
}
private async runScripts() {
if (!this.destinationPath) {
throw new Error('cannot run scripts without an destinationdir');
}
const smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash',
});
for (const command of this.smartscafFile.runafter) {
await smartshellInstance.execInteractive(
`cd ${this.destinationPath} && ${command}`,
);
}
}
}

View File

@@ -1,33 +0,0 @@
import * as plugins from './smartscaf.plugins'
/**
* adds a variable in string dot notation to an already more or less expanded object
*/
export let deepAddToObject = async (objectArg, varStringArg: string, valueArg: string) => {
let varNamesArray = varStringArg.split('.')
let referencePointer = objectArg
for (let i = 0; i !== varNamesArray.length; i++) {
let varName = varNamesArray[i]
// is there a next variable ?
let varNameNext: string = (() => {
if (varNamesArray[i + 1]) {
return varNamesArray[i + 1]
}
return null
})()
// build the tree in suppliedVariables
if (!referencePointer[varName] && !varNameNext) {
referencePointer[varName] = valueArg
referencePointer = null
} else if (!referencePointer[varName] && varNameNext) {
referencePointer[varName] = {}
referencePointer = referencePointer[varName]
} else if (referencePointer[varName] && varNameNext) {
referencePointer = referencePointer[varName]
} else {
throw new Error('Something is strange!')
}
}
}

View File

@@ -1,20 +1,23 @@
import 'typings-global'
import * as lodash from 'lodash'
import * as path from 'path'
import * as smartfile from 'smartfile'
import * as smartfm from 'smartfm'
import * as smarthbs from 'smarthbs'
import * as smartinteract from 'smartinteract'
import * as smartq from 'smartq'
import * as smartyaml from 'smartyaml'
import * as path from 'path';
import * as lik from '@push.rocks/lik';
import * as smartfile from '@push.rocks/smartfile';
import * as smartfm from '@push.rocks/smartfm';
import * as smarthbs from '@push.rocks/smarthbs';
import * as smartinteract from '@push.rocks/smartinteract';
import * as smartobject from '@push.rocks/smartobject';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartyaml from '@push.rocks/smartyaml';
import * as smartshell from '@push.rocks/smartshell';
export {
lodash,
path,
lik,
smartfile,
smartfm,
smarthbs,
smartinteract,
smartq,
smartyaml
}
smartobject,
smartpromise,
smartyaml,
smartshell,
};

15
tsconfig.json Normal file
View File

@@ -0,0 +1,15 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true,
"baseUrl": ".",
"paths": {}
},
"exclude": ["dist_*/**/*.d.ts"]
}

View File

@@ -1,3 +0,0 @@
{
"extends": "tslint-config-standard"
}

1135
yarn.lock

File diff suppressed because it is too large Load Diff