simple-scaffold 1.3.1 → 1.4.0

package/pages/node.md

@@ -1,53 +0,0 @@
-You can build the scaffold yourself, if you want to create more complex arguments, scaffold groups,
-etc - simply pass a config object to the Scaffold function when you are ready to start.
-
-The config takes similar arguments to the command line. The full type definitions can be found in
-[src/types.ts](https://github.com/chenasraf/simple-scaffold/blob/develop/src/types.ts#L13).
-
-See the full
-[documentation](https://chenasraf.github.io/simple-scaffold/interfaces/ScaffoldConfig.html) for the
-configuration options and their behavior.
-
-```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>
-}
-```
-
-This is an example of loading a complete scaffold via Node.js:
-
-```typescript
-import Scaffold from "simple-scaffold"
-
-const config = {
-  name: "component",
-  templates: [path.join(__dirname, "scaffolds", "component")],
-  output: path.join(__dirname, "src", "components"),
-  createSubFolder: true,
-  subFolderNameHelper: "upperCase"
-  data: {
-    property: "value",
-  },
-  helpers: {
-    twice: (text) => [text, text].join(" ")
-  },
-  beforeWrite: (content, rawContent, outputPath) => content.toString().toUpperCase()
-}
-
-const scaffold = Scaffold(config)
-```

package/pages/templates.md

@@ -1,224 +0,0 @@
-# Preparing template files
-
-Put your template files anywhere, and fill them with tokens for replacement.
-
-Each template (not file) in the config array is parsed individually, and copied to the output
-directory. If a single template path contains multiple files (e.g. if you use a folder path or a
-glob pattern), the first directory up the tree of that template will become the base inside the
-defined output path for that template, while copying files recursively and maintaining their
-relative structure.
-
-Examples:
-
-> In the following examples, the config `name` is `AppName`, and the config `output` is `src`.
-
-| Input template                | Files in template                                      | Output path(s)                                               |
-| ----------------------------- | ------------------------------------------------------ | ------------------------------------------------------------ |
-| `./templates/{{ name }}.txt`  | `./templates/{{ name }}.txt`                           | `src/AppName.txt`                                            |
-| `./templates/directory`       | `outer/{{name}}.txt`,<br />`outer2/inner/{{name}}.txt` | `src/outer/AppName.txt`,<br />`src/outer2/inner/AppName.txt` |
-| `./templates/others/**/*.txt` | `outer/{{name}}.jpg`,<br />`outer2/inner/{{name}}.txt` | `src/outer2/inner/AppName.txt`                               |
-
-## Variable/token replacement
-
-Scaffolding will replace `{{ varName }}` in both the file name and its contents and put the
-transformed files in the output directory.
-
-The data available for the template parser is the data you pass to the `data` config option (or
-`--data` argument in CLI).
-
-For example, using the following command:
-
-```bash
-npx simple-scaffold@latest \
-  --templates templates/components/{{name}}.jsx \
-  --output src/components \
-  --create-sub-folder true \
-  MyComponent
-```
-
-Will output a file with the path:
-
-```text
-<working_dir>/src/components/MyComponent.jsx
-```
-
-The contents of the file will be transformed in a similar fashion.
-
-Your `data` will be pre-populated with the following:
-
-- `{{Name}}`: PascalCase of the component name
-- `{{name}}`: raw name of the component as you entered it
-
-> Simple-Scaffold uses [Handlebars.js](https://handlebarsjs.com/) for outputting the file contents.
-> Any `data` you add in the config will be available for use with their names wrapped in `{{` and
-> `}}`. Other Handlebars built-ins such as `each`, `if` and `with` are also supported, see
-> [Handlebars.js Language Features](https://handlebarsjs.com/guide/#language-features) for more
-> information.
-
-## Helpers
-
-### Built-in Helpers
-
-Simple-Scaffold provides some built-in text transformation filters usable by Handlebars.
-
-For example, you may use `{{ snakeCase name }}` inside a template file or filename, and it will
-replace `My Name` with `my_name` when producing the final value.
-
-#### Capitalization Helpers
-
-| Helper name  | Example code            | Example output |
-| ------------ | ----------------------- | -------------- |
-| [None]       | `{{ name }}`            | my name        |
-| `camelCase`  | `{{ camelCase name }}`  | myName         |
-| `snakeCase`  | `{{ snakeCase name }}`  | my_name        |
-| `startCase`  | `{{ startCase name }}`  | My Name        |
-| `kebabCase`  | `{{ kebabCase name }}`  | my-name        |
-| `hyphenCase` | `{{ hyphenCase name }}` | my-name        |
-| `pascalCase` | `{{ pascalCase name }}` | MyName         |
-| `upperCase`  | `{{ upperCase name }}`  | MY NAME        |
-| `lowerCase`  | `{{ lowerCase name }}`  | my name        |
-
-#### Date helpers
-
-| Helper name                      | Description                                                      | Example code                                                     | Example output     |
-| -------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------ |
-| `now`                            | Current date with format                                         | `{{ now "yyyy-MM-dd HH:mm" }}`                                   | `2042-01-01 15:00` |
-| `now` (with offset)              | Current date with format, and with offset                        | `{{ now "yyyy-MM-dd HH:mm" -1 "hours" }}`                        | `2042-01-01 14:00` |
-| `date`                           | Custom date with format                                          | `{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" }}`           | `2042-01-01 15:00` |
-| `date` (with offset)             | Custom date with format, and with offset                         | `{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" -1 "days" }}` | `2041-31-12 15:00` |
-| `date` (with date from `--data`) | Custom date with format, with data from the `data` config option | `{{ date myCustomDate "yyyy-MM-dd HH:mm" }}`                     | `2042-01-01 12:00` |
-
-Further details:
-
-- We use [`date-fns`](https://date-fns.org/docs/) for parsing/manipulating the dates. If you want
-  more information on the date tokens to use, refer to
-  [their format documentation](https://date-fns.org/docs/format).
-
-- The date helper format takes the following arguments:
-
-  ```typescript
-  (
-    date: string,
-    format: string,
-    offsetAmount?: number,
-    offsetType?: "years" | "months" | "weeks" | "days" | "hours" | "minutes" | "seconds"
-  )
-  ```
-
-- **The now helper** (for current time) takes the same arguments, minus the first one (`date`) as it
-  is implicitly the current date.
-
-### Custom Helpers
-
-You may also add your own custom helpers using the `helpers` options when using the JS API (rather
-than the CLI). The `helpers` option takes an object whose keys are helper names, and values are the
-transformation functions. For example, `upperCase` is implemented like so:
-
-```typescript
-config.helpers = {
-  upperCase: (text) => text.toUpperCase(),
-}
-```
-
-All of the above helpers (built in and custom) will also be available to you when using
-`subFolderNameHelper` (`--sub-folder-name-helper`/`-sh`) as a possible value.
-
-> To see more information on how helpers work and more features, see
-> [Handlebars.js docs](https://handlebarsjs.com/guide/#custom-helpers).
-
-# Examples
-
-## Run
-
-### Command Example
-
-```bash
-simple-scaffold MyComponent \
-    -t project/scaffold/**/* \
-    -o src/components \
-    -d '{"className": "myClassName","author": "Chen Asraf"}'
-    MyComponent
-```
-
-### Equivalent Node Module Example
-
-```typescript
-import Scaffold from "simple-scaffold"
-
-async function main() {
-  await Scaffold({
-    name: "MyComponent",
-    templates: ["project/scaffold/**/*"],
-    output: ["src/components"],
-    data: {
-      className: "myClassName",
-      author: "Chen Asraf",
-    },
-  })
-  console.log("Done.")
-}
-```
-
-## Files
-
-### Input
-
-- Input file path:
-
-  ```text
-  project → scaffold → {{Name}}.js → src → components
-  ```
-
-- Input file contents:
-
-  ```typescript
-  /**
-   * Author: {{ author }}
-   * Date: {{ now "yyyy-MM-dd" }}
-   */
-  import React from 'react'
-
-  export default {{camelCase name}}: React.FC = (props) => {
-    return (
-      <div className="{{className}}">{{camelCase name}} Component</div>
-    )
-  }
-  ```
-
-### Output
-
-- Output file path:
-
-  - With `createSubFolder = false` (default):
-
-    ```text
-    project → src → components → MyComponent.js
-    ```
-
-  - With `createSubFolder = true`:
-
-    ```text
-    project → src → components → MyComponent → MyComponent.js
-    ```
-
-  - With `createSubFolder = true` and `subFolderNameHelper = 'upperCase'`:
-
-    ```text
-    project → src → components → MYCOMPONENT → MyComponent.js
-    ```
-
-- Output file contents:
-
-  ```typescript
-  /**
-   * Author: Chen Asraf
-   * Date: 2077-01-01
-   */
-  import React from 'react'
-
-  export default MyComponent: React.FC = (props) => {
-    return (
-      <div className="myClassName">MyComponent Component</div>
-    )
-  }
-  ```

package/release.config.js

@@ -1,76 +0,0 @@
-const releaseRules = [
-  { type: "feat", section: "Features", release: "minor" },
-  { type: "docs", section: "Misc", release: "patch" },
-  { type: "fix", section: "Bug Fixes", release: "patch" },
-  { type: "refactor", section: "Misc", release: "patch" },
-  { type: "docs", section: "Build", release: "patch" },
-  { type: "perf", section: "Misc", release: "patch" },
-  { type: "build", section: "Build", release: "patch" },
-  { type: "chore", section: "Misc", release: "patch" },
-  { type: "test", section: "Misc", release: "patch" },
-]
-
-/** @type {import('semantic-release').Options} */
-module.exports = {
-  branches: [
-    "+([0-9])?(.{+([0-9]),x}).x",
-    "master",
-    "next",
-    "next-major",
-    { name: "beta", prerelease: true },
-    { name: "alpha", prerelease: true },
-  ],
-  analyzeCommits: {
-    path: "semantic-release-conventional-commits",
-    majorTypes: ["major", "breaking"],
-    minorTypes: ["minor", "feat", "feature"],
-    patchTypes: ["patch", "fix", "bugfix", "refactor", "perf", "revert"],
-  },
-  plugins: [
-    [
-      "@semantic-release/commit-analyzer",
-      {
-        preset: "conventionalcommits",
-        parserOpts: {
-          noteKeywords: ["breaking:", "breaking-fix:", "breaking-feat:"],
-        },
-        releaseRules: releaseRules,
-      },
-    ],
-    [
-      "@semantic-release/release-notes-generator",
-      {
-        preset: "conventionalcommits",
-        parserOpts: {
-          noteKeywords: ["breaking"],
-          types: releaseRules,
-        },
-      },
-    ],
-    [
-      "@semantic-release/changelog",
-      {
-        changelogFile: "CHANGELOG.md",
-        changelogTitle: "# Change Log",
-      },
-    ],
-    [
-      "@semantic-release/npm",
-      {
-        packageRoot: "dist",
-      },
-    ],
-    [
-      "@semantic-release/github",
-      {
-        assets: ["package.tgz"],
-      },
-    ],
-    [
-      "@semantic-release/git",
-      {
-        assets: ["CHANGELOG.md", "package.json"],
-      },
-    ],
-  ],
-}

package/src/cmd.ts

@@ -1,130 +0,0 @@
-#!/usr/bin/env node
-import massarg from "massarg"
-import chalk from "chalk"
-import { LogLevel, ScaffoldCmdConfig } from "./types"
-import { Scaffold } from "./scaffold"
-import path from "path"
-import fs from "fs/promises"
-import { parseAppendData, parseConfig } from "./utils"
-
-export async function parseCliArgs(args = process.argv.slice(2)) {
-  const pkg = JSON.parse((await fs.readFile(path.join(__dirname, "package.json"))).toString())
-  const isConfig = args.includes("--config") || args.includes("-c")
-
-  return (
-    massarg<ScaffoldCmdConfig>()
-      .main((config) => {
-        const _config = parseConfig(config)
-        return Scaffold(_config)
-      })
-      .option({
-        name: "name",
-        aliases: ["n"],
-        description:
-          "Name to be passed to the generated files. {{name}} and {{Name}} inside contents and file names will be replaced accordingly.",
-        isDefault: true,
-        required: true,
-      })
-      .option({
-        name: "config",
-        aliases: ["c"],
-        description:
-          "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.",
-      })
-      .option({
-        name: "output",
-        aliases: ["o"],
-        description: `Path to output to. If --create-sub-folder is enabled, the subfolder will be created inside this path. ${chalk.reset`${chalk.white`(default: current dir)`}`}`,
-        required: !isConfig,
-      })
-      .option({
-        name: "templates",
-        aliases: ["t"],
-        array: true,
-        description:
-          "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.",
-        required: !isConfig,
-      })
-      .option({
-        name: "overwrite",
-        aliases: ["w"],
-        boolean: true,
-        defaultValue: false,
-        description: "Enable to override output files, even if they already exist.",
-      })
-      .option({
-        name: "data",
-        aliases: ["d"],
-        description: "Add custom data to the templates. By default, only your app name is included.",
-        parse: (v) => JSON.parse(v),
-      })
-      .option({
-        name: "append-data",
-        aliases: ["D"],
-        description:
-          "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",
-        parse: parseAppendData,
-      })
-      .option({
-        name: "create-sub-folder",
-        aliases: ["s"],
-        boolean: true,
-        defaultValue: false,
-        description: "Create subfolder with the input name",
-      })
-      .option({
-        name: "sub-folder-name-helper",
-        aliases: ["sh"],
-        description: "Default helper to apply to subfolder name when using `--create-sub-folder true`.",
-      })
-      .option({
-        name: "quiet",
-        aliases: ["q"],
-        boolean: true,
-        defaultValue: false,
-        description: "Suppress output logs (Same as --verbose 0)",
-      })
-      .option({
-        name: "verbose",
-        aliases: ["v"],
-        defaultValue: LogLevel.Info,
-        description:
-          "Determine amount of logs to display. The values are: " +
-          `${chalk.bold`0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error)`}. ` +
-          "The provided level will display messages of the same level or higher.",
-        parse: Number,
-      })
-      .option({
-        name: "dry-run",
-        aliases: ["dr"],
-        boolean: true,
-        defaultValue: false,
-        description:
-          "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.",
-      })
-      // .example({
-      //   input: `yarn cmd -t examples/test-input/Component -o examples/test-output -d '{"property":"myProp","value":"10"}'`,
-      //   description: "Usage",
-      //   output: "",
-      // })
-      .help({
-        binName: "simple-scaffold",
-        useGlobalColumns: true,
-        usageExample: "[options]",
-        header: [`Create structured files based on templates.`].join("\n"),
-        footer: [
-          `Version:  ${pkg.version}`,
-          `Copyright © Chen Asraf 2017-${new Date().getFullYear()}`,
-          ``,
-          `Documentation: ${chalk.underline`https://casraf.dev/simple-scaffold`}`,
-          `NPM: ${chalk.underline`https://npmjs.com/package/simple-scaffold`}`,
-          `GitHub: ${chalk.underline`https://github.com/chenasraf/simple-scaffold`}`,
-        ].join("\n"),
-      })
-      .parse(args)
-  )
-}
-
-parseCliArgs()

package/src/docs.css

@@ -1,55 +0,0 @@
-.tsd-typography table {
-  border-collapse: collapse;
-  width: 100%;
-}
-
-.tsd-typography table td,
-.tsd-typography table th {
-  vertical-align: top;
-  border: 1px solid var(--color-accent);
-  padding: 6px;
-}
-.tsd-typography h1 + pre,
-.tsd-typography h2 + pre,
-.tsd-typography h3 + pre,
-.tsd-typography h4 + pre,
-.tsd-typography h5 + pre,
-.tsd-typography h6 + pre,
-/*  */
-.tsd-typography h1 + table,
-.tsd-typography h2 + table,
-.tsd-typography h3 + table,
-.tsd-typography h4 + table,
-.tsd-typography h5 + table,
-.tsd-typography h6 + table {
-  margin-top: 1em;
-}
-
-.tsd-typography pre + a + h1,
-.tsd-typography pre + a + h2,
-.tsd-typography pre + a + h3,
-.tsd-typography pre + a + h4,
-.tsd-typography pre + a + h5,
-.tsd-typography pre + a + h6,
-/*  */
-.tsd-typography table + a + h1,
-.tsd-typography table + a + h2,
-.tsd-typography table + a + h3,
-.tsd-typography table + a + h4,
-.tsd-typography table + a + h5,
-.tsd-typography table + a + h6 {
-  margin-top: 2em;
-}
-
-.tsd-index-accordion[data-key*="Configuration."] ul.tsd-nested-navigation,
-.tsd-index-accordion[data-key*="Configuration."] .tsd-accordion-summary > svg,
-.tsd-index-accordion[data-key="Changelog"] ul.tsd-nested-navigation,
-.tsd-index-accordion[data-key="Changelog"] .tsd-accordion-summary > svg,
-.tsd-index-accordion[data-key="Configuration"] li:nth-child(n + 6) {
-  display: none;
-}
-
-.tsd-index-accordion[data-key*="Configuration."],
-.tsd-index-accordion[data-key="Changelog"] {
-  margin-left: 0;
-}

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from "./scaffold"
-export * from "./types"
-import Scaffold from "./scaffold"
-export default Scaffold

package/src/scaffold.ts

@@ -1,140 +0,0 @@
-/**
- * @module
- * Simple Scaffold
- *
- * See [readme](README.md)
- */
-import path from "path"
-
-import {
-  createDirIfNotExists,
-  getOptionValueForFile,
-  handleErr,
-  log,
-  pascalCase,
-  isDir,
-  removeGlob,
-  makeRelativePath,
-  registerHelpers,
-  getTemplateGlobInfo,
-  getFileList,
-  getBasePath,
-  copyFileTransformed,
-  getTemplateFileInfo,
-  logInitStep,
-  logInputFile,
-} from "./utils"
-import { LogLevel, ScaffoldConfig } from "./types"
-
-/**
- * Create a scaffold using given `options`.
- *
- * #### Create files
- * To create a file structure to output, use any directory and file structure you would like.
- * Inside folder names, file names or file contents, you may place `{{ var }}` where `var` is either
- * `name` which is the scaffold name you provided or one of the keys you provided in the `data` option.
- *
- * The contents and names will be replaced with the transformed values so you can use your original structure as a
- * boilerplate for other projects, components, modules, or even single files.
- *
- * The files will maintain their structure, starting from the directory containing the template (or the template itself
- * if it is already a directory), and will output from that directory into the directory defined by `config.output`.
- *
- * #### Helpers
- * Helpers are functions you can use to transform your `{{ var }}` contents into other values without having to
- * pre-define the data and use a duplicated key.
- *
- * Any functions you provide in `helpers` option will also be available to you to make custom formatting as you see fit
- * (for example, formatting a date)
- *
- * For available default values, see {@link DefaultHelpers}.
- *
- * @param {ScaffoldConfig} config The main configuration object
- *
- * @see {@link DefaultHelpers}
- * @see {@link CaseHelpers}
- * @see {@link DateHelpers}
- *
- * @category Main
- */
-export async function Scaffold(config: ScaffoldConfig): Promise<void> {
-  config.output ??= process.cwd()
-
-  registerHelpers(config)
-  try {
-    config.data = { name: config.name, Name: pascalCase(config.name), ...config.data }
-    logInitStep(config)
-    for (let _template of config.templates) {
-      try {
-        const { nonGlobTemplate, origTemplate, isDirOrGlob, isGlob, template } = await getTemplateGlobInfo(
-          config,
-          _template,
-        )
-        const files = await getFileList(config, template)
-        for (const inputFilePath of files) {
-          if (await isDir(inputFilePath)) {
-            continue
-          }
-          const relPath = makeRelativePath(path.dirname(removeGlob(inputFilePath).replace(nonGlobTemplate, "")))
-          const basePath = getBasePath(relPath)
-          logInputFile(config, {
-            origTemplate,
-            relPath,
-            template,
-            inputFilePath,
-            nonGlobTemplate,
-            basePath,
-            isDirOrGlob,
-            isGlob,
-          })
-          await handleTemplateFile(config, {
-            templatePath: inputFilePath,
-            basePath,
-          })
-        }
-      } catch (e: any) {
-        handleErr(e)
-      }
-    }
-  } catch (e: any) {
-    log(config, LogLevel.Error, e)
-    throw e
-  }
-}
-async function handleTemplateFile(
-  config: ScaffoldConfig,
-  { templatePath, basePath }: { templatePath: string; basePath: string },
-): Promise<void> {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const { inputPath, outputPathOpt, outputDir, outputPath, exists } = await getTemplateFileInfo(config, {
-        templatePath,
-        basePath,
-      })
-      const overwrite = getOptionValueForFile(config, inputPath, config.overwrite ?? false)
-
-      log(
-        config,
-        LogLevel.Debug,
-        `\nParsing ${templatePath}`,
-        `\nBase path: ${basePath}`,
-        `\nFull input path: ${inputPath}`,
-        `\nOutput Path Opt: ${outputPathOpt}`,
-        `\nFull output dir: ${outputDir}`,
-        `\nFull output path: ${outputPath}`,
-        `\n`,
-      )
-
-      await createDirIfNotExists(path.dirname(outputPath), config)
-
-      log(config, LogLevel.Info, `Writing to ${outputPath}`)
-      await copyFileTransformed(config, { exists, overwrite, outputPath, inputPath })
-      resolve()
-    } catch (e: any) {
-      handleErr(e)
-      reject(e)
-    }
-  })
-}
-
-export default Scaffold