chore(release): 1.9.0 [skip ci]

# [1.9.0](https://github.com/chenasraf/simple-scaffold/compare/v1.8.0...v1.9.0) (2024-01-02)

### Features

* add --recurse-submodules to git clone ([cbaf130](cbaf130a0c))

.github/workflows/docs.yml

@@ -6,7 +6,7 @@ on:
 jobs:
   docs:
     runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[skip docs]')"
+    if: "contains(github.event.head_commit.message, 'chore(release)')"
     steps:
       - name: Checkout
         uses: actions/checkout@v3

.github/workflows/pull_requests.yml

@@ -6,7 +6,6 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
       - name: Checkout
         uses: actions/checkout@v3

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: Test & Build
+name: Release
 
 on:
   push:
@@ -6,26 +6,9 @@ on:
 permissions:
   contents: read # for checkout
 jobs:
-  test:
-    name: Test
-    permissions:
-      contents: write # to be able to publish a GitHub release
-      issues: write # to be able to comment on released issues
-      pull-requests: write # to be able to comment on released pull requests
-      id-token: write # to enable use of OIDC for npm provenance
+  release:
+    name: Release
     runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2
-        with:
-          run_install: |
-            - recursive: true
-              args: [--frozen-lockfile, --strict-peer-dependencies]
-      - run: pnpm test
-  build:
-    name: Build
-    runs-on: ubuntu-latest
-    needs: test
     permissions:
       contents: write # to be able to publish a GitHub release
       issues: write # to be able to comment on released issues

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+# [1.9.0](https://github.com/chenasraf/simple-scaffold/compare/v1.8.0...v1.9.0) (2024-01-02)
+
+
+### Features
+
+* add --recurse-submodules to git clone ([cbaf130](https://github.com/chenasraf/simple-scaffold/commit/cbaf130a0cce45a2d20a3c2d132ac98e2f105b4f))
+
+## [1.8.0](https://github.com/chenasraf/simple-scaffold/compare/v1.7.2...v1.8.0) (2023-11-29)
+
+
+### Bug Fixes
+
+* **config:** fn config load ([457c904](https://github.com/chenasraf/simple-scaffold/commit/457c90470b0f138862469ff878c7e061c7afd18a)), closes [#63](https://github.com/chenasraf/simple-scaffold/issues/63)
+
+## [1.8.0-pre.1](https://github.com/chenasraf/simple-scaffold/compare/v1.7.2...v1.8.0-pre.1) (2023-11-27)
+
+
+### Bug Fixes
+
+* **config:** fn config load ([457c904](https://github.com/chenasraf/simple-scaffold/commit/457c90470b0f138862469ff878c7e061c7afd18a)), closes [#63](https://github.com/chenasraf/simple-scaffold/issues/63)
+
 ## [1.7.2](https://github.com/chenasraf/simple-scaffold/compare/v1.7.1...v1.7.2) (2023-08-20)
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-scaffold",
-  "version": "1.7.2",
+  "version": "1.9.0",
   "description": "Generate any file structure - from single components to entire app boilerplates, with a single command.",
   "homepage": "https://chenasraf.github.io/simple-scaffold",
   "repository": "https://github.com/chenasraf/simple-scaffold.git",
@@ -21,7 +21,7 @@
     "scaffolding"
   ],
   "scripts": {
-    "clean": "rimraf dist/",
+    "clean": "rm -rf dist/",
     "build": "pnpm clean && tsc && chmod -R +x ./dist && cp ./package.json ./README.md ./dist/",
     "dev": "tsc --watch",
     "start": "node dist/scaffold.js",
@@ -56,7 +56,6 @@
     "conventional-changelog-conventionalcommits": "^5.0.0",
     "jest": "^29.5.0",
     "mock-fs": "^5.2.0",
-    "rimraf": "^5.0.0",
     "semantic-release": "^21.0.1",
     "semantic-release-conventional-commits": "^3.0.0",
     "ts-jest": "^29.1.0",

pages/configuration_files.md

@@ -45,7 +45,7 @@ interface ScaffoldConfig {
 If you want to supply functions inside the configurations, you must use a `.js` file as JSON does
 not support non-primitives.
 
-A `.js` file is just like a `.json` file, make sure to export the final configuration:
+A `.js` file can be just like a `.json` file, make sure to export the final configuration:
 
 ```js
 /** @type {import('simple-scaffold').ScaffoldConfigFile} */
@@ -57,6 +57,23 @@ module.exports = {
 }
 ```
 
+Another feature of using a JS file is you can export a function which will be loaded with the CMD
+config provided to Simple Scaffold. The `extras` key contains any values not consumed by built-in
+flags, so you can pre-process your args before outputting a config:
+
+```js
+/** @type {import('simple-scaffold').ScaffoldConfigFile} */
+module.exports = (config) => {
+  console.log("Config:", config)
+  return {
+    component: {
+      templates: ["templates/component"],
+      output: "src/components",
+    },
+  }
+}
+```
+
 ## Using a config file
 
 Once your config is created, you can use it by providing the file name to the `--config` (or `-c`
@@ -109,12 +126,12 @@ simple-scaffold -c <git_url>[#<git_file>][:<template_key>]
 For example, to use this repository's example as base:
 
 ```shell
-simple-scaffold -c https://github.com/chenasraf/simple-scaffold.git#examples/test-input/scaffold.config.js:component
+simple-scaffold -c https://github.com/chenasraf/simple-scaffold.git#scaffold.config.js:component
 ```
 
-When the filename is omitted, `/scaffold.config.js` will be used as default.
+When the `filename` is omitted, `/scaffold.config.js` will be used as default.
 
-When the template_key is ommitted, `default` will be used as default.
+When the `template_key` is ommitted, `default` will be used as default.
 
 ### GitHub Templates
 
@@ -130,7 +147,7 @@ simple-scaffold -gh <username>/<project_name>[#<git_file>][:<template_key>]
 This example is equivalent to the above, just shorter to write:
 
 ```shell
-simple-scaffold -c chenasraf/simple-scaffold#examples/test-input/scaffold.config.js:component
+simple-scaffold -c chenasraf/simple-scaffold#scaffold.config.js:component
 ```
 
 ## Use In Node.js

pnpm-lock.yaml

@@ -64,9 +64,6 @@ devDependencies:
   mock-fs:
     specifier: ^5.2.0
     version: 5.2.0
-  rimraf:
-    specifier: ^5.0.0
-    version: 5.0.0
   semantic-release:
     specifier: ^21.0.1
     version: 21.0.1(typescript@5.0.4)
@@ -466,6 +463,7 @@ packages:
       strip-ansi-cjs: /strip-ansi@6.0.1
       wrap-ansi: 8.1.0
       wrap-ansi-cjs: /wrap-ansi@7.0.0
+    dev: false
 
   /@istanbuljs/load-nyc-config@1.1.0:
     resolution: {integrity: sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ==}
@@ -907,6 +905,7 @@ packages:
     resolution: {integrity: sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==}
     engines: {node: '>=14'}
     requiresBuild: true
+    dev: false
     optional: true
 
   /@pnpm/config.env-replace@1.1.0:
@@ -1285,6 +1284,7 @@ packages:
   /ansi-regex@6.0.1:
     resolution: {integrity: sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==}
     engines: {node: '>=12'}
+    dev: false
 
   /ansi-sequence-parser@1.1.0:
     resolution: {integrity: sha512-lEm8mt52to2fT8GhciPCGeCXACSz2UwIN4X2e2LJSnZ5uAbn2/dsYdOmUXq0AtWS5cpAupysIneExOgH0Vd2TQ==}
@@ -1311,6 +1311,7 @@ packages:
   /ansi-styles@6.2.1:
     resolution: {integrity: sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==}
     engines: {node: '>=12'}
+    dev: false
 
   /ansicolors@0.3.2:
     resolution: {integrity: sha512-QXu7BPrP29VllRxH8GwB7x5iX5qWKAAMLqKQGWTeLWVlNHNOpVMJ91dsxQAIWXpjuW5wqvxu3Jd/nRjrJ+0pqg==}
@@ -1945,6 +1946,7 @@ packages:
 
   /eastasianwidth@0.2.0:
     resolution: {integrity: sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==}
+    dev: false
 
   /electron-to-chromium@1.4.382:
     resolution: {integrity: sha512-czMavlW52VIPgutbVL9JnZIZuFijzsG1ww/1z2Otu1r1q+9Qe2bTsH3My3sZarlvwyqHM6+mnZfEnt2Vr4dsIg==}
@@ -1960,6 +1962,7 @@ packages:
 
   /emoji-regex@9.2.2:
     resolution: {integrity: sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==}
+    dev: false
 
   /env-ci@9.1.0:
     resolution: {integrity: sha512-ZCEas2sDVFR3gpumwwzSU4OJZwWJ46yqJH3TqH3vSxEBzeAlC0uCJLGAnZC0vX1TIXzHzjcwpKmUn2xw5mC/qA==}
@@ -2144,6 +2147,7 @@ packages:
     dependencies:
       cross-spawn: 7.0.3
       signal-exit: 4.0.1
+    dev: false
 
   /from2@2.3.0:
     resolution: {integrity: sha512-OMcX/4IC/uqEPVgGeyfN22LJk6AZrMkRZHxcHBMBvHScDGgwTm2GT2Wkgtocyd3JfZffjj2kYUDXXII0Fk9W0g==}
@@ -2271,6 +2275,7 @@ packages:
       minimatch: 9.0.3
       minipass: 5.0.0
       path-scurry: 1.10.1
+    dev: false
 
   /glob@7.2.3:
     resolution: {integrity: sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==}
@@ -2608,6 +2613,7 @@ packages:
       '@isaacs/cliui': 8.0.2
     optionalDependencies:
       '@pkgjs/parseargs': 0.11.0
+    dev: false
 
   /java-properties@1.0.2:
     resolution: {integrity: sha512-qjdpeo2yKlYTH7nFdK0vbZWuTCesk4o63v5iVOlhMQPfuIZQfW/HI35SjfhA+4qpg36rnFSvUK5b1m+ckIblQQ==}
@@ -3191,6 +3197,7 @@ packages:
   /lru-cache@10.0.1:
     resolution: {integrity: sha512-IJ4uwUTi2qCccrioU6g9g/5rvvVl13bsdczUUcqbciD9iLr095yj8DQKdObriEvuNSx325N1rV1O0sJFszx75g==}
     engines: {node: 14 || >=16.14}
+    dev: false
 
   /lru-cache@5.1.1:
     resolution: {integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==}
@@ -3342,6 +3349,7 @@ packages:
     engines: {node: '>=16 || 14 >=14.17'}
     dependencies:
       brace-expansion: 2.0.1
+    dev: false
 
   /minimist-options@4.1.0:
     resolution: {integrity: sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A==}
@@ -3358,6 +3366,7 @@ packages:
   /minipass@5.0.0:
     resolution: {integrity: sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==}
     engines: {node: '>=8'}
+    dev: false
 
   /mock-fs@5.2.0:
     resolution: {integrity: sha512-2dF2R6YMSZbpip1V1WHKGLNjr/k48uQClqMVb5H3MOvwc9qhYis3/IWbj02qIg/Y8MDXKFF4c5v0rxx2o6xTZw==}
@@ -3739,6 +3748,7 @@ packages:
     dependencies:
       lru-cache: 10.0.1
       minipass: 5.0.0
+    dev: false
 
   /path-type@3.0.0:
     resolution: {integrity: sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==}
@@ -4014,14 +4024,6 @@ packages:
     engines: {iojs: '>=1.0.0', node: '>=0.10.0'}
     dev: true
 
-  /rimraf@5.0.0:
-    resolution: {integrity: sha512-Jf9llaP+RvaEVS5nPShYFhtXIrb3LRKP281ib3So0KkeZKo2wIKyq0Re7TOSwanasA423PSr6CCIL4bP6T040g==}
-    engines: {node: '>=14'}
-    hasBin: true
-    dependencies:
-      glob: 10.3.3
-    dev: true
-
   /run-parallel@1.2.0:
     resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==}
     dependencies:
@@ -4138,6 +4140,7 @@ packages:
   /signal-exit@4.0.1:
     resolution: {integrity: sha512-uUWsN4aOxJAS8KOuf3QMyFtgm1pkb6I+KRZbRF/ghdf5T7sM+B1lLLzPDxswUjkmHyxQAVzEgG35E3NzDM9GVw==}
     engines: {node: '>=14'}
+    dev: false
 
   /signale@1.4.0:
     resolution: {integrity: sha512-iuh+gPf28RkltuJC7W5MRi6XAjTDCAPC/prJUpQoG4vIP3MJZ+GTydVnodXA7pwvTKb2cA0m9OFZW/cdWy/I/w==}
@@ -4253,6 +4256,7 @@ packages:
       eastasianwidth: 0.2.0
       emoji-regex: 9.2.2
       strip-ansi: 7.0.1
+    dev: false
 
   /string_decoder@1.1.1:
     resolution: {integrity: sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==}
@@ -4277,6 +4281,7 @@ packages:
     engines: {node: '>=12'}
     dependencies:
       ansi-regex: 6.0.1
+    dev: false
 
   /strip-bom@3.0.0:
     resolution: {integrity: sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA==}
@@ -4678,6 +4683,7 @@ packages:
       ansi-styles: 6.2.1
       string-width: 5.1.2
       strip-ansi: 7.0.1
+    dev: false
 
   /wrappy@1.0.2:
     resolution: {integrity: sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==}

release.config.js

@@ -5,24 +5,8 @@ module.exports = {
     path: "semantic-release-conventional-commits",
   },
   plugins: [
-    [
-      "@semantic-release/commit-analyzer",
-      {
-        preset: "conventionalcommits",
-        parserOpts: {
-          noteKeywords: ["breaking:", "breaking-fix:", "breaking-feat:"],
-        },
-      },
-    ],
-    [
-      "@semantic-release/release-notes-generator",
-      {
-        preset: "conventionalcommits",
-        parserOpts: {
-          noteKeywords: ["breaking", "major"],
-        },
-      },
-    ],
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
     [
       "@semantic-release/changelog",
       {
@@ -52,12 +36,7 @@ module.exports = {
     [
       "@semantic-release/github",
       {
-        assets: [
-          {
-            path: "*.tgz",
-            name: "simple-scaffold.tgz",
-          },
-        ],
+        assets: ["*.tgz"],
       },
     ],
   ],

src/git.ts

@@ -16,7 +16,7 @@ export async function getGitConfig(
   const tmpPath = path.resolve(os.tmpdir(), `scaffold-config-${Date.now()}`)
 
   return new Promise((res, reject) => {
-    const clone = spawn("git", ["clone", "--depth", "1", repoUrl, tmpPath])
+    const clone = spawn("git", ["clone", "--recurse-submodules", "--depth", "1", repoUrl, tmpPath])
 
     clone.on("error", reject)
     clone.on("close", async (code) => {