simple-scaffold 1.3.1 → 1.4.0

package/.vscode/tasks.json

@@ -1,59 +0,0 @@
-{
-  "version": "2.0.0",
-  "tasks": [
-    {
-      "script": "build",
-      "label": "build",
-      "type": "npm",
-      "problemMatcher": []
-    },
-    {
-      "script": "dev",
-      "label": "dev",
-      "type": "npm",
-      "problemMatcher": []
-    },
-    {
-      "command": "yarn typedoc --watch",
-      "label": "typedoc --watch",
-      "type": "shell",
-      "problemMatcher": []
-    },
-    {
-      "script": "start",
-      "label": "start",
-      "type": "npm",
-      "problemMatcher": []
-    },
-    {
-      "script": "test",
-      "label": "test",
-      "type": "npm",
-      "problemMatcher": []
-    },
-    {
-      "command": "yarn test --watchAll",
-      "label": "yarn test --watchAll",
-      "type": "shell",
-      "problemMatcher": []
-    },
-    {
-      "script": "cmd",
-      "label": "cmd",
-      "type": "npm",
-      "problemMatcher": []
-    },
-    {
-      "script": "build-test",
-      "label": "build-test",
-      "type": "npm",
-      "problemMatcher": []
-    },
-    {
-      "script": "build-cmd",
-      "label": "build-cmd",
-      "type": "npm",
-      "problemMatcher": []
-    }
-  ]
-}

package/CHANGELOG.md

