@react-foundry/plop-pack 0.1.0

package/skel/component/src/Component.tsx.hbs

@@ -0,0 +1,32 @@
+import { FC, createElement as h } from 'react';
+import { StandardProps, classBuilder } from '@react-foundry/component-helpers';
+
+import '../assets/{{{properCase name}}}.scss';
+
+export type {{{properCase name}}}Props = StandardProps & {
+  /** Description for the 'heading' prop */
+  heading?: string
+};
+
+export const {{{properCase name}}}: FC<{{{properCase name}}}Props> = ({
+  children,
+  classBlock,
+  classModifiers,
+  className,
+  heading,
+  ...attrs
+}) => {
+  const classes = classBuilder('{{{dashCase (pkg 'name')}}}-{{{dashCase name}}}', classBlock, classModifiers, className);
+  const title = heading || '{{{name}}}';
+
+  return (
+    <div {...attrs} className={classes()}>
+      <h1 className={classes('heading')}>{title}</h1>
+      {children}
+    </div>
+  );
+};
+
+{{{properCase name}}}.displayName = '{{{properCase name}}}';
+
+export default {{{properCase name}}};

package/skel/component/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "dist",
+    "node_modules"
+  ]
+}

package/skel/lib/README.md.hbs

@@ -0,0 +1,51 @@
+{{#mdTitle}}{{{titleCase (pkg 'name')}}} - {{{titleCase name}}}{{/mdTitle}}
+
+{{{description}}}
+
+
+Using this package
+------------------
+
+First install the package into your project:
+
+```shell
+npm install -S @{{{pkg 'name'}}}/{{{name}}}
+```
+
+Then use it in your code as follows:
+
+```js
+import {{{camelCase name}}} from '@{{{pkg 'name'}}}/{{{name}}}';
+
+// WRITEME
+
+```
+
+
+Working on this package
+-----------------------
+
+Before working on this package you must install its dependencies using
+the following command:
+
+```shell
+pnpm install
+```
+
+
+### Building
+
+Build the package by compiling the source code.
+
+```shell
+npm run build
+```
+
+
+### Clean-up
+
+Remove any previously built files.
+
+```shell
+npm run clean
+```

package/skel/lib/gitignore

@@ -0,0 +1,5 @@
+dist/
+node_modules/
+package-lock.json
+pnpm-lock.yaml
+tsconfig.tsbuildinfo

package/skel/lib/jest.config.js.hbs

@@ -0,0 +1,15 @@
+'use strict';
+
+const baseConfig = require('../../jest.config.base');
+
+const config = {
+  ...baseConfig,
+  collectCoverageFrom: [
+    '<rootDir>/src/**.{ts,tsx}',
+  ],
+  testMatch: [
+    '<rootDir>/spec/**.{ts,tsx}'
+  ]
+};
+
+module.exports = config;

package/skel/lib/package.json.hbs

@@ -0,0 +1,44 @@
+{
+  "name": "@{{{pkg 'name'}}}/{{{name}}}",
+  "version": "{{{pkg 'version'}}}",
+  "description": "{{{description}}}",
+  "main": "src/index.ts",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "publishConfig": {
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "typings": "dist/index.d.ts",
+    "exports": {
+      ".": {
+        "default": "./dist/index.mjs",
+        "import": "./dist/index.mjs",
+        "require": "./dist/index.js",
+        "types": "./dist/index.d.ts"
+      }
+    }
+  },
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "prepublishOnly": "npm run clean && npm run build",
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -m es2022 && find dist -name '*.js' -exec sh -c 'mv \"$0\" \"${0%.js}.mjs\"' {} \\;",
+    "build:cjs": "tsc",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo"
+  },
+  "author": "{{{pkg 'author'}}}",
+  "license": "{{{pkg 'license'}}}",
+  "engines": {
+    "node" : ">=22.0.0"
+  },
+  "devDependencies": {
+    "jest": "30.2.0",
+    "jest-environment-jsdom": "30.2.0",
+    "ts-jest": "29.4.6",
+    "typescript": "5.9.3"
+  }
+}

package/skel/lib/src/index.ts.hbs

@@ -0,0 +1,6 @@
+export type {{{properCase name}}}Options = {
+};
+
+export const {{{camelCase name}}} = (options: {{{properCase name}}}Options) => true;
+
+export default {{{camelCase name}}};

package/skel/lib/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.nodejs.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "dist",
+    "node_modules"
+  ]
+}

package/src/action-paths.js