@@ -1,120 +0,0 @@
-# Change Log
-
-## [1.3.1](https://github.com/chenasraf/simple-scaffold/compare/v1.3.0...v1.3.1) (2023-04-28)
-
-
-### Bug Fixes
-
-* docs ([6e19a86](https://github.com/chenasraf/simple-scaffold/commit/6e19a86190dd924058a48448aa6463569ef1125f))
-* remove old peer-dep ([c7e2ef8](https://github.com/chenasraf/simple-scaffold/commit/c7e2ef862cb658feb1071ac120b185d8b34d6dd3))
-
-## [1.3.0](https://github.com/chenasraf/simple-scaffold/compare/v1.2.0...v1.3.0) (2023-04-25)
-
-### Features
-
-- load scaffold config from files
-  ([c398976](https://github.com/chenasraf/simple-scaffold/commit/c3989769fee445c9183ff5e5b3892c4e9fb66a9e))
-
-### Bug Fixes
-
-- config option should not be mandatory
-  ([3db6a91](https://github.com/chenasraf/simple-scaffold/commit/3db6a918f13d9300efa2fcb4a356d004475ab91c))
-- export config file type
-  ([4302eb5](https://github.com/chenasraf/simple-scaffold/commit/4302eb5ce35ed6cf1dc80dfb92790c3fdd96f963))
-
-## [1.2.0](https://github.com/chenasraf/simple-scaffold/compare/v1.1.4...v1.2.0) (2023-04-24)
-
-### Features
-
-- append-data cli flag
-  ([3c5c2de](https://github.com/chenasraf/simple-scaffold/commit/3c5c2ded02f61ff086e81ea4a7f40529bdff1c9d))
-
-### Bug Fixes
-
-- ci node version
-  ([767d34c](https://github.com/chenasraf/simple-scaffold/commit/767d34c684516d4cea865b25e87c27c779bb79ce))
-- semantic-release build dir
-  ([f7956dd](https://github.com/chenasraf/simple-scaffold/commit/f7956ddc786018905c48ccf1f21a3bb4657c3d75))
-- support quote wrapping in append-data
-  ([4fecca8](https://github.com/chenasraf/simple-scaffold/commit/4fecca848347312d45d704f82f2bcb3822da9b06))
-
-## [1.1.4](https://github.com/chenasraf/simple-scaffold/compare/v1.1.3...v1.1.4) (2023-03-13)
-
-### Bug Fixes
-
-- github action node version
-  ([7c19c53](https://github.com/chenasraf/simple-scaffold/commit/7c19c533376dc6904231e5cc51c7a4b2658c66e0))
-- github action node version
-  ([94fec76](https://github.com/chenasraf/simple-scaffold/commit/94fec766165f7540c578dbf2d0aeeb6ea3969ad8))
-
-### Misc
-
-- update typedoc version
-  ([c334396](https://github.com/chenasraf/simple-scaffold/commit/c334396d74414cbe0aba305c66dfad7fdeb88669))
-- update dependencies
-  ([20400bd](https://github.com/chenasraf/simple-scaffold/commit/20400bd81dd43d457427675286c9964a8bc0d5f6))
-- bump version number
-  ([8e432bf](https://github.com/chenasraf/simple-scaffold/commit/8e432bfb0b410dc0655c3924031bea2648a42ad0))
-
-## [1.1.3](https://github.com/chenasraf/simple-scaffold/compare/v1.1.2...v1.1.3) (2023-03-11)
-
-### Bug Fixes
-
-- base path
-  ([943717a](https://github.com/chenasraf/simple-scaffold/commit/943717a76998ec0609f2072c886df6b4775f2ea2))
-- binary files + add tests
-  ([e450ad2](https://github.com/chenasraf/simple-scaffold/commit/e450ad242ed70ae928b19964da38cdcb1b6cf659))
-
-## [1.1.0](https://github.com/chenasraf/simple-scaffold/compare/v1.0.4...v1.1.0) (2022-04-21)
-
-## [1.0.3](https://github.com/chenasraf/simple-scaffold/compare/v1.0.2...v1.0.3) (2022-03-03)
-
-## [1.0.1-pre.1](https://github.com/chenasraf/simple-scaffold/compare/v1.0.0...v1.0.1-pre.1) (2022-02-17)
-
-## [0.7.5](https://github.com/chenasraf/simple-scaffold/compare/v0.7.4...v0.7.5) (2021-09-26)
-
-## [0.7.4](https://github.com/chenasraf/simple-scaffold/compare/v0.7.3...v0.7.4) (2021-09-26)
-
-## [0.7.3](https://github.com/chenasraf/simple-scaffold/compare/v0.7.2...v0.7.3) (2021-09-26)
-
-## [0.7.2](https://github.com/chenasraf/simple-scaffold/compare/v0.6.1...v0.7.2) (2021-04-19)
-
-## [0.6.1](https://github.com/chenasraf/simple-scaffold/compare/v0.6.0...v0.6.1) (2021-02-01)
-
-### Bug Fixes
-
-- binary files
-  ([7c0c347](https://github.com/chenasraf/simple-scaffold/commit/7c0c3470020d7c166ea68a8effa6df65ec38f2c8))
-
-## [0.6.0](https://github.com/chenasraf/simple-scaffold/compare/v0.5.0...v0.6.0) (2021-02-01)
-
-### Bug Fixes
-
-- support deeper file structure
-  ([4afafa5](https://github.com/chenasraf/simple-scaffold/commit/4afafa5a4af2e3f4b0af54f20811ecb2c8d98560))
-
-## [0.5.0](https://github.com/chenasraf/simple-scaffold/compare/v0.4.5...v0.5.0) (2019-02-27)
-
-## [0.4.5](https://github.com/chenasraf/simple-scaffold/compare/v0.4.4...v0.4.5) (2019-02-27)
-
-## [0.4.4](https://github.com/chenasraf/simple-scaffold/compare/v0.4.3...v0.4.4) (2019-02-27)
-
-## [0.4.3](https://github.com/chenasraf/simple-scaffold/compare/v0.4.2...v0.4.3) (2019-02-27)
-
-## [0.4.2](https://github.com/chenasraf/simple-scaffold/compare/v0.4.1...v0.4.2) (2019-02-25)
-
-## [0.4.1](https://github.com/chenasraf/simple-scaffold/compare/v0.3.1...v0.4.1) (2019-02-25)
-
-## [0.3.1](https://github.com/chenasraf/simple-scaffold/compare/v0.3.0...v0.3.1) (2018-01-15)
-
-## [0.3.0](https://github.com/chenasraf/simple-scaffold/compare/v0.2.0...v0.3.0) (2018-01-15)
-
-## [0.2.0](https://github.com/chenasraf/simple-scaffold/compare/v0.1.5...v0.2.0) (2018-01-05)
-
-## [0.1.5](https://github.com/chenasraf/simple-scaffold/compare/v0.1.4...v0.1.5) (2018-01-01)
-
-## [0.1.4](https://github.com/chenasraf/simple-scaffold/compare/v0.1.3...v0.1.4) (2018-01-01)
-
-## [0.1.3](https://github.com/chenasraf/simple-scaffold/compare/v0.1.2...v0.1.3) (2018-01-01)
-
-## 0.1.2 (2018-01-01)

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017 Chen Asraf
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/examples/test-input/Component/inner/inner-{{name}}.txt

@@ -1 +0,0 @@
-{{name}}

package/examples/test-input/Component/{{Name}}.tsx

@@ -1,17 +0,0 @@
-import * as React from "react"
-import * as css from "./{{Name}}.css"
-
-class {{Name}} extends React.Component<any> {
-  private {{ property }}
-
-  constructor(props: any) {
-    super(props)
-    this.{{ property }} = {{ value }}
-  }
-
-  public render() {
-    return <div className={ css.{{Name}} } />
-  }
-}
-
-export default {{Name}}

package/examples/test-input/scaffold.config.js

@@ -1,13 +0,0 @@
-/** @type {import('simple-scaffold').ScaffoldConfigFile} */
-module.exports = {
-  default: {
-    templates: ["examples/test-input/Component"],
-    output: "examples/test-output",
-    data: { property: "myProp", value: "10" },
-  },
-  component: {
-    templates: ["examples/test-input/Component"],
-    output: "examples/test-output",
-    data: { property: "myProp", value: "10" },
-  },
-}

package/jest.config.ts

@@ -1,205 +0,0 @@
-/*
- * For a detailed explanation regarding each configuration property and type check, visit:
- * https://jestjs.io/docs/configuration
- */
-
-export default {
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
-
-  // Stop running tests after `n` failures
-  // bail: 0,
-
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/private/var/folders/q9/0mns8fgd00b4t5j5lq2wh2yh0000gn/T/jest_dx",
-
-  // Automatically clear mock calls, instances, contexts and results before every test
-  clearMocks: true,
-
-  // Indicates whether the coverage information should be collected while executing the test
-  collectCoverage: true,
-
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: undefined,
-
-  // The directory where Jest should output its coverage files
-  coverageDirectory: "coverage",
-
-  // An array of regexp pattern strings used to skip coverage collection
-  // coveragePathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: "v8",
-
-  // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
-  //   "json",
-  //   "text",
-  //   "lcov",
-  //   "clover"
-  // ],
-
-  // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
-
-  // A path to a custom dependency extractor
-  // dependencyExtractor: undefined,
-
-  // Make calling deprecated APIs throw helpful error messages
-  // errorOnDeprecated: false,
-
-  // The default configuration for fake timers
-  // fakeTimers: {
-  //   "enableGlobally": false
-  // },
-
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
-
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
-
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
-
-  // A set of global variables that need to be available in all test environments
-  // globals: {},
-
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
-
-  // An array of directory names to be searched recursively up from the requiring module's location
-  // moduleDirectories: [
-  //   "node_modules"
-  // ],
-
-  // An array of file extensions your modules use
-  // moduleFileExtensions: [
-  //   "js",
-  //   "mjs",
-  //   "cjs",
-  //   "jsx",
-  //   "ts",
-  //   "tsx",
-  //   "json",
-  //   "node"
-  // ],
-
-  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
-  // moduleNameMapper: {
-  //   chalk: "<rootDir>/node_modules/chalk/source/index.js",
-  //   "#ansi-styles": "<rootDir>/node_modules/chalk/source/vendor/ansi-styles/index.js",
-  //   "#supports-color": "<rootDir>/node_modules/chalk/source/vendor/supports-color/index.js",
-  // },
-
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  modulePathIgnorePatterns: ["<rootDir>/dist"],
-
-  // Activates notifications for test results
-  // notify: false,
-
-  // An enum that specifies notification mode. Requires { notify: true }
-  // notifyMode: "failure-change",
-
-  // A preset that is used as a base for Jest's configuration
-  preset: "ts-jest",
-
-  // Run tests from one or more projects
-  // projects: undefined,
-
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
-
-  // Automatically reset mock state before every test
-  // resetMocks: false,
-
-  // Reset the module registry before running each individual test
-  // resetModules: false,
-
-  // A path to a custom resolver
-  // resolver: undefined,
-
-  // Automatically restore mock state and implementation before every test
-  // restoreMocks: false,
-
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: undefined,
-
-  // A list of paths to directories that Jest should use to search for files in
-  // roots: [
-  //   "<rootDir>"
-  // ],
-
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
-
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  // setupFiles: [],
-
-  // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  // setupFilesAfterEnv: [],
-
-  // The number of seconds after which a test is considered as slow and reported as such in the results.
-  // slowTestThreshold: 5,
-
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
-
-  // The test environment that will be used for testing
-  // testEnvironment: "jest-environment-node",
-
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
-
-  // Adds a location field to test results
-  // testLocationInResults: false,
-
-  // The glob patterns Jest uses to detect test files
-  // testMatch: [
-  //   "**/__tests__/**/*.[jt]s?(x)",
-  //   "**/?(*.)+(spec|test).[tj]s?(x)"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
-
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: undefined,
-
-  // This option allows use of a custom test runner
-  // testRunner: "jest-circus/runner",
-
-  // A map from regular expressions to paths to transformers
-  // transform: undefined,
-
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   "/node_modules/",
-  //   "\\.pnp\\.[^\\/]+$"
-  // ],
-
-  // transform: {
-  //   "^.+\\.ts?$": "ts-jest",
-  // },
-  // transformIgnorePatterns: ["<rootDir>/node_modules/"],
-
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
-
-  // Indicates whether each individual test should be reported during the run
-  // verbose: undefined,
-
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
-
-  // Whether to use watchman for file crawling
-  // watchman: true,
-}

package/pages/README.md

@@ -1,7 +0,0 @@
-See full documentation [here](https://chenasraf.github.io/simple-scaffold).
-
-- [Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/cli.html)
-- [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/node.html)
-- [Templates](https://chenasraf.github.io/simple-scaffold/pages/templates.html)
-- [Configuration Files](https://chenasraf.github.io/simple-scaffold/pages/configuration_files.html)
-- [Migrating v0.x to v1.x](https://chenasraf.github.io/simple-scaffold/pages/migration.html)

package/pages/cli.md

@@ -1,74 +0,0 @@
-## Available flags
-
-The following is the help text from the `simple-scaffold` binary. To see this and more information
-anytime, add the `-h` or `--help` flag to your call, e.g. `npx simple-scaffold@latest -h`.
-
-```text
-Usage: simple-scaffold [options]
-
-Create structured files based on templates.
-
-Options:
-
-  --help|-h                       Display help information
-
-  --name|-n                       Name to be passed to the generated files. {{name}} and
-                                  {{Name}} inside contents and file names will be replaced
-                                  accordingly.
-
-  --config|-c                     Filename to load config from instead of passing
-                                  arguments to CLI or using a Node.js script. You may pass a
-                                  JSON or JS file, with a relative or absolute path.
-
-  --output|-o                     Path to output to. If --create-sub-folder is enabled,
-                                  the subfolder will be created inside this path.
-                                  (default: current dir)
-
-  --templates|-t                  Template files to use as input. You may provide multiple
-                                  files, each of which can be a relative or absolute path, or a
-                                  glob pattern for multiple file matching easily.
-
-  --overwrite|-w                  Enable to override output files, even if they already
-                                  exist. (default: false)
-
-  --data|-d                       Add custom data to the templates. By default, only your
-                                  app name is included.
-
-  --append-data|-D                Append additional custom data to the templates, which
-                                  will overwrite --data, using an alternate syntax, which is
-                                  easier to use with CLI: -D key1=string -D key2:=raw
-
-  --create-sub-folder|-s          Create subfolder with the input name
-                                  (default: false)
-
-  --sub-folder-name-helper|-sh    Default helper to apply to subfolder name when using
-                                  `--create-sub-folder true`.
-
-  --quiet|-q                      Suppress output logs (Same as --verbose 0)
-                                  (default: false)
-
-  --verbose|-v                    Determine amount of logs to display. The values are:
-                                  0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4
-                                  (error). The provided level will display messages of
-                                  the same level or higher. (default:
-                                  2)
-
-  --dry-run|-dr                   Don't emit files. This is good for testing your
-                                  scaffolds and making sure they don't fail, without having to
-                                  write actual file contents or create directories.
-                                  (default: false)
-```
-
-> See
-> [Configuration Files](https://chenasraf.githun.io/simple-scaffold/pages/docs/configuration_files.md)
-> for organizing multiple scaffold types into easy-to-maintain files
-
-You can also add this as a script in your `package.json`:
-
-```json
-{
-  "scripts": {
-    "scaffold": "npx simple-scaffold@latest -t scaffolds/component/**/* -o src/components -d '{\"myProp\": \"propName\", \"myVal\": 123}'"
-  }
-}
-```

package/pages/configuration_files.md

@@ -1,86 +0,0 @@
-If you want to have reusable configurations which are complex and don't fit into command lines
-easily, or just want to manage your templates easier, you can use configuration files to load your
-scaffolding configurations.
-
-## Creating config files
-
-Configuration files should be valid `.js`/`.json` files that contain valid Scaffold configurations.
-
-Each file hold multiple scaffolds. Each scaffold is a key, and its value is the configuration. For
-example:
-
-```json
-{
-  "component": {
-    "templates": ["templates/component"],
-    "output": "src/components"
-  }
-}
-```
-
-The configuration contents are identical to the
-[Node.js configuration structure](https://chenasraf.github.io/simple-scaffold/pages/node.md):
-
-```ts
-interface ScaffoldConfig {
-  name: string
-  templates: string[]
-  output: FileResponse<string>
-  createSubFolder?: boolean
-  data?: Record<string, any>
-  overwrite?: FileResponse<boolean>
-  quiet?: boolean
-  verbose?: LogLevel
-  dryRun?: boolean
-  helpers?: Record<string, Helper>
-  subFolderNameHelper?: DefaultHelpers | string
-  beforeWrite?(
-    content: Buffer,
-    rawContent: Buffer,
-    outputPath: string,
-  ): string | Buffer | undefined | Promise<string | Buffer | undefined>
-}
-```
-
-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:
-
-```js
-/** @type {import('simple-scaffold').ScaffoldConfigFile} */
-module.exports = {
-  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`
-for brevity), followed by a colon, then your scaffold config name. For example:
-
-```shell
-simple-scaffold -c scaffold.json:component MyComponentName
-```
-
-If you don't want to supply a template/config name (e.g. `component`), you can omit the colon and
-the name, and it will use the configuration named `default`:
-
-```js
-/** @type {import('simple-scaffold').ScaffoldConfigFile} */
-module.exports = {
-  default: {
-    // ...
-  },
-}
-```
-
-And then:
-
-```shell
-# will use 'default' template
-simple-scaffold -c scaffold.json MyComponentName
-```

package/pages/migration.md

@@ -1,25 +0,0 @@
-In Simple Scaffold v1.0, the entire codebase was overhauled, yet usage remains mostly the same
-between versions. With these notable exceptions:
-
-- Some of the argument names have changed
-- Template syntax has been improved
-- The command to run Scaffold has been simplified from `new SimpleScaffold(opts).run()` to
-  `SimpleScaffold(opts)`, which now returns a promise that you can await to know when the process
-  has been completed.
-
-## Argument changes
-
-- `locals` has been renamed to `data`. The appropriate command line args have been updated as well
-  to `--data` | `-d`.
-- Additional options have been added to both CLI and Node interfaces. See
-  [Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/cli.html)
-  and [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/node.html) for more
-  information.
-
-## Template syntax changes
-
-Simple Scaffold still uses Handlebars.js to handle template content and file names. However, helpers
-have been added to remove the need for you to pre-process the template data on simple use-cases such
-as case type manipulation (converting to camel case, snake case, etc)
-
-See the readme for the full information on how to use these helpers and which are available.