@@ -0,0 +1,39 @@
+// Some of the code here is based on code from 'node-plop' which is
+// licensed under the MIT license and is copyright 2016 Andrew Worcester.
+
+import path from 'node:path';
+
+const normalisePath = filePath => (
+	!path.sep || path.sep === '\\'
+    ? filePath.replace(/\\/g, '/')
+    : filePath
+);
+
+export const actionPaths = (data, cfg, plop) => {
+  const destBasePath = plop.getDestBasePath();
+  const plopfilePath = plop.getPlopfilePath();
+  const fullData = { ...cfg.data, ...data };
+
+  const dest = filePath => {
+    const normalPath = normalisePath(filePath) || '';
+
+    return path.resolve(
+      destBasePath,
+      plop.renderString(normalPath, fullData)
+    );
+  };
+
+  const pretty = filePath => (
+    '/' + path.relative(destBasePath, filePath)
+  );
+
+  const source = filePath => path.resolve(plopfilePath, filePath);
+
+  return {
+    dest,
+    pretty,
+    source
+  };
+};
+
+export default actionPaths;

package/src/actions/copy.js

@@ -0,0 +1,27 @@
+import fs from 'fs-extra';
+import path from 'node:path';
+import actionPaths from '../action-paths.js';
+
+const plopActionCopy = (answers, config, plop) => {
+  const paths = actionPaths(answers, config, plop);
+  const dest = paths.dest(config.destination);
+  const source = paths.source(config.source);
+  const prettyDest = paths.pretty(dest);
+  const exclude = config.exclude || ['hbs'];
+
+  return (
+    fs.copy(source, dest, {
+      overwrite: config.overwrite || false,
+      errorOnExist: true,
+      dereference: true,
+      filter: config.filter || (
+        (src) => exclude
+          .map(v => !src.endsWith(`.${v}`))
+          .reduce((acc, cur) => cur && acc, true)
+      )
+    })
+      .then(() => `${prettyDest}`)
+  );
+};
+
+export default plopActionCopy;

package/src/actions/merge.js

@@ -0,0 +1,26 @@
+import _ from 'lodash';
+import fs from 'fs-extra';
+import actionPaths from '../action-paths.js';
+
+const plopActionMerge = (answers, config, plop) => new Promise(
+  (resolve, reject) => {
+    const paths = actionPaths(answers, config, plop);
+    const file = paths.dest(config.path);
+    const prettyFile = paths.pretty(file);
+    const templateFile = paths.source(config.templateFile);
+    const readOptions = { encoding: 'utf8' };
+    const original = fs.readJsonSync(file, readOptions);
+    const update = JSON.parse(
+      plop.renderString(
+        fs.readFileSync(templateFile, readOptions),
+        { ...config.data, ...answers }
+      )
+    );
+    const data = _.merge({}, original, update);
+
+    fs.writeJsonSync(file, data, { spaces: 2 });
+    resolve(prettyFile);
+  }
+);
+
+export default plopActionMerge;

package/src/actions/message.js

@@ -0,0 +1,3 @@
+const plopActionMessage = (answers, config, plop) => plop.renderString(config.content, answers);
+
+export default plopActionMessage;

package/src/actions/shell.js

@@ -0,0 +1,21 @@
+import shell from 'shelljs';
+
+const exec = (command, options) => new Promise(
+  (resolve, reject) => {
+    const r = shell.exec(command, { ...options, async: false });
+
+    return (
+      r.code === 0
+        ? resolve()
+        : reject(r.stderr)
+    );
+  }
+);
+
+const plopActionShell = (answers, config, plop) => {
+  const command = plop.renderString(config.command, answers);
+
+  return exec(command).then(() => command);
+};
+
+export default plopActionShell;

package/src/actions/symlink.js

@@ -0,0 +1,42 @@
+import path from 'node:path';
+import shell from 'shelljs';
+import actionPaths from '../action-paths.js';
+
+const symlinkOrCopy = (source, dest, topDir) => new Promise(
+  (resolve, reject) => {
+    const to = path.relative(path.dirname(dest), source);
+    const shouldCopy = to.includes('node_modules') || path.relative(topDir, source).includes('..');
+    const resultType = (
+      shouldCopy
+        ? 'file'
+        : 'symlink'
+    );
+    const r = (
+      shouldCopy
+        ? shell.cp('-rnL', source, dest)
+        : shell.ln('-s', to, dest)
+    );
+
+    return (
+      r.code === 0
+        ? resolve(resultType)
+        : reject(r.stderr)
+    );
+  }
+);
+
+const plopActionSymlink = (answers, config, plop) => {
+  const paths = actionPaths(answers, config, plop);
+  const dest = paths.dest(config.path);
+  const source = paths.source(config.target);
+  const prettyDest = paths.pretty(dest);
+  const prettySource = paths.pretty(source);
+
+  return symlinkOrCopy(source, dest, plop.getDestBasePath()).then(t => (
+    t === 'symlink'
+      ? `${prettyDest} -> ${prettySource}`
+      : prettyDest
+  ));
+};
+
+export default plopActionSymlink;

package/src/actions/write.js

@@ -0,0 +1,20 @@
+import fs from 'fs-extra';
+import actionPaths from '../action-paths.js';
+
+const plopActionWrite = (answers, config, plop) => {
+  const paths = actionPaths(answers, config, plop);
+  const file = paths.dest(config.path);
+  const prettyFile = paths.pretty(file);
+  const data = config.content(answers);
+  const writeFileSync = (
+    typeof data === 'string'
+      ? fs.writeFileSync
+      : fs.writeJsonSync
+  );
+
+  writeFileSync(file, data, { spaces: 2 });
+
+  return prettyFile;
+};
+
+export default plopActionWrite;

package/src/extend-generator.js

@@ -0,0 +1,38 @@
+import nodePlop from 'node-plop';
+import path from 'node:path';
+import resolve from 'resolve';
+
+export const extendGenerator = async (plop, plopfilePath, generator, extension, actionsSpliceStart, actionsSpliceDeleteCount = 0) => {
+	const parentPath = resolve.sync(plopfilePath, { basedir: plop.getPlopfilePath() });
+  const parent = await nodePlop(parentPath, { destBasePath: plop.getDestBasePath() });
+  const { name, description, prompts, actions: _actions, basePath, runActions, runPrompts, ...rest } = parent.getGenerator(generator);
+
+  const patchPath = v => v && path.resolve(basePath, v);
+  const patchAction = action => ({
+    ...action,
+    base: patchPath(action.base),
+    source: patchPath(action.source),
+    target: patchPath(action.target),
+    templateFile: patchPath(action.templateFile),
+    templateFiles: patchPath(action.templateFiles)
+  });
+
+  const actions = _actions.map(patchAction);
+
+  const start = (
+    actionsSpliceStart === undefined
+      ? _actions.length
+      : actionsSpliceStart
+  );
+  actions.splice(start, actionsSpliceDeleteCount, ...extension.actions);
+
+  return {
+    ...rest,
+    ...extension,
+    description: extension.description || description,
+    prompts: [ ...prompts, ...extension.prompts ],
+    actions
+  };
+};
+
+export default extendGenerator;

package/src/generators/app.js

@@ -0,0 +1,140 @@
+import relToSkel from '../rel-to-skel.js';
+
+const rel = relToSkel('app');
+
+export const generator = {
+  description: 'Application',
+  prompts: [
+    {
+      type: 'input',
+      name: 'name',
+      message: 'Name (e.g. "my-app"):'
+    },
+    {
+      type: 'input',
+      name: 'title',
+      message: 'Title (e.g. "My app"):'
+    },
+    {
+      type: 'input',
+      name: 'description',
+      message: 'Description:'
+    }
+  ],
+  actions: [
+    {
+      type: 'add',
+      path: 'apps/{{{name}}}/package.json',
+      templateFile: rel('package.json.hbs')
+    },
+    {
+      type: 'symlink',
+      path: 'apps/{{{name}}}/.dockerignore',
+      target: rel('.dockerignore')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/.gitignore',
+      source: rel('gitignore')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/aws-lambda-entry.js',
+      source: rel('aws-lambda-entry.js')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/cypress.config.mjs',
+      source: rel('cypress.config.mjs')
+    },
+    {
+      type: 'symlink',
+      path: 'apps/{{{name}}}/Dockerfile',
+      target: rel('Dockerfile')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/feat/',
+      source: rel('feat/')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/jest.config.cjs',
+      source: rel('jest.config.cjs')
+    },
+    {
+      type: 'symlink',
+      path: 'apps/{{{name}}}/lambda.Dockerfile',
+      target: rel('lambda.Dockerfile')
+    },
+    {
+      type: 'add',
+      path: 'apps/{{{name}}}/Makefile',
+      templateFile: rel('Makefile.hbs')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/plopfile.mjs',
+      source: rel('plopfile.mjs')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/public/',
+      source: rel('public/')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/react-router.config.ts',
+      source: rel('react-router.config.ts')
+    },
+    {
+      type: 'add',
+      path: 'apps/{{{name}}}/README.md',
+      templateFile: rel('README.md.hbs')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/src/',
+      source: rel('src/')
+    },
+    {
+      type: 'add',
+      path: 'apps/{{{name}}}/src/app/config.ts',
+      templateFile: rel('src/app/config.ts.hbs')
+    },
+    {
+      type: 'symlink',
+      path: 'apps/{{{name}}}/test.Dockerfile',
+      target: rel('test.Dockerfile')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/tsconfig.json',
+      source: rel('tsconfig.json')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/vite.config.server.ts',
+      source: rel('vite.config.server.ts')
+    },
+    {
+      type: 'copy',
+      destination: 'apps/{{{name}}}/vite.config.ts',
+      source: rel('vite.config.ts')
+    },
+    {
+      type: 'modify',
+      path: '.github/workflows/change-assurance.yml',
+      pattern: /app: \[(.+?)( ?)\]/g,
+      template: 'app: [$1, \'{{{name}}}\'$2]'
+    },
+    {
+      type: 'modify',
+      path: '.github/workflows/change-assurance.yml',
+      pattern: /app: \[\]/g,
+      template: 'app: [ \'{{{name}}}\' ]'
+    }
+  ]
+};
+
+export default generator;

package/src/generators/component.js

@@ -0,0 +1,73 @@
+import relToSkel from '../rel-to-skel.js';
+
+const rel = relToSkel('component');
+
+export const generator = {
+  description: 'Component',
+  prompts: [
+    {
+      type: 'input',
+      name: 'name',
+      message: 'Name (e.g. "My component"):'
+    },
+    {
+      type: 'input',
+      name: 'description',
+      message: 'Description:'
+    }
+  ],
+  actions: [
+    {
+      type: 'add',
+      path: 'components/{{{dashCase name}}}/jest.config.js',
+      templateFile: rel('jest.config.js.hbs')
+    },
+    {
+      type: 'add',
+      path: 'components/{{{dashCase name}}}/package.json',
+      templateFile: rel('package.json.hbs')
+    },
+    {
+      type: 'add',
+      path: 'components/{{{dashCase name}}}/README.md',
+      templateFile: rel('README.md.hbs')
+    },
+    {
+      type: 'copy',
+      destination: 'components/{{{dashCase name}}}/.gitignore',
+      source: rel('gitignore')
+    },
+    {
+      type: 'symlink',
+      path: 'components/{{{dashCase name}}}/tsconfig.json',
+      target: rel('tsconfig.json')
+    },
+    {
+      type: 'add',
+      path: 'components/{{{dashCase name}}}/assets/{{{properCase name}}}.scss',
+      templateFile: rel('assets/Component.scss.hbs')
+    },
+    {
+      type: 'add',
+      path: 'components/{{{dashCase name}}}/spec/{{{properCase name}}}.mdx',
+      templateFile: rel('spec/Component.mdx.hbs')
+    },
+    {
+      type: 'add',
+      path: 'components/{{{dashCase name}}}/spec/{{{properCase name}}}.stories.tsx',
+      templateFile: rel('spec/Component.stories.tsx.hbs')
+    },
+    {
+      type: 'add',
+      path: 'components/{{{dashCase name}}}/spec/{{{properCase name}}}.ts',
+      templateFile: rel('spec/Component.ts.hbs')
+    },
+    {
+      type: 'add',
+      path: 'components/{{{dashCase name}}}/src/{{{properCase name}}}.tsx',
+      templateFile: rel('src/Component.tsx.hbs')
+    }
+  ]
+};
+
+export default generator;

package/src/generators/lib.js

@@ -0,0 +1,54 @@
+import relToSkel from '../rel-to-skel.js';
+
+const rel = relToSkel('lib');
+
+export const generator = {
+  description: 'Library',
+  prompts: [
+    {
+      type: 'input',
+      name: 'name',
+      message: 'Name (e.g. "my-library"):'
+    },
+    {
+      type: 'input',
+      name: 'description',
+      message: 'Description:'
+    }
+  ],
+  actions: [
+    {
+      type: 'add',
+      path: 'lib/{{{name}}}/jest.config.js',
+      templateFile: rel('jest.config.js.hbs')
+    },
+    {
+      type: 'add',
+      path: 'lib/{{{name}}}/package.json',
+      templateFile: rel('package.json.hbs')
+    },
+    {
+      type: 'add',
+      path: 'lib/{{{name}}}/README.md',
+      templateFile: rel('README.md.hbs')
+    },
+    {
+      type: 'copy',
+      destination: 'lib/{{{name}}}/.gitignore',
+      source: rel('gitignore')
+    },
+    {
+      type: 'symlink',
+      path: 'lib/{{{name}}}/tsconfig.json',
+      target: rel('tsconfig.json')
+    },
+    {
+      type: 'addMany',
+      destination: 'lib/{{{name}}}/src/',
+      base: rel('src/'),
+      templateFiles: rel('src/**.hbs')
+    }
+  ]
+};
+
+export default generator;

package/src/helpers/eq.js

@@ -0,0 +1,3 @@
+const eq = (l, r) => l == r;
+
+export default eq